Implementation guide for interoperable medicines

This guidance is under active development by NHS England and content may be added or updated on a regular basis.

Omeprazole gastro-resistant

Product-based instruction using a VMP. 
<MedicationRequest xmlns="http://hl7.org/fhir">
    <id value="d8360782-bbcb-486d-bcad-e268e68d5a74" />
    <meta>
        <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest" />
    </meta>
    <status value="active" />
    <intent value="order" />
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/medicationrequest-category" />
            <code value="inpatient" />
            <display value="inpatient" />
        </coding>
    </category>
    <priority value="routine" />
    <medicationCodeableConcept>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="317297007" />
            <display value="Omeprazole 10mg gastro-resistant capsules" />
        </coding>
    </medicationCodeableConcept>
    <subject>
        <identifier>
            <system value="https://fhir.nhs.uk/Id/nhs-number" />
            <value value="9999999999" />
        </identifier>
    </subject>
    <authoredOn value="2020-05-15T15:00:00Z" />
    <requester>
        <reference value="urn:staff-1112" />
        <display value="Dr Maikeu Well" />
    </requester>
    <recorder>
        <reference value="urn:staff-1112" />
        <display value="Dr Maikeu Well" />
    </recorder>
    <dosageInstruction>
        <text value="1 tablet - daily - oral" />
        <timing>
            <repeat>
                <frequency value="1" />
                <period value="1" />
                <periodUnit value="d" />
            </repeat>
        </timing>
        <route>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="26643006" />
                <display value="oral" />
            </coding>
        </route>
        <doseAndRate>
            <doseQuantity>
                <value value="1" />
                <unit value="tablet" />
                <system value="http://snomed.info/sct" />
                <code value="428673006" />
            </doseQuantity>
        </doseAndRate>
    </dosageInstruction>
    <substitution>
        <allowedBoolean value="false" />
    </substitution>
</MedicationRequest>

{
    "resourceType": "MedicationRequest",
    "id": "d8360782-bbcb-486d-bcad-e268e68d5a74",
    "meta": {
        "profile":  [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest"
        ]
    },
    "status": "active",
    "intent": "order",
    "category":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
                    "code": "inpatient",
                    "display": "inpatient"
                }
            ]
        }
    ],
    "priority": "routine",
    "medicationCodeableConcept": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "317297007",
                "display": "Omeprazole 10mg gastro-resistant capsules"
            }
        ]
    },
    "subject": {
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9999999999"
        }
    },
    "authoredOn": "2020-05-15T15:00:00Z",
    "requester": {
        "reference": "urn:staff-1112",
        "display": "Dr Maikeu Well"
    },
    "recorder": {
        "reference": "urn:staff-1112",
        "display": "Dr Maikeu Well"
    },
    "dosageInstruction":  [
        {
            "text": "1 tablet - daily - oral",
            "timing": {
                "repeat": {
                    "frequency": 1,
                    "period": 1,
                    "periodUnit": "d"
                }
            },
            "route": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "26643006",
                        "display": "oral"
                    }
                ]
            },
            "doseAndRate":  [
                {
                    "doseQuantity": {
                        "value": 1,
                        "unit": "tablet",
                        "system": "http://snomed.info/sct",
                        "code": "428673006"
                    }
                }
            ]
        }
    ],
    "substitution": {
        "allowedBoolean": false
    }
}
MedicationRequest.id[0]d8360782-bbcb-486d-bcad-e268e68d5a74
MedicationRequest.meta[0].profile[0]https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest
MedicationRequest.status[0]active
MedicationRequest.intent[0]order
MedicationRequest.category[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/medicationrequest-category
MedicationRequest.category[0].coding[0].code[0]inpatient
MedicationRequest.category[0].coding[0].display[0]inpatient
MedicationRequest.priority[0]routine
MedicationRequest.medication[0].coding[0].system[0]https://dmd.nhs.uk
MedicationRequest.medication[0].coding[0].code[0]317297007
MedicationRequest.medication[0].coding[0].display[0]Omeprazole 10mg gastro-resistant capsules
MedicationRequest.subject[0].identifier[0].system[0]https://fhir.nhs.uk/Id/nhs-number
MedicationRequest.subject[0].identifier[0].value[0]9999999999
MedicationRequest.authoredOn[0]2020-05-15T15:00:00Z
MedicationRequest.requester[0].reference[0]urn:staff-1112
MedicationRequest.requester[0].display[0]Dr Maikeu Well
MedicationRequest.recorder[0].reference[0]urn:staff-1112
MedicationRequest.recorder[0].display[0]Dr Maikeu Well
MedicationRequest.dosageInstruction[0].text[0]1 tablet - daily - oral
MedicationRequest.dosageInstruction[0].timing[0].repeat[0].frequency[0]1
MedicationRequest.dosageInstruction[0].timing[0].repeat[0].period[0]1
MedicationRequest.dosageInstruction[0].timing[0].repeat[0].periodUnit[0]d
MedicationRequest.dosageInstruction[0].route[0].coding[0].system[0]http://snomed.info/sct
MedicationRequest.dosageInstruction[0].route[0].coding[0].code[0]26643006
MedicationRequest.dosageInstruction[0].route[0].coding[0].display[0]oral
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].value[0]1
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].unit[0]tablet
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].system[0]http://snomed.info/sct
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].code[0]428673006
MedicationRequest.substitution[0].allowed[0]False
MedicationRequest

Example on-screen presentation:

Omeprazole 10mg gastro-resistant capsules
1 tablet - daily - oral

Dose-based instruction using a VTM.
IMPORTANT: This example cannot use the simple medicationCodeableConcept element. The VTM medication needs to be qualified with a form. This example uses a contained resource which would be suitable for a RESTful implementation. When using a FHIR Messaging implementation the instance of the Medication resource as another resource within the Bundle. 
<MedicationRequest xmlns="http://hl7.org/fhir">
    <id value="4de51441-b8af-4362-a825-3efbba3a645b" />
    <meta>
        <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest" />
    </meta>
    <contained>
        <Medication>
            <id value="med1" />
            <code>
                <coding>
                    <system value="https://dmd.nhs.uk" />
                    <code value="25673006" />
                    <display value="Omeprazole" />
                </coding>
            </code>
            <form>
                <coding>
                    <system value="http://snomed.info/sct" />
                    <code value="385052003" />
                    <display value="gastro-resistant capsule" />
                </coding>
            </form>
        </Medication>
    </contained>
    <status value="active" />
    <intent value="order" />
    <category>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/medicationrequest-category" />
            <code value="inpatient" />
            <display value="inpatient" />
        </coding>
    </category>
    <priority value="routine" />
    <medicationReference>
        <reference value="#med1" />
    </medicationReference>
    <subject>
        <identifier>
            <system value="https://fhir.nhs.uk/Id/nhs-number" />
            <value value="9999999999" />
        </identifier>
    </subject>
    <authoredOn value="2020-05-15T15:00:00Z" />
    <requester>
        <reference value="urn:staff-1112" />
        <display value="Dr Maikeu Well" />
    </requester>
    <recorder>
        <reference value="urn:staff-1112" />
        <display value="Dr Maikeu Well" />
    </recorder>
    <dosageInstruction>
        <text value="10 milligram - daily - oral" />
        <timing>
            <repeat>
                <frequency value="1" />
                <period value="1" />
                <periodUnit value="d" />
            </repeat>
        </timing>
        <route>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="26643006" />
                <display value="oral" />
            </coding>
        </route>
        <doseAndRate>
            <doseQuantity>
                <value value="10" />
                <unit value="milligram" />
                <system value="http://unitsofmeasure.org" />
                <code value="mg" />
            </doseQuantity>
        </doseAndRate>
    </dosageInstruction>
    <substitution>
        <allowedBoolean value="false" />
    </substitution>
</MedicationRequest>

{
    "resourceType": "MedicationRequest",
    "id": "4de51441-b8af-4362-a825-3efbba3a645b",
    "meta": {
        "profile":  [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest"
        ]
    },
    "contained":  [
        {
            "resourceType": "Medication",
            "id": "med1",
            "code": {
                "coding":  [
                    {
                        "system": "https://dmd.nhs.uk",
                        "code": "25673006",
                        "display": "Omeprazole"
                    }
                ]
            },
            "form": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "385052003",
                        "display": "gastro-resistant capsule"
                    }
                ]
            }
        }
    ],
    "status": "active",
    "intent": "order",
    "category":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
                    "code": "inpatient",
                    "display": "inpatient"
                }
            ]
        }
    ],
    "priority": "routine",
    "medicationReference": {
        "reference": "#med1"
    },
    "subject": {
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9999999999"
        }
    },
    "authoredOn": "2020-05-15T15:00:00Z",
    "requester": {
        "reference": "urn:staff-1112",
        "display": "Dr Maikeu Well"
    },
    "recorder": {
        "reference": "urn:staff-1112",
        "display": "Dr Maikeu Well"
    },
    "dosageInstruction":  [
        {
            "text": "10 milligram - daily - oral",
            "timing": {
                "repeat": {
                    "frequency": 1,
                    "period": 1,
                    "periodUnit": "d"
                }
            },
            "route": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "26643006",
                        "display": "oral"
                    }
                ]
            },
            "doseAndRate":  [
                {
                    "doseQuantity": {
                        "value": 10,
                        "unit": "milligram",
                        "system": "http://unitsofmeasure.org",
                        "code": "mg"
                    }
                }
            ]
        }
    ],
    "substitution": {
        "allowedBoolean": false
    }
}
MedicationRequest.id[0]4de51441-b8af-4362-a825-3efbba3a645b
MedicationRequest.meta[0].profile[0]https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest
MedicationRequest.contained[0].id[0]med1
MedicationRequest.contained[0].code[0].coding[0].system[0]https://dmd.nhs.uk
MedicationRequest.contained[0].code[0].coding[0].code[0]25673006
MedicationRequest.contained[0].code[0].coding[0].display[0]Omeprazole
MedicationRequest.contained[0].form[0].coding[0].system[0]http://snomed.info/sct
MedicationRequest.contained[0].form[0].coding[0].code[0]385052003
MedicationRequest.contained[0].form[0].coding[0].display[0]gastro-resistant capsule
MedicationRequest.status[0]active
MedicationRequest.intent[0]order
MedicationRequest.category[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/medicationrequest-category
MedicationRequest.category[0].coding[0].code[0]inpatient
MedicationRequest.category[0].coding[0].display[0]inpatient
MedicationRequest.priority[0]routine
MedicationRequest.medication[0].reference[0]#med1
MedicationRequest.subject[0].identifier[0].system[0]https://fhir.nhs.uk/Id/nhs-number
MedicationRequest.subject[0].identifier[0].value[0]9999999999
MedicationRequest.authoredOn[0]2020-05-15T15:00:00Z
MedicationRequest.requester[0].reference[0]urn:staff-1112
MedicationRequest.requester[0].display[0]Dr Maikeu Well
MedicationRequest.recorder[0].reference[0]urn:staff-1112
MedicationRequest.recorder[0].display[0]Dr Maikeu Well
MedicationRequest.dosageInstruction[0].text[0]10 milligram - daily - oral
MedicationRequest.dosageInstruction[0].timing[0].repeat[0].frequency[0]1
MedicationRequest.dosageInstruction[0].timing[0].repeat[0].period[0]1
MedicationRequest.dosageInstruction[0].timing[0].repeat[0].periodUnit[0]d
MedicationRequest.dosageInstruction[0].route[0].coding[0].system[0]http://snomed.info/sct
MedicationRequest.dosageInstruction[0].route[0].coding[0].code[0]26643006
MedicationRequest.dosageInstruction[0].route[0].coding[0].display[0]oral
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].value[0]10
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].unit[0]milligram
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].system[0]http://unitsofmeasure.org
MedicationRequest.dosageInstruction[0].doseAndRate[0].dose[0].code[0]mg
MedicationRequest.substitution[0].allowed[0]False
MedicationRequest

Example on-screen presentation:

Omeprazole
gastro-resistant capsule - 10 milligram - daily - oral
back to top