UK Core Implementation Guide STU3 Sequence - Sprint 6 Review

StructureDefinition-UKCore-MedicationAdministration

Description

This profile defines the UK constraints and extensions on the International FHIR resource MedicationAdministration.

ProfilePurpose

The purpose of this profile is to describe the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet, or it may be a long-running infusion.

Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

Snapshot View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
instantiatesΣ0..*uri
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
statusΣ ?!1..1codeBinding
statusReason0..*CodeableConcept
category0..1CodeableConceptBinding
medicationCodeableConceptCodeableConcept
medicationReferenceReference(UK Core Medication)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
effectiveDateTimedateTime
effectivePeriodPeriod
function0..1CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reasonCode0..*CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown
text0..1string
site0..1CodeableConceptBinding
route0..1CodeableConceptBinding
method0..1CodeableConceptBinding
doseI0..1SimpleQuantity
rateRatioRatio
rateQuantitySimpleQuantity
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Differential View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
instantiatesΣ0..*uri
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
statusΣ ?!1..1codeBinding
statusReason0..*CodeableConcept
category0..1CodeableConceptBinding
medicationCodeableConceptCodeableConcept
medicationReferenceReference(UK Core Medication)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
effectiveDateTimedateTime
effectivePeriodPeriod
function0..1CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reasonCode0..*CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown
text0..1string
site0..1CodeableConceptBinding
route0..1CodeableConceptBinding
method0..1CodeableConceptBinding
doseI0..1SimpleQuantity
rateRatioRatio
rateQuantitySimpleQuantity
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Hybrid View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
instantiatesΣ0..*uri
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
statusΣ ?!1..1codeBinding
statusReason0..*CodeableConcept
category0..1CodeableConceptBinding
medicationCodeableConceptCodeableConcept
medicationReferenceReference(UK Core Medication)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
effectiveDateTimedateTime
effectivePeriodPeriod
function0..1CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reasonCode0..*CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown
text0..1string
site0..1CodeableConceptBinding
route0..1CodeableConceptBinding
method0..1CodeableConceptBinding
doseI0..1SimpleQuantity
rateRatioRatio
rateQuantitySimpleQuantity
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Table View

MedicationAdministration..
MedicationAdministration.identifier..
MedicationAdministration.identifier.assignerReference(UK Core Organization)..
MedicationAdministration.partOfReference(UK Core MedicationAdministration | UK Core Procedure)..
MedicationAdministration.partOf.identifier..
MedicationAdministration.partOf.identifier.assignerReference(UK Core Organization)..
MedicationAdministration.category..
MedicationAdministration.medication[x]CodeableConcept, Reference(UK Core Medication)..
MedicationAdministration.subjectReference(Group | UK Core Patient)..
MedicationAdministration.subject.identifier..
MedicationAdministration.subject.identifier.assignerReference(UK Core Organization)..
MedicationAdministration.contextReference(UK Core Encounter | UK Core EpisodeOfCare)..
MedicationAdministration.context.identifier..
MedicationAdministration.context.identifier.assignerReference(UK Core Organization)..
MedicationAdministration.supportingInformation..
MedicationAdministration.supportingInformation.identifier..
MedicationAdministration.supportingInformation.identifier.assignerReference(UK Core Organization)..
MedicationAdministration.performer..
MedicationAdministration.performer.actorReference(UK Core Practitioner | UK Core PractitionerRole | UK Core Patient | UK Core RelatedPerson | UK Core Device)..
MedicationAdministration.performer.actor.identifier..
MedicationAdministration.performer.actor.identifier.assignerReference(UK Core Organization)..
MedicationAdministration.reasonReferenceReference(UK Core Condition | UK Core Observation | UK Core DiagnosticReport)..
MedicationAdministration.reasonReference.identifier..
MedicationAdministration.reasonReference.identifier.assignerReference(UK Core Organization)..
MedicationAdministration.requestReference(UK Core MedicationRequest)..
MedicationAdministration.request.identifier..
MedicationAdministration.request.identifier.assignerReference(UK Core Organization)..
MedicationAdministration.deviceReference(UK Core Device)..
MedicationAdministration.device.identifier..
MedicationAdministration.device.identifier.assignerReference(UK Core Organization)..
MedicationAdministration.note..
MedicationAdministration.note.author[x]Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization), string..
MedicationAdministration.dosage..
MedicationAdministration.dosage.site..
MedicationAdministration.dosage.route..
MedicationAdministration.dosage.method..
MedicationAdministration.eventHistoryReference(UK Core Provenance)..
MedicationAdministration.eventHistory.identifier..
MedicationAdministration.eventHistory.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-MedicationAdministration" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration" />
    <version value="2.2.0" />
    <name value="UKCoreMedicationAdministration" />
    <title value="UK Core MedicationAdministration" />
    <status value="active" />
    <date value="2022-12-16" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [MedicationAdministration](https://hl7.org/fhir/R4/MedicationAdministration.html)." />
    <purpose value="The purpose of this profile is to describe the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet, or it may be a long-running infusion. \n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="workflow" />
        <uri value="http://hl7.org/fhir/workflow" />
        <name value="Workflow Pattern" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="w3c.prov" />
        <uri value="http://www.w3.org/ns/prov" />
        <name value="W3C PROV" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="MedicationAdministration" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/MedicationAdministration" />
    <derivation value="constraint" />
    <differential>
        <element id="MedicationAdministration.identifier.assigner">
            <path value="MedicationAdministration.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MedicationAdministration.partOf">
            <path value="MedicationAdministration.partOf" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure" />
            </type>
        </element>
        <element id="MedicationAdministration.partOf.identifier.assigner">
            <path value="MedicationAdministration.partOf.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MedicationAdministration.category">
            <path value="MedicationAdministration.category" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationAdministrationCategory" />
            </binding>
        </element>
        <element id="MedicationAdministration.medication[x]">
            <path value="MedicationAdministration.medication[x]" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication" />
            </type>
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode" />
            </binding>
        </element>
        <element id="MedicationAdministration.subject">
            <path value="MedicationAdministration.subject" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
            </type>
        </element>
        <element id="MedicationAdministration.subject.identifier.assigner">
            <path value="MedicationAdministration.subject.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MedicationAdministration.context">
            <path value="MedicationAdministration.context" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-EpisodeOfCare" />
            </type>
        </element>
        <element id="MedicationAdministration.context.identifier.assigner">
            <path value="MedicationAdministration.context.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MedicationAdministration.supportingInformation.identifier.assigner">
            <path value="MedicationAdministration.supportingInformation.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MedicationAdministration.performer.actor">
            <path value="MedicationAdministration.performer.actor" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" />
            </type>
        </element>
        <element id="MedicationAdministration.performer.actor.identifier.assigner">
            <path value="MedicationAdministration.performer.actor.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MedicationAdministration.reasonReference">
            <path value="MedicationAdministration.reasonReference" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport" />
            </type>
        </element>
        <element id="MedicationAdministration.reasonReference.identifier.assigner">
            <path value="MedicationAdministration.reasonReference.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MedicationAdministration.request">
            <path value="MedicationAdministration.request" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest" />
            </type>
        </element>
        <element id="MedicationAdministration.request.identifier.assigner">
            <path value="MedicationAdministration.request.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MedicationAdministration.device">
            <path value="MedicationAdministration.device" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device" />
            </type>
        </element>
        <element id="MedicationAdministration.device.identifier.assigner">
            <path value="MedicationAdministration.device.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="MedicationAdministration.note.author[x]">
            <path value="MedicationAdministration.note.author[x]" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
            <type>
                <code value="string" />
            </type>
        </element>
        <element id="MedicationAdministration.dosage.site">
            <path value="MedicationAdministration.dosage.site" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-BodySite" />
            </binding>
        </element>
        <element id="MedicationAdministration.dosage.route">
            <path value="MedicationAdministration.dosage.route" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute" />
            </binding>
        </element>
        <element id="MedicationAdministration.dosage.method">
            <path value="MedicationAdministration.dosage.method" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationDosageMethod" />
            </binding>
        </element>
        <element id="MedicationAdministration.eventHistory">
            <path value="MedicationAdministration.eventHistory" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Provenance" />
            </type>
        </element>
        <element id="MedicationAdministration.eventHistory.identifier.assigner">
            <path value="MedicationAdministration.eventHistory.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-MedicationAdministration",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration",
    "version": "2.2.0",
    "name": "UKCoreMedicationAdministration",
    "title": "UK Core MedicationAdministration",
    "status": "active",
    "date": "2022-12-16",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [MedicationAdministration](https://hl7.org/fhir/R4/MedicationAdministration.html).",
    "purpose": "The purpose of this profile is to describe the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet, or it may be a long-running infusion. \n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "w3c.prov",
            "uri": "http://www.w3.org/ns/prov",
            "name": "W3C PROV"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "MedicationAdministration",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "MedicationAdministration.identifier.assigner",
                "path": "MedicationAdministration.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.partOf",
                "path": "MedicationAdministration.partOf",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationAdministration",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.partOf.identifier.assigner",
                "path": "MedicationAdministration.partOf.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.category",
                "path": "MedicationAdministration.category",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationAdministrationCategory"
                }
            },
            {
                "id": "MedicationAdministration.medication[x]",
                "path": "MedicationAdministration.medication[x]",
                "type":  [
                    {
                        "code": "CodeableConcept"
                    },
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication"
                        ]
                    }
                ],
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode"
                }
            },
            {
                "id": "MedicationAdministration.subject",
                "path": "MedicationAdministration.subject",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Group",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.subject.identifier.assigner",
                "path": "MedicationAdministration.subject.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.context",
                "path": "MedicationAdministration.context",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-EpisodeOfCare"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.context.identifier.assigner",
                "path": "MedicationAdministration.context.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.supportingInformation.identifier.assigner",
                "path": "MedicationAdministration.supportingInformation.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.performer.actor",
                "path": "MedicationAdministration.performer.actor",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.performer.actor.identifier.assigner",
                "path": "MedicationAdministration.performer.actor.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.reasonReference",
                "path": "MedicationAdministration.reasonReference",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.reasonReference.identifier.assigner",
                "path": "MedicationAdministration.reasonReference.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.request",
                "path": "MedicationAdministration.request",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.request.identifier.assigner",
                "path": "MedicationAdministration.request.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.device",
                "path": "MedicationAdministration.device",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.device.identifier.assigner",
                "path": "MedicationAdministration.device.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.note.author[x]",
                "path": "MedicationAdministration.note.author[x]",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    },
                    {
                        "code": "string"
                    }
                ]
            },
            {
                "id": "MedicationAdministration.dosage.site",
                "path": "MedicationAdministration.dosage.site",
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-BodySite"
                }
            },
            {
                "id": "MedicationAdministration.dosage.route",
                "path": "MedicationAdministration.dosage.route",
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute"
                }
            },
            {
                "id": "MedicationAdministration.dosage.method",
                "path": "MedicationAdministration.dosage.method",
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationDosageMethod"
                }
            },
            {
                "id": "MedicationAdministration.eventHistory",
                "path": "MedicationAdministration.eventHistory",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Provenance"
                        ]
                    }
                ]
            },
            {
                "id": "MedicationAdministration.eventHistory.identifier.assigner",
                "path": "MedicationAdministration.eventHistory.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Timoptol Eye Drops - An example to illustrate a medication administration of eye drops.
Example UKCore-MedicationAdministration-TimoptolEyeDrops

Example Usage Scenarios

The following are example usage scenarios for the UK Core Medication Administration profile:

  • To share inpatient or outpatient non-immunization administrations of medication between clinical systems. Example scenarios include inpatient patient transfer from ward-to-ward or hospital-to-hospital, where different clinical systems are in use. For immunisations use the Profile UKCore-Immunization resource.
  • To share patient self-administration of medication.
  • To share home-health reporting from medicines administration and monitoring devices.

Profile Specific Implementation Guidance:

Minimum Viable Content

A minimum viable content that all provider and consumer systems SHOULD support are the following elements.

Element Reason
MedicationAdministration.identifier Allow the resource to be referenced within/by other resources
MedicationAdministration.status Mandatory element
MedicationAdministration.statusReason Expand on the intent of the status
MedicationAdministration.medication[x] Mandatory element
MedicationAdministration.subject Mandatory element
MedicationAdministration.effective[x] Mandatory element
MedicationAdministration.dosage The dosage instruction for the administered medication

Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context Strength Link
MedicationAdministration.category Extensible ValueSet UKCore-MedicationAdministrationCategory
MedicationAdministration.medication Preferred ValueSet UKCore-MedicationCode
MedicationAdministration.dosage.site Preferred ValueSet UKCore-BodySite
MedicationAdministration.dosage.route Preferred ValueSet UKCore-SubstanceOrProductAdministrationRoute
MedicationAdministration.dosage.method Preferred ValueSet UKCore-MedicationDosageMethod

partOf

An optional reference to a Procedure that could be used for medications given intraoperatively (during an operation / procedure) where there may not be a MedicationRequest resource to reference. A reverse reference could be added as ‘partOf’ of the Procedure resource.

This element can also reference another MedicationAdministration resource. Where several medication administrations relate to the same MedicationRequest, the reference to the MedicationRequest within ‘request’ is sufficient for logical data linkage purposes. It may give additional business benefit to also logically link the MedicationAdministration resources using ‘partOf’.

The resource being referenced SHOULD conform to the one of the following:


status

The MedicationAdministration.status element SHALL be populated with a value from the International FHIR ValueSet medication-admin-status, which is shown expanded here with additional guidance.

Systems consuming the data SHOULD use MedicationAdministration.status to support workflow.

The status can be used to determine the overall status of medication administration events.

It is recommended that the MedicationAdministration.status is used to indicate the status at a high-level so that integrated systems can determine how to represent this information.

Status FHIR Definition Implementation Guidance
in-progress The administration has started but has not yet completed. Would be a suitable status to use, for example, by an infusion pump device which is interoperable with the clinical system to denote an infusion is in progress.
not-done The administration was terminated prior to any impact on the subject (though preparatory actions may have been taken) Use this when there is not the intention to undertake the administration at a future time.
on-hold Actions implied by the administration have been temporarily halted, but are expected to continue later. May also be called 'suspended'. Use this when there is the intention to administer the medication at a future time. For example, if the patient is temporarily unavailable.
completed All actions that are implied by the administration have occurred. This would be a suitable trigger to share the medication administration event with shared records.
entered-in-error The administration was entered in error and therefore nullified. There is limited value in sharing records that are entered in error.
stopped Actions implied by the administration have been permanently halted, before all of them occurred. A MedicationAdministration.statusReason SHOULD be populated with a coded reason for stopping the medication administration.

This is for things like patches and continuous infusions etc. where administration is over a period of time. The MedicationAdministration.dosage should reflect the amount administered (or whatever the source system has recorded).
unknown The authoring system does not know which of the status values currently applies for this request. Note: This concept is not to be used for 'other' - one of the statuses listed is presumed to apply, it's just not known which one. The patient may have had some encounter with this medication, but the current status is unknown. Avoid the use of this status value where possible.

statusReason

A coded reason for why an administration was not performed.

SHOULD only be populated when the MedicationAdministration.status is either stopped, not-done or on-hold.

Example scenarios for the use of status and statusReason.

Some medication was taken, but not all that was intended, for whatever reason, e.g. an infusion that was started, and finished prematurely.

  • status = stopped
  • status reason = 416093006 | Allergic reaction to drug
  • dosage = Should reflect how much was actually administered, e.g. 150ml (instead of 200ml requested)

Note: For this example it would be expected that the originating MedicationRequest would be updated with a status of stopped which should prevent the system from scheduling an administration or delete any that have been scheduled. Where administration records are retained, use the status of stopped.

Patient refused to take the medication.

  • status = not-done
  • statusReason = 182895007 | Drug declined by patient (finding) - or a child concept of the above

Where required use MedicationAdministration.note to capture additional notes for why the patient refused the medication.

Patient not available, e.g. on home leave for a couple of days, moved ward, location unknown, etc. and not recorded as on-hold.

  • status = not-done
  • statusReason = 398090008 | Patient unavailable (finding)

Medication was taken but patient then vomited all/some of the medication.

  • status = on-hold or stopped
  • statusReason = 419219000 | Drug-induced nausea and vomiting

Use MedicationAdministration.note for additional notes for what happened, provided the administration record can be amended after the vomiting episode.

An infusion for the patient is paused for a period based on blood test results. Or, a nutrition feed is paused for clinical reasons, to restart again later.

  • status = on-hold
  • statusReason = Optional. Any valid SNOMED term.
  • dosage = The dosage would either be recorded with a zero rateRatio or rateQuantity or may be fully omitted. Both must be interpreted as a zero medication administration.

medication[x]

Medication WITH dm+d code

Where a dm+d code exists it SHALL be used either as MedicationAdministration.medicationCodeableConcept.coding or as MedicationAdministration.medicationReference.Medication.code.

Where CodeableConcept is used, MedicationAdministration.medicationCodeableConcept.coding is the dm+d code and MedicationAdministration.medicationCodeableConcept.text is dm+d concept name/description.

Can be either a dm+d code as a CodeableConcept or reference to a Profile UKCore-Medication.

Using a CodeableConcept is preferred unless additional data is required that would be contained within a Profile UKCore-Medication.

The elements MedicationAdministration.medicationCodeableConcept.coding and MedicationAdministration.medicationReference.Medication.code are both bound to ValueSet UKCore-MedicationCode

Examples where a reference to a Profile UKCore-Medication would be applicable include:

  • Record a VTM with a specific form
  • Record manufacturer with a concept as described in ValueSet UKCore-MedicationCode
  • Record batch number
  • Record ingredients (for example with a magisterial prescription or an excipient).

Medication WITHOUT dm+d code

Medication not published within the dm+d may be requested in the Acute care setting.

In this scenario it is recommended to use the CodeableConcept variant for this element.

If the prescribing system has both a locally assigned code and description for the medication then;

  • The MedicationAdministration.medicationCodeableConcept.text SHOULD be the description for the medication.
  • The MedicationAdministration.medicationCodeableConcept.coding.code SHOULD be the code for the medication.
  • The MedicationAdministration.medicationCodeableConcept.coding.display SHOULD be the description for the medication, i.e. the same value as MedicationAdministration.medicationCodeableConcept.text.

If the prescribing system only has a description for the medication then;

  • The MedicationAdministration.medicationCodeableConcept.text SHOULD be the locally assigned description for the medication.

subject

A reference to the patient.

Within a FHIR Messaging or FHIR Document implementation, include a Profile UKCore-Patient resource within the Bundle with at least the minimum dataset populated as defined within the UK Core standard. The MedicationAdministration.subject.reference points to the resource in the Bundle.


context

The resource being referenced SHOULD conform to one of the following:


supportingInformation

Where a UK Core profile exists, the resource being referenced SHOULD conform to the profile.

reasonReference

The resource being referenced SHOULD conform to one of the following:


request

In many cases, a Profile UKCore-MedicationRequest resource will exist and can be referenced. Consideration must be made when sharing the records to either also share the MedicationRequest or make it accessible by query, if/when required.

Cases where a MedicationRequest may not exist include administration of medication bought over the counter or via an emergency supply of medication.


device

The resource being referenced SHOULD conform to the Profile UKCore-Device


dosage

Consider aligning to the Implementation Guide for Digital Medicines, but as a minimum, MedicationAdministration.dosage.text.

A MedicationAdministration resource may be used to describe a period of no administration. The MedicationAdministration.status would be on-hold and either the dosage would be omitted, or a dosage would be recorded with a zero rate or quantity. For example;

Example of MedicationAdministration.dosage usage:

Table View

MedicationAdministration.id[0]UKCore-MedicationAdministration-Sn-ZeroDosage-Example
MedicationAdministration.status[0]on-hold
MedicationAdministration.medicationReference[0].reference[0]Medication/UKCore-Medication-TimoptolEyeDrops-Example
MedicationAdministration.subject[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
MedicationAdministration.effectiveDateTime[0]2021-03-25T13:00:00+00:00
MedicationAdministration.dosage[0].text[0]No administration required.
MedicationAdministration.dosage[0].rateQuantity[0].value[0]0
MedicationAdministration.dosage[0].rateQuantity[0].unit[0]milliliter per hour
MedicationAdministration.dosage[0].rateQuantity[0].system[0]http://unitsofmeasure.org
MedicationAdministration.dosage[0].rateQuantity[0].code[0]mL/h

Tree View

MedicationAdministration

XML View

<MedicationAdministration xmlns="http://hl7.org/fhir">
    <id value="UKCore-MedicationAdministration-Sn-ZeroDosage-Example" />
    <status value="on-hold" />
    <medicationReference>
        <reference value="Medication/UKCore-Medication-TimoptolEyeDrops-Example" />
    </medicationReference>
    <subject>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </subject>
    <effectiveDateTime value="2021-03-25T13:00:00+00:00" />
    <dosage>
        <text value="No administration required." />
        <rateQuantity>
            <value value="0" />
            <unit value="milliliter per hour" />
            <system value="http://unitsofmeasure.org" />
            <code value="mL/h" />
        </rateQuantity>
    </dosage>
</MedicationAdministration>

JSON View

{
    "resourceType": "MedicationAdministration",
    "id": "UKCore-MedicationAdministration-Sn-ZeroDosage-Example",
    "status": "on-hold",
    "medicationReference": {
        "reference": "Medication/UKCore-Medication-TimoptolEyeDrops-Example"
    },
    "subject": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "effectiveDateTime": "2021-03-25T13:00:00+00:00",
    "dosage": {
        "text": "No administration required.",
        "rateQuantity": {
            "value": 0,
            "unit": "milliliter per hour",
            "system": "http://unitsofmeasure.org",
            "code": "mL/h"
        }
    }
}

eventHistory

The resource being referenced SHOULD conform to Profile UKCore-Provenance.


back to top