UK Core Implementation Guide 0.5.0 - STU1

StructureDefinition-UKCore-MedicationAdministration

Defines the UK Core constraints and extensions on the MedicationAdministration resource for the minimal set of data to query and retrieve medication administration information.

Profile 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. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. 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.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.1.0" />
    <name value="UKCoreMedicationAdministration" />
    <title value="UK Core MedicationAdministration" />
    <status value="active" />
    <date value="2021-09-10" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints and extensions on the MedicationAdministration resource for the minimal set of data to query and retrieve medication administration information." />
    <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. Related 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.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="extensible" />
                <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="extensible" />
                <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="extensible" />
                <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="extensible" />
                <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.1.0",
    "name": "UKCoreMedicationAdministration",
    "title": "UK Core MedicationAdministration",
    "status": "active",
    "date": "2021-09-10",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the MedicationAdministration resource for the minimal set of data to query and retrieve medication administration information.",
    "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. Related 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.medication[x]",
                "path": "MedicationAdministration.medication[x]",
                "type":  [
                    {
                        "code": "CodeableConcept"
                    },
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication"
                        ]
                    }
                ],
                "binding": {
                    "strength": "extensible",
                    "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": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-BodySite"
                }
            },
            {
                "id": "MedicationAdministration.dosage.route",
                "path": "MedicationAdministration.dosage.route",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute"
                }
            },
            {
                "id": "MedicationAdministration.dosage.method",
                "path": "MedicationAdministration.dosage.method",
                "binding": {
                    "strength": "extensible",
                    "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 record and/or share inpatient or outpatient non-immunization administrations. For immunisations use the Profile UKCore-MedicationAdministration resource.
  • to record and/or share patient self-administration of medication.
  • to record and/or share home-health reporting from medicines administration and monitoring devices.

Minimum Viable Content

A minimum viable dataset that all provider and consumer systems should support is the following elements.

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

Context For Provider Systems

Providers systems should view elements listed as part of the minimum viable content in the same way as FHIR Must Support elements. Where the data is available, the provider system should include this data within the resource. Additional elements populated may be ignored by consumer systems.

Context For Consumer Systems

Consumer systems should expect the elements listed as part of the minimum viable dataset to be populated, with business data that should be relevant for the processing of the resource. Additional elements may not be populated by provider systems.


identifier

This should be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data). This should be scoped by a provider specific namespace for the identifier.

Where consuming systems are integrating data from this resource to their local system, they should persist this identifier at the same time.


instantiates

Optional.


partOf

Part of referenced event by reference. The resource being referenced should conform to the one of the following:

This element is optional.

status (Mandatory)

MUST be populated with a fixed valueset defined within the FHIR standard.

It is expected that most implementations will require the use of status to support workflow.

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

It is recommended that the 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.
not-done The administration was terminated prior to any impact on the subject (though preparatory actions may have been taken)
on-hold Actions implied by the administration have been temporarily halted, but are expected to continue later. May also be called 'suspended'.
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.
stopped Actions implied by the administration have been permanently halted, before all of them occurred. A statusReason should be populated with a coded reason for stopping the medication administration.
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 listed statuses 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 status is stopped.


category

Optional.

Defines the care setting for the administration. The preferred value set contains inpatient, outpatient and community.


medication[x] (Mandatory)

Where a dm+d code exists it MUST be used either as CodeableConcept.coding or as Medication.Medication.code

Where CodeableConcept is used, CodeableConcept.coding is the dm+d code and CodeableConcept.text is dm+d concept name/description. Where no dm+d code is available the drug name can be provided as text within the CodeableConcept.text

Can be either a dm+d code as a CodeableConcept or a reference to medication. Using a CodeableConcept is preferred unless additional data if required that would be carried within a Profile UKCore-Medication

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

  • Record a VTM with a specific form
  • Record manufacturer with a VTM, VMP or VMP concept
  • Record batch number
  • Record ingredients (for example with a magisterial prescription or an excipient).

subject (Mandatory)

In most cases this is a reference to the patient. Note: the FHIR standard also allows a reference to Group

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 reference points to the resource in the Bundle.

JSON

// within the MedicationAdministration resource...

  "subject": {
    "reference": "urn:patient-011223344",
    "display": "Richard Smith"
  }

// elsewhere in the Bundle...

  {
    "fullUrl": "urn:patient-011223344",
    "resource": {
      "resourceType": "Patient",
      "id": "urn:patient-011223344",
      "identifier": {
        "system": "https://fhir.nhs.uk/Id/nhs-number",
        "value": "9912003888"
      },
      "name": {
        "use": "official",
        "text": "Mr Richard Smith",
        "family": "Smith",
        "given": "Richard",
        "prefix": "Mr"
      },
      "gender": "male",
      "birthDate": "1956-02-04"
    }
  }

Within a RESTful implemementation a reference and/or identifier MUST be provided that allows the consumer system to query another API if they need to access the complete Profile UKCore-Patient resource. The reference points to the resource in the Bundle.

For implementations within England and Wales, the identifier could be the patient's NHS Number, allowing consumer system to use the NHS Digital Personal Demographics Service FHIR API return a Patient resource.

JSON

{
  "subject": {
    "reference": "urn:patient-011223344",
    "display": "Richard Smith",
    "identifier": {
      "system": "https://fhir.nhs.uk/Id/nhs-number",
      "value": "9912003888"
    }
  }
}

For implementations within Scotland, the identifier could be the patient's CHI Number.

JSON

{
  "subject": {
    "reference": "urn:patient-011223344",
    "display": "Richard Smith",
    "identifier": {
      "system": "https://fhir.nhs.uk/Id/chi-number",
      "value": "0402568876"
    }
  }
}


context

Optional - A reference to the Encounter or Episode of Care administered as part of. The resource being referenced shou conform to one of the following:


supportingInformation

Additional information to support administration by reference to any FHIR resource where a UK Core profile exists the resource being referenced should conform to the profile.

effective[x] (Mandatory)

A mandatory dateTime or period for the administration.


performer

Optional. Indicates who performed the medication administration by reference. The resource being referenced should conform to one of the following:


reasonCode

Optional.


reasonReference

Optional. Condition or observation that supports why the medication was administered by reference. The resource being referenced should conform to the following:


request

Optional. A reference to the request administration performed against. The resource being referenced should conform to Profile UKCore-MedicationRequest


device

Optional. Device used to administer by reference. The resource being referenced should conform to UKCore-Device Profile.


note

Optional.


dosage

Preferable as a structured dosage aligned to the FHIR Dose Syntax Guidance but as a minimum, dosage.text.


eventHistory

Optional. A list of events of interest in the lifecycle. The resource being referenced should conform to UKCore-Provenance Profile.


back to top