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.

Example #2: MedicationDispense

Note: This example below is a draft and requires clinical verification.

Actors

Provider System = Hospital pharmacy system

Consumer System = Outpatient EPMA system

Example

<!--    This xml example is for illustrative purposes only and has not been clinically verified.    -->
<Bundle xmlns="http://hl7.org/fhir">
    <id value="317590f8-ba1f-4583-a4e3-2c61cb2308a4" />
    <type value="message" />
    <timestamp value="2021-05-07T16:15:32Z" />
    <!--     Message Header     -->
    <entry>
        <fullUrl value="urn:message-header-167434" />
        <resource>
            <MessageHeader>
                <id value="urn:message-header-167434" />
                <eventCoding>
                    <system value="http://hl7.org/fhir/message-events" />
                    <code value="individual-requirements-1" />
                    <display value="Individual Requirements" />
                </eventCoding>
                <source>
                    <endpoint value="urn:nhs-uk:addressing:ods:T48NT" />
                </source>
                <focus>
                    <reference value="urn:medication-disp-1231253" />
                </focus>
            </MessageHeader>
        </resource>
    </entry>
    <!--   Patient associated with the encounter.   -->
    <entry>
        <fullUrl value="urn:patient-748395739" />
        <resource>
            <Patient>
                <id value="urn:patient-748395739" />
                <identifier>
                    <system value="https://fhir.nhs.uk/Id/nhs-number" />
                    <value value="748395739" />
                </identifier>
                <name>
                    <use value="official" />
                    <text value="Miss Carrie Oakey" />
                    <family value="Oakey" />
                    <given value="Carrie" />
                    <prefix value="Miss" />
                </name>
                <gender value="male" />
                <birthDate value="1977-06-04" />
            </Patient>
        </resource>
    </entry>
    <!--     Performer associated with the encounter.     -->
    <entry>
        <fullUrl value="urn:staff-0002" />
        <resource>
            <Practitioner>
                <id value="urn:staff-0002" />
                <name>
                    <text value="Dr Allo Kate" />
                    <family value="Kate" />
                    <given value="Allo" />
                    <prefix value="Dr" />
                </name>
                <qualification>
                    <code>
                        <coding>
                            <system value="https://fhir.hl7.org.uk/Id/gpc-number" />
                            <code value="123543" />
                            <display value="General Pharmaceutical Council" />
                        </coding>
                    </code>
                </qualification>
            </Practitioner>
        </resource>
    </entry>
    <!--   Medication   -->
    <entry>
        <fullUrl value="urn:medication-15053011000001100" />
        <resource>
            <Medication>
                <id value="urn:medication-15053011000001100" />
                <code>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="15053011000001100" />
                        <display value="Betamethasone valerate 0.1% cream (Sigma Pharmaceuticals Plc)" />
                    </coding>
                </code>
            </Medication>
        </resource>
    </entry>
    <!--     Medication Dispense     -->
    <entry>
        <fullUrl value="urn:medication-disp-1231253" />
        <resource>
            <MedicationDispense>
                <id value="urn:medication-disp-1231253" />
                <identifier>
                    <system value="urn:[organisation_name]:[system_name]" />
                    <value value="urn:2e9c6fe6-77ec-4da0-937a-ba97b5501b3f" />
                </identifier>
                <status value="in-progress" />
                <category>
                    <coding>
                        <system value="http://hl7.org/fhir/medication-request-category" />
                        <code value="outpatient" />
                        <display value="outpatient" />
                    </coding>
                </category>
                <medicationReference>
                    <reference value="urn:medication-15053011000001100" />
                    <display value="Betamethasone valerate 0.1% cream (Sigma Pharmaceuticals Plc)" />
                </medicationReference>
                <subject>
                    <reference value="urn:patient-748395739" />
                    <display value="Miss Carrie Oakey" />
                </subject>
                <performer>
                    <actor>
                        <reference value="urn:staff-0002" />
                        <display value="Dr Allo Kate" />
                    </actor>
                </performer>
                <authorizingPrescription>
                    <reference value="urn:med-req-342355475687898" />
                </authorizingPrescription>
                <quantity>
                    <value value="30" />
                    <unit value="gram" />
                    <system value="http://unitsofmeasure.org" />
                    <code value="g" />
                </quantity>
                <whenPrepared value="2021-05-07T16:15:32Z" />
                <dosageInstruction>
                    <timing>
                        <repeat>
                            <duration value="2" />
                            <durationUnit value="wk" />
                            <frequency value="2" />
                            <period value="1" />
                            <periodUnit value="d" />
                        </repeat>
                    </timing>
                    <method>
                        <coding>
                            <system value="http://snomed.info/sct" />
                            <code value="417924000" />
                            <display value="Apply" />
                        </coding>
                    </method>
                </dosageInstruction>
            </MedicationDispense>
        </resource>
    </entry>
</Bundle>

{
    "resourceType": "Bundle",
    "id": "317590f8-ba1f-4583-a4e3-2c61cb2308a4",
    "type": "message",
    "timestamp": "2021-05-07T16:15:32+00:00",
    "entry":  [
        {
            "fullUrl": "urn:message-header-167434",
            "resource": {
                "resourceType": "MessageHeader",
                "id": "urn:message-header-167434",
                "eventCoding": {
                    "system": "http://hl7.org/fhir/message-events",
                    "code": "individual-requirements-1",
                    "display": "Individual Requirements"
                },
                "source": {
                    "endpoint": "urn:nhs-uk:addressing:ods:T48NT"
                },
                "focus":  [
                    {
                        "reference": "urn:medication-disp-1231253"
                    }
                ]
            }
        },
        {
            "fullUrl": "urn:patient-748395739",
            "resource": {
                "resourceType": "Patient",
                "id": "urn:patient-748395739",
                "identifier":  [
                    {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "748395739"
                    }
                ],
                "name":  [
                    {
                        "use": "official",
                        "text": "Miss Carrie Oakey",
                        "family": "Oakey",
                        "given":  [
                            "Carrie"
                        ],
                        "prefix":  [
                            "Miss"
                        ]
                    }
                ],
                "gender": "male",
                "birthDate": "1977-06-04"
            }
        },
        {
            "fullUrl": "urn:staff-0002",
            "resource": {
                "resourceType": "Practitioner",
                "id": "urn:staff-0002",
                "name":  [
                    {
                        "text": "Dr Allo Kate",
                        "family": "Kate",
                        "given":  [
                            "Allo"
                        ],
                        "prefix":  [
                            "Dr"
                        ]
                    }
                ],
                "qualification":  [
                    {
                        "code": {
                            "coding":  [
                                {
                                    "system": "https://fhir.hl7.org.uk/Id/gpc-number",
                                    "code": "123543",
                                    "display": "General Pharmaceutical Council"
                                }
                            ]
                        }
                    }
                ]
            }
        },
        {
            "fullUrl": "urn:medication-15053011000001100",
            "resource": {
                "resourceType": "Medication",
                "id": "urn:medication-15053011000001100",
                "code": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "15053011000001100",
                            "display": "Betamethasone valerate 0.1% cream (Sigma Pharmaceuticals Plc)"
                        }
                    ]
                }
            }
        },
        {
            "fullUrl": "urn:medication-disp-1231253",
            "resource": {
                "resourceType": "MedicationDispense",
                "id": "urn:medication-disp-1231253",
                "identifier":  [
                    {
                        "system": "urn:[organisation_name]:[system_name]",
                        "value": "urn:2e9c6fe6-77ec-4da0-937a-ba97b5501b3f"
                    }
                ],
                "status": "in-progress",
                "category": {
                    "coding":  [
                        {
                            "system": "http://hl7.org/fhir/medication-request-category",
                            "code": "outpatient",
                            "display": "outpatient"
                        }
                    ]
                },
                "medicationReference": {
                    "reference": "urn:medication-15053011000001100",
                    "display": "Betamethasone valerate 0.1% cream (Sigma Pharmaceuticals Plc)"
                },
                "subject": {
                    "reference": "urn:patient-748395739",
                    "display": "Miss Carrie Oakey"
                },
                "performer":  [
                    {
                        "actor": {
                            "reference": "urn:staff-0002",
                            "display": "Dr Allo Kate"
                        }
                    }
                ],
                "authorizingPrescription":  [
                    {
                        "reference": "urn:med-req-342355475687898"
                    }
                ],
                "quantity": {
                    "value": 30,
                    "unit": "gram",
                    "system": "http://unitsofmeasure.org",
                    "code": "g"
                },
                "whenPrepared": "2021-05-07T16:15:32Z",
                "dosageInstruction":  [
                    {
                        "timing": {
                            "repeat": {
                                "duration": 2,
                                "durationUnit": "wk",
                                "frequency": 2,
                                "period": 1,
                                "periodUnit": "d"
                            }
                        },
                        "method": {
                            "coding":  [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "417924000",
                                    "display": "Apply"
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}
Bundle.id[0]317590f8-ba1f-4583-a4e3-2c61cb2308a4
Bundle.type[0]message
Bundle.timestamp[0]2021-05-07T16:15:32+00:00
Bundle.entry[0].fullUrl[0]urn:message-header-167434
Bundle.entry[0].resource[0].id[0]urn:message-header-167434
Bundle.entry[0].resource[0].event[0].system[0]http://hl7.org/fhir/message-events
Bundle.entry[0].resource[0].event[0].code[0]individual-requirements-1
Bundle.entry[0].resource[0].event[0].display[0]Individual Requirements
Bundle.entry[0].resource[0].source[0].endpoint[0]urn:nhs-uk:addressing:ods:T48NT
Bundle.entry[0].resource[0].focus[0].reference[0]urn:medication-disp-1231253
Bundle.entry[1].fullUrl[0]urn:patient-748395739
Bundle.entry[1].resource[0].id[0]urn:patient-748395739
Bundle.entry[1].resource[0].identifier[0].system[0]https://fhir.nhs.uk/Id/nhs-number
Bundle.entry[1].resource[0].identifier[0].value[0]748395739
Bundle.entry[1].resource[0].name[0].use[0]official
Bundle.entry[1].resource[0].name[0].text[0]Miss Carrie Oakey
Bundle.entry[1].resource[0].name[0].family[0]Oakey
Bundle.entry[1].resource[0].name[0].given[0]Carrie
Bundle.entry[1].resource[0].name[0].prefix[0]Miss
Bundle.entry[1].resource[0].gender[0]male
Bundle.entry[1].resource[0].birthDate[0]1977-06-04
Bundle.entry[2].fullUrl[0]urn:staff-0002
Bundle.entry[2].resource[0].id[0]urn:staff-0002
Bundle.entry[2].resource[0].name[0].text[0]Dr Allo Kate
Bundle.entry[2].resource[0].name[0].family[0]Kate
Bundle.entry[2].resource[0].name[0].given[0]Allo
Bundle.entry[2].resource[0].name[0].prefix[0]Dr
Bundle.entry[2].resource[0].qualification[0].code[0].coding[0].system[0]https://fhir.hl7.org.uk/Id/gpc-number
Bundle.entry[2].resource[0].qualification[0].code[0].coding[0].code[0]123543
Bundle.entry[2].resource[0].qualification[0].code[0].coding[0].display[0]General Pharmaceutical Council
Bundle.entry[3].fullUrl[0]urn:medication-15053011000001100
Bundle.entry[3].resource[0].id[0]urn:medication-15053011000001100
Bundle.entry[3].resource[0].code[0].coding[0].system[0]http://snomed.info/sct
Bundle.entry[3].resource[0].code[0].coding[0].code[0]15053011000001100
Bundle.entry[3].resource[0].code[0].coding[0].display[0]Betamethasone valerate 0.1% cream (Sigma Pharmaceuticals Plc)
Bundle.entry[4].fullUrl[0]urn:medication-disp-1231253
Bundle.entry[4].resource[0].id[0]urn:medication-disp-1231253
Bundle.entry[4].resource[0].identifier[0].system[0]urn:[organisation_name]:[system_name]
Bundle.entry[4].resource[0].identifier[0].value[0]urn:2e9c6fe6-77ec-4da0-937a-ba97b5501b3f
Bundle.entry[4].resource[0].status[0]in-progress
Bundle.entry[4].resource[0].category[0].coding[0].system[0]http://hl7.org/fhir/medication-request-category
Bundle.entry[4].resource[0].category[0].coding[0].code[0]outpatient
Bundle.entry[4].resource[0].category[0].coding[0].display[0]outpatient
Bundle.entry[4].resource[0].medication[0].reference[0]urn:medication-15053011000001100
Bundle.entry[4].resource[0].medication[0].display[0]Betamethasone valerate 0.1% cream (Sigma Pharmaceuticals Plc)
Bundle.entry[4].resource[0].subject[0].reference[0]urn:patient-748395739
Bundle.entry[4].resource[0].subject[0].display[0]Miss Carrie Oakey
Bundle.entry[4].resource[0].performer[0].actor[0].reference[0]urn:staff-0002
Bundle.entry[4].resource[0].performer[0].actor[0].display[0]Dr Allo Kate
Bundle.entry[4].resource[0].authorizingPrescription[0].reference[0]urn:med-req-342355475687898
Bundle.entry[4].resource[0].quantity[0].value[0]30
Bundle.entry[4].resource[0].quantity[0].unit[0]gram
Bundle.entry[4].resource[0].quantity[0].system[0]http://unitsofmeasure.org
Bundle.entry[4].resource[0].quantity[0].code[0]g
Bundle.entry[4].resource[0].whenPrepared[0]2021-05-07T16:15:32Z
Bundle.entry[4].resource[0].dosageInstruction[0].timing[0].repeat[0].duration[0]2
Bundle.entry[4].resource[0].dosageInstruction[0].timing[0].repeat[0].durationUnit[0]wk
Bundle.entry[4].resource[0].dosageInstruction[0].timing[0].repeat[0].frequency[0]2
Bundle.entry[4].resource[0].dosageInstruction[0].timing[0].repeat[0].period[0]1
Bundle.entry[4].resource[0].dosageInstruction[0].timing[0].repeat[0].periodUnit[0]d
Bundle.entry[4].resource[0].dosageInstruction[0].method[0].coding[0].system[0]http://snomed.info/sct
Bundle.entry[4].resource[0].dosageInstruction[0].method[0].coding[0].code[0]417924000
Bundle.entry[4].resource[0].dosageInstruction[0].method[0].coding[0].display[0]Apply
Bundle
back to top