UK Core Implementation Guide 1.0.0 - STU1

StructureDefinition-UKCore-Medication

This UK Core profile is a restraint on the International FHIR resource Medication, and defines the constraints, extensions, and minimal set of data to query and retrieve medication information.

Profile Purpose

This profile is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

Snapshot View

MedicationTradeFamilyI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
codeΣ1..1CodeableConceptBinding
statusΣ ?!0..1codeBinding
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
form0..1CodeableConceptBinding
amountΣ I0..1Ratio
itemCodeableConceptCodeableConcept
itemReferenceReference(Substance | UK Core Medication)
isActive0..1boolean
strengthI0..1Ratio
lotNumber0..1string
expirationDate0..1dateTime

Differential View

MedicationTradeFamilyI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
codeΣ1..1CodeableConceptBinding
statusΣ ?!0..1codeBinding
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
form0..1CodeableConceptBinding
amountΣ I0..1Ratio
itemCodeableConceptCodeableConcept
itemReferenceReference(Substance | UK Core Medication)
isActive0..1boolean
strengthI0..1Ratio
lotNumber0..1string
expirationDate0..1dateTime

Hybrid View

MedicationTradeFamilyI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
codeΣ1..1CodeableConceptBinding
statusΣ ?!0..1codeBinding
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
form0..1CodeableConceptBinding
amountΣ I0..1Ratio
itemCodeableConceptCodeableConcept
itemReferenceReference(Substance | UK Core Medication)
isActive0..1boolean
strengthI0..1Ratio
lotNumber0..1string
expirationDate0..1dateTime

Table View

Medication..
Medication.extension..
Medication.extensionExtension..
Medication.identifier..
Medication.identifier.assignerReference(UK Core Organization)..
Medication.code1..
Medication.manufacturerReference(UK Core Organization)..
Medication.manufacturer.identifier..
Medication.manufacturer.identifier.assignerReference(UK Core Organization)..
Medication.form..
Medication.ingredient..
Medication.ingredient.item[x]CodeableConcept, Reference(Substance | UK Core Medication)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Medication" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication" />
    <version value="2.2.0" />
    <name value="UKCoreMedication" />
    <title value="UK Core Medication" />
    <status value="active" />
    <date value="2022-08-26" />
    <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="Defines the UK Core constraints and extensions on the Medication resource for the minimal set of data to query and retrieve medication information." />
    <purpose value="This profile is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use." />
    <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="script10.6" />
        <uri value="http://ncpdp.org/SCRIPT10_6" />
        <name value="Mapping to NCPDP SCRIPT 10.6" />
    </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>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Medication" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Medication" />
    <derivation value="constraint" />
    <differential>
        <element id="Medication.extension">
            <path value="Medication.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
        </element>
        <element id="Medication.extension:MedicationTradeFamily">
            <path value="Medication.extension" />
            <sliceName value="MedicationTradeFamily" />
            <short value="A Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM)" />
            <definition value="A Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM)." />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily" />
            </type>
        </element>
        <element id="Medication.identifier.assigner">
            <path value="Medication.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Medication.code">
            <path value="Medication.code" />
            <min value="1" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode" />
            </binding>
        </element>
        <element id="Medication.manufacturer">
            <path value="Medication.manufacturer" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Medication.manufacturer.identifier.assigner">
            <path value="Medication.manufacturer.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Medication.form">
            <path value="Medication.form" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationForm" />
            </binding>
        </element>
        <element id="Medication.ingredient.item[x]">
            <path value="Medication.ingredient.item[x]" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Substance" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Medication",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication",
    "version": "2.2.0",
    "name": "UKCoreMedication",
    "title": "UK Core Medication",
    "status": "active",
    "date": "2022-08-26",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the Medication resource for the minimal set of data to query and retrieve medication information.",
    "purpose": "This profile is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.",
    "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": "script10.6",
            "uri": "http://ncpdp.org/SCRIPT10_6",
            "name": "Mapping to NCPDP SCRIPT 10.6"
        },
        {
            "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"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Medication",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Medication.extension",
                "path": "Medication.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "Medication.extension:MedicationTradeFamily",
                "path": "Medication.extension",
                "sliceName": "MedicationTradeFamily",
                "short": "A Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM)",
                "definition": "A Trade Family or brand associated with a Medication, in particular a Virtual Therapeutic Moiety (VTM).",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationTradeFamily"
                        ]
                    }
                ]
            },
            {
                "id": "Medication.identifier.assigner",
                "path": "Medication.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Medication.code",
                "path": "Medication.code",
                "min": 1,
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationCode"
                }
            },
            {
                "id": "Medication.manufacturer",
                "path": "Medication.manufacturer",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Medication.manufacturer.identifier.assigner",
                "path": "Medication.manufacturer.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Medication.form",
                "path": "Medication.form",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationForm"
                }
            },
            {
                "id": "Medication.ingredient.item[x]",
                "path": "Medication.ingredient.item[x]",
                "type":  [
                    {
                        "code": "CodeableConcept"
                    },
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Substance",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Timoptol Eye Drops - An example to illustrate a representation of eye drops.
Example UKCore-Medication-TimoptolEyeDrops

Timolol - An example to illustrate the form element with a VTM.
Example UKCore-Medication-TimololVTM

COVID Vaccine - An example to illustrate the batch element.
Example UKCore-Medication-COVID-Vaccine

Extension - Medication Trade Family - An example to illustrate the Medication Trade Family.
Example UKCore-Medication-Extension-MedicationTradeFamily

Example Usage Scenarios

The UK Core Medication profile will likely not be used in isolation. It does not provide the context for the medication, e.g. the patient or medication related process. It will be typically used as a referenced resource within


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
code A dm+d code for the medication

Extensions

More information about the extensions can be found using the links below.

Extension Context Link Comment
medicationTradeFamily Medication Extension UKCore-MedicationTradeFamily Used to identify a Trade Family or brand associated with a Medication, specifically when the medication is defined using a dm+d Virtual Therapeutic Moiety (VTM) concept.

code

All medication SHOULD be represented using the NHS dm+d terminology.

  • The code.coding.system SHOULD be https://dmd.nhs.uk.
  • The code.coding.code SHOULD be the NHS dm+d concept code.
  • The code.coding.display SHOULD be the NHS dm+d concept description.

manufacturer

Name of the manufacturer by reference to the organisation. The resource being referenced SHOULD conform to Profile UKCore-Organization.


form

Within the dm+d terminology, the Virtual Medicinal Product (VMP), Actual Medicinal Product (AMP), Virtual Medicinal Product Pack (VMPP) and Actual Medicinal Product Pack (AMPP) concepts include a coded form.

This element SHOULD be used where a medication is identified using a dm+d Virtual Therapeutic Moiety (VTM) concept and the prescriber wishes to qualify the VTM with a coded form.


ingredient

The actual ingredient or content by reference. The resource being referenced SHOULD conform to one of the following:


back to top