Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
Official URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-MedicationAdministration | Version: 0.0.1 | |||
Draft as of 2024-07-15 | Computable Name: InterweaveMedicationAdministration |
Interweave MedicationAdministration resource profile - DRAFT.
Status: DRAFT: For Review
This profile sets minimum expectations for the Interweave madicationAdministration resource, to record event of a patient consuming or otherwise being administered a medication. We use the madicationAdministration structure definition as a base to this profile.
It will principally be used within care settings (including inpatient) to record the capture of medication administrations, including self-administrations of oral medications, injections, intra-venous adjustments, etc. It can also be used in outpatient settings to record allergy shots and other non-immunization administrations. In some cases, it might be used for home-health reporting, such as recording self-administered or even device-administered insulin. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
The following fields are mandatory:
status - Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
category – Indicates where the medication is expected to be consumed or administered. We also make this a required binding.
medication[x] - Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. When providing the referencing resource, the reference.display field should be populated with the name of the medication which will be a DM&D description.
subject – A reference to the patient who the request is for. To aid the data consumer, the display element should contain the patient’s name.
effective – An important field to provide details of the time/time period during which the medication was administered.
In addition, the following fields are "Must Support" - i.e. they must be populated if relevant and known:
identifier – a Local Id should be provided, such that could be quoted if manually getting in touch to find out more
context - This field is renamed to Encounter in R4. Here we limit the field to only allow references to an encounter resource. For a repeat prescriptions, this is the encounter where the repeat was authorised. For all others this is the encounter where the specific issue was authorised.
dosage - Details of how medication was taken, dosage information details e.g. dose (The amount of the medication given at one administration event.), rate (Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion), site, route, method (A coded value indicating the method by which the medication is intended to be or was introduced into or on the body(most commonly used for injections)) etc.
Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Optional fields to note include:
statusReason - A code indicating why the administration was not performed.
performer - Required to populate if known. The main purpose would be to provide details of a Practitioner who can give more information about the condition. Therefore it should not be populated with details of purely admin staff who may have keyed in the data. If the asserter is not populated then an unknown Practitioner should be assumed.
A further consideration is the possibility of a Condition being asserted by a non-care-professional, for example the Patient themselves or a relative. FHIR caters for this possibiity by allowing the asserter to be a Patient or RelatedPerson, and this option is left open here.
resonCode - A code indicating why the medication was given.
reasonReference – Option to provide more detailed information via Observation and/or a condition resource which represent the reason for the medication.
request - Link to the MedicationRequest that this MedicationAdministration is based on.
device - The device used in administering the medication to the patient. For example, a particular infusion pump.
note - Extra information about the medication administration that is not conveyed by the other attributes.
instantiates - Removed.
partOf – It is not the intention to create a complex grouping or hierarchy of medication information, a simple flat structure is informative and preferred. Therefore,this fields have been removed.
supportingInformation – Removed. This field allows reference to any type of resource which is very open and may cause confusion to the consumer. GPC also do not use this field
eventHistory – Removed. Not required for the shared care record.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCoreMedicationAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | UKCoreMedicationAdministration | Administration of medication to a patient | |
id | S | 0..1 | id | Logical id of this artifact |
meta | ||||
id | 0..0 | |||
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. |
profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. |
security | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers | |
Slices for tag | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
tag:Source | S | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | |
version | 0..0 | |||
code | S | 1..1 | code | The Data Provider Id of the system supplying the data |
display | S | 1..1 | string | Name of the system supplying the data |
tag:Provenance | S | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | |
version | 0..0 | |||
code | S | 1..1 | code | The ODS Code of the organisation responsible for the data |
display | S | 1..1 | string | Name of the organisation supplying the data |
implicitRules | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |
identifier | ||||
assigner | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | |
instantiates | 0..0 | |||
partOf | 0..0 | |||
category | S | 1..1 | CodeableConcept | Type of medication usage Binding: UK Core Medication Administration Category (required) |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
medication[x] | 1..1 | CodeableConcept, Reference(Medication) | Identifies the medication that was administered. Binding: UK Core Medication Code (required) | |
subject | 1..1 | Reference(InterweavePatient) | Identifies the patient receiving the medication. | |
reference | 1..1 | string | Reference to a resource (could be Contained) | |
type | 0..0 | |||
identifier | 0..1 | Identifier | If relevant could include an id | |
display | 1..1 | string | Description of the referenced resource | |
context | S | 0..1 | Reference(InterweaveEncounter) | Encounter administered as part of |
supportingInformation | 0..0 | |||
effective[x] | 1..1 | Period | The start and end time of the administration. | |
start | S | 1..1 | dateTime | Starting time with inclusive boundary |
performer | ||||
function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (preferred) | |
actor | S | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration |
reasonCode | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (preferred) | |
eventHistory | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationAdministration.category | required | UKCoreMedicationAdministrationCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationAdministrationCategory from this IG | |
MedicationAdministration.medication[x] | required | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG | |
MedicationAdministration.performer.function | preferred | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function from the FHIR Standard | |
MedicationAdministration.reasonCode | preferred | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationAdministration | 0..* | UKCoreMedicationAdministration | Administration of medication to a patient | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 0..* | Identifier | Allows the resource to be referenced within / by other resources. | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | Allows an administration to be marked as in-progress or completed. Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
category | S | 1..1 | CodeableConcept | Type of medication usage Binding: UK Core Medication Administration Category (required) | ||||
medication[x] | SΣ | 1..1 | Identifies the medication that was administered. Binding: UK Core Medication Code (required) | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication) | |||||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | Identifies the patient receiving the medication. | ||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
context | S | 0..1 | Reference(InterweaveEncounter) | Encounter administered as part of | ||||
effective[x] | SΣ | 1..1 | Period | The start and end time of the administration. | ||||
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
performer | Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (preferred) | |||||
actor | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
reasonCode | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (preferred) | |||||
dosage | SC | 0..1 | BackboneElement | The dosage instruction for the administered medication. mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationAdministration.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationAdministration.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationAdministration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.category | required | UKCoreMedicationAdministrationCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationAdministrationCategory from this IG | ||||
MedicationAdministration.medication[x] | required | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG | ||||
MedicationAdministration.performer.function | preferred | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function from the FHIR Standard | ||||
MedicationAdministration.reasonCode | preferred | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationAdministration | 0..* | UKCoreMedicationAdministration | Administration of medication to a patient | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 0..* | Identifier | Allows the resource to be referenced within / by other resources. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | Allows an administration to be marked as in-progress or completed. Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
category | S | 1..1 | CodeableConcept | Type of medication usage Binding: UK Core Medication Administration Category (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
medication[x] | SΣ | 1..1 | Identifies the medication that was administered. Binding: UK Core Medication Code (required) | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication) | |||||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | Identifies the patient receiving the medication. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
context | S | 0..1 | Reference(InterweaveEncounter) | Encounter administered as part of | ||||
effective[x] | SΣ | 1..1 | Period | The start and end time of the administration. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
performer | Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (preferred) | |||||
actor | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
reasonCode | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (preferred) | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication was administered | |||||
request | 0..1 | Reference(MedicationRequest) | Request administration performed against | |||||
device | 0..* | Reference(Device) | Device used to administer | |||||
note | 0..* | Annotation | Information about the administration | |||||
dosage | SC | 0..1 | BackboneElement | The dosage instruction for the administered medication. mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
text | 0..1 | string | Free text dosage instructions e.g. SIG | |||||
site | 0..1 | CodeableConcept | Body site administered to Binding: UK Core Body Site (preferred) | |||||
route | 0..1 | CodeableConcept | Path of substance into body Binding: UK Core Substance Or Product Administration Route (preferred) | |||||
method | 0..1 | CodeableConcept | How drug was administered Binding: UK Core Medication Dosage Method (preferred) | |||||
dose | 0..1 | SimpleQuantity | Amount of medication per dose | |||||
rate[x] | 0..1 | Dose quantity per unit of time | ||||||
rateRatio | Ratio | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationAdministration.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationAdministration.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationAdministration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codes from the FHIR Standard | ||||
MedicationAdministration.category | required | UKCoreMedicationAdministrationCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationAdministrationCategory from this IG | ||||
MedicationAdministration.medication[x] | required | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG | ||||
MedicationAdministration.performer.function | preferred | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function from the FHIR Standard | ||||
MedicationAdministration.reasonCode | preferred | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.site | preferred | UKCoreBodySitehttps://fhir.hl7.org.uk/ValueSet/UKCore-BodySite from this IG | ||||
MedicationAdministration.dosage.route | preferred | UKCoreSubstanceOrProductAdministrationRoutehttps://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute from this IG | ||||
MedicationAdministration.dosage.method | preferred | UKCoreMedicationDosageMethodhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationDosageMethod from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
This structure is derived from UKCoreMedicationAdministration
Summary
Mandatory: 4 elements(9 nested mandatory elements)
Must-Support: 14 elements
Fixed: 2 elements
Prohibited: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from UKCoreMedicationAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | UKCoreMedicationAdministration | Administration of medication to a patient | |
id | S | 0..1 | id | Logical id of this artifact |
meta | ||||
id | 0..0 | |||
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. |
profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. |
security | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers | |
Slices for tag | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
tag:Source | S | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | |
version | 0..0 | |||
code | S | 1..1 | code | The Data Provider Id of the system supplying the data |
display | S | 1..1 | string | Name of the system supplying the data |
tag:Provenance | S | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data |
id | 0..0 | |||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | |
version | 0..0 | |||
code | S | 1..1 | code | The ODS Code of the organisation responsible for the data |
display | S | 1..1 | string | Name of the organisation supplying the data |
implicitRules | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |
identifier | ||||
assigner | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | |
instantiates | 0..0 | |||
partOf | 0..0 | |||
category | S | 1..1 | CodeableConcept | Type of medication usage Binding: UK Core Medication Administration Category (required) |
coding | ||||
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
medication[x] | 1..1 | CodeableConcept, Reference(Medication) | Identifies the medication that was administered. Binding: UK Core Medication Code (required) | |
subject | 1..1 | Reference(InterweavePatient) | Identifies the patient receiving the medication. | |
reference | 1..1 | string | Reference to a resource (could be Contained) | |
type | 0..0 | |||
identifier | 0..1 | Identifier | If relevant could include an id | |
display | 1..1 | string | Description of the referenced resource | |
context | S | 0..1 | Reference(InterweaveEncounter) | Encounter administered as part of |
supportingInformation | 0..0 | |||
effective[x] | 1..1 | Period | The start and end time of the administration. | |
start | S | 1..1 | dateTime | Starting time with inclusive boundary |
performer | ||||
function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (preferred) | |
actor | S | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration |
reasonCode | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (preferred) | |
eventHistory | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationAdministration.category | required | UKCoreMedicationAdministrationCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationAdministrationCategory from this IG | |
MedicationAdministration.medication[x] | required | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG | |
MedicationAdministration.performer.function | preferred | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function from the FHIR Standard | |
MedicationAdministration.reasonCode | preferred | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationAdministration | 0..* | UKCoreMedicationAdministration | Administration of medication to a patient | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 0..* | Identifier | Allows the resource to be referenced within / by other resources. | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | Allows an administration to be marked as in-progress or completed. Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
category | S | 1..1 | CodeableConcept | Type of medication usage Binding: UK Core Medication Administration Category (required) | ||||
medication[x] | SΣ | 1..1 | Identifies the medication that was administered. Binding: UK Core Medication Code (required) | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication) | |||||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | Identifies the patient receiving the medication. | ||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
context | S | 0..1 | Reference(InterweaveEncounter) | Encounter administered as part of | ||||
effective[x] | SΣ | 1..1 | Period | The start and end time of the administration. | ||||
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
performer | Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (preferred) | |||||
actor | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
reasonCode | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (preferred) | |||||
dosage | SC | 0..1 | BackboneElement | The dosage instruction for the administered medication. mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationAdministration.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationAdministration.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationAdministration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.category | required | UKCoreMedicationAdministrationCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationAdministrationCategory from this IG | ||||
MedicationAdministration.medication[x] | required | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG | ||||
MedicationAdministration.performer.function | preferred | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function from the FHIR Standard | ||||
MedicationAdministration.reasonCode | preferred | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationAdministration | 0..* | UKCoreMedicationAdministration | Administration of medication to a patient | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource. | ||||
security | Σ | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for tag | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
tag:Source | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 0..* | Identifier | Allows the resource to be referenced within / by other resources. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(InterweaveOrganization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | Allows an administration to be marked as in-progress or completed. Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
category | S | 1..1 | CodeableConcept | Type of medication usage Binding: UK Core Medication Administration Category (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
medication[x] | SΣ | 1..1 | Identifies the medication that was administered. Binding: UK Core Medication Code (required) | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication) | |||||||
subject | SΣ | 1..1 | Reference(InterweavePatient) | Identifies the patient receiving the medication. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Reference to a resource (could be Contained) | ||||
identifier | Σ | 0..1 | Identifier | If relevant could include an id | ||||
display | Σ | 1..1 | string | Description of the referenced resource | ||||
context | S | 0..1 | Reference(InterweaveEncounter) | Encounter administered as part of | ||||
effective[x] | SΣ | 1..1 | Period | The start and end time of the administration. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
performer | Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (preferred) | |||||
actor | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
reasonCode | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (preferred) | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication was administered | |||||
request | 0..1 | Reference(MedicationRequest) | Request administration performed against | |||||
device | 0..* | Reference(Device) | Device used to administer | |||||
note | 0..* | Annotation | Information about the administration | |||||
dosage | SC | 0..1 | BackboneElement | The dosage instruction for the administered medication. mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
text | 0..1 | string | Free text dosage instructions e.g. SIG | |||||
site | 0..1 | CodeableConcept | Body site administered to Binding: UK Core Body Site (preferred) | |||||
route | 0..1 | CodeableConcept | Path of substance into body Binding: UK Core Substance Or Product Administration Route (preferred) | |||||
method | 0..1 | CodeableConcept | How drug was administered Binding: UK Core Medication Dosage Method (preferred) | |||||
dose | 0..1 | SimpleQuantity | Amount of medication per dose | |||||
rate[x] | 0..1 | Dose quantity per unit of time | ||||||
rateRatio | Ratio | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationAdministration.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
MedicationAdministration.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.meta.tag:Source | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.meta.tag:Provenance | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationAdministration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codes from the FHIR Standard | ||||
MedicationAdministration.category | required | UKCoreMedicationAdministrationCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationAdministrationCategory from this IG | ||||
MedicationAdministration.medication[x] | required | UKCoreMedicationCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode from this IG | ||||
MedicationAdministration.performer.function | preferred | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function from the FHIR Standard | ||||
MedicationAdministration.reasonCode | preferred | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.site | preferred | UKCoreBodySitehttps://fhir.hl7.org.uk/ValueSet/UKCore-BodySite from this IG | ||||
MedicationAdministration.dosage.route | preferred | UKCoreSubstanceOrProductAdministrationRoutehttps://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute from this IG | ||||
MedicationAdministration.dosage.method | preferred | UKCoreMedicationDosageMethodhttps://fhir.hl7.org.uk/ValueSet/UKCore-MedicationDosageMethod from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
This structure is derived from UKCoreMedicationAdministration
Summary
Mandatory: 4 elements(9 nested mandatory elements)
Must-Support: 14 elements
Fixed: 2 elements
Prohibited: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron