Canonical_URL | Current_Version | Last_Updated | Description |
---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication | 2.2.0 | 2022-12-16 | This profile defines the UK constraints and extensions on the International FHIR resource Medication. |
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. |
Medication | I | Medication | |
extension | I | 0..* | Extension |
MedicationTradeFamily | I | 0..1 | Extension(CodeableConcept) |
identifier | Σ | 0..* | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
code | Σ | 1..1 | CodeableConceptBinding |
status | Σ ?! | 0..1 | codeBinding |
manufacturer | Σ I | 0..1 | Reference(UK Core Organization) |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
display | Σ | 0..1 | string |
form | 0..1 | CodeableConceptBinding | |
amount | Σ I | 0..1 | Ratio |
ingredient | 0..* | BackboneElement | |
item[x] | 1..1 | ||
itemCodeableConcept | CodeableConcept | ||
itemReference | Reference(Substance | UK Core Medication) | ||
isActive | 0..1 | boolean | |
strength | I | 0..1 | Ratio |
batch | 0..1 | BackboneElement | |
lotNumber | 0..1 | string | |
expirationDate | 0..1 | dateTime |
Medication | I | Medication | |
extension | I | 0..* | Extension |
MedicationTradeFamily | I | 0..1 | Extension(CodeableConcept) |
identifier | Σ | 0..* | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
code | Σ | 1..1 | CodeableConceptBinding |
status | Σ ?! | 0..1 | codeBinding |
manufacturer | Σ I | 0..1 | Reference(UK Core Organization) |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
display | Σ | 0..1 | string |
form | 0..1 | CodeableConceptBinding | |
amount | Σ I | 0..1 | Ratio |
ingredient | 0..* | BackboneElement | |
item[x] | 1..1 | ||
itemCodeableConcept | CodeableConcept | ||
itemReference | Reference(Substance | UK Core Medication) | ||
isActive | 0..1 | boolean | |
strength | I | 0..1 | Ratio |
batch | 0..1 | BackboneElement | |
lotNumber | 0..1 | string | |
expirationDate | 0..1 | dateTime |
Medication | I | Medication | |
extension | I | 0..* | Extension |
MedicationTradeFamily | I | 0..1 | Extension(CodeableConcept) |
identifier | Σ | 0..* | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
code | Σ | 1..1 | CodeableConceptBinding |
status | Σ ?! | 0..1 | codeBinding |
manufacturer | Σ I | 0..1 | Reference(UK Core Organization) |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
display | Σ | 0..1 | string |
form | 0..1 | CodeableConceptBinding | |
amount | Σ I | 0..1 | Ratio |
ingredient | 0..* | BackboneElement | |
item[x] | 1..1 | ||
itemCodeableConcept | CodeableConcept | ||
itemReference | Reference(Substance | UK Core Medication) | ||
isActive | 0..1 | boolean | |
strength | I | 0..1 | Ratio |
batch | 0..1 | BackboneElement | |
lotNumber | 0..1 | string | |
expirationDate | 0..1 | dateTime |
Medication | .. | |
Medication.extension | .. | |
Medication.extension | Extension | .. |
Medication.identifier | .. | |
Medication.identifier.assigner | Reference(UK Core Organization) | .. |
Medication.code | 1.. | |
Medication.manufacturer | Reference(UK Core Organization) | .. |
Medication.manufacturer.identifier | .. | |
Medication.manufacturer.identifier.assigner | Reference(UK Core Organization) | .. |
Medication.form | .. | |
Medication.ingredient | .. | |
Medication.ingredient.item[x] | CodeableConcept, Reference(Substance | UK Core Medication) | .. |
<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-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 [Medication](https://hl7.org/fhir/R4/Medication.html)." /> <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 © 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 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="preferred" /> <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>
{ "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-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 [Medication](https://hl7.org/fhir/R4/Medication.html).", "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": "preferred", "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" ] } ] } ] } }
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
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
A minimum viable content that all provider and consumer systems SHALL support are the following elements.
Element | Reason |
---|---|
Medication.code |
Codes that identify this medication. |
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. |
More information about the bindings to UK Core ValueSets can be found below.
Context | Strength | Link |
---|---|---|
Medication.extension:MedicationTradeFamily | Preferred | ValueSet UKCore-MedicationTradeFamily |
Medication.code | Preferred | ValueSet UKCore-MedicationCode |
Medication.form | Preferred | ValueSet UKCore-MedicationForm |
code
All medication SHOULD be represented using the NHS dm+d terminology.
Medication.code.coding.system
SHOULD be https://dmd.nhs.uk
.Medication.code.coding.code
SHOULD be the NHS dm+d concept code.Medication.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 SHALL 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 SHALL conform to one of the following: