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 #1: MedicationRequest

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

Actors

Provider System = Outpatient EPMA system

Consumer System = Hospital pharmacy system

Example

<!--  This xml example is for illustrative purposes only and has not been clinically verified.  -->
<Bundle xmlns="http://hl7.org/fhir">
    <id value="8b79e3a6-bff4-44c1-8924-63786afd6412" />
    <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="https://fhir.hl7.org.uk//CodeSystem/message-event" />
                    <code value="prescription-order" />
                    <display value="Prescription Order" />
                </eventCoding>
                <source>
                    <name value="ACME Clinical Systems" />
                    <software value="ACME ePMA" />
                    <version value="3.5.68" />
                    <endpoint value="urn:nhs-uk:addressing:ods:T48NT" />
                </source>
                <focus>
                    <reference value="urn:med-req-56745612" />
                </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>
    <!--  Prescribing clinician associated with the encounter.   -->
    <entry>
        <fullUrl value="urn:staff-0001" />
        <resource>
            <Practitioner>
                <id value="urn:staff-0001" />
                <name>
                    <text value="Dr Justin Thyme" />
                    <family value="Thyme" />
                    <given value="Justin" />
                    <prefix value="Dr" />
                </name>
                <qualification>
                    <code>
                        <coding>
                            <system value="https://fhir.hl7.org.uk/Id/gmc-number" />
                            <code value="2145879" />
                            <display value="General Medical Council" />
                        </coding>
                    </code>
                </qualification>
            </Practitioner>
        </resource>
    </entry>
    <!--  Medication   -->
    <entry>
        <fullUrl value="urn:medication-374372000" />
        <resource>
            <Medication>
                <id value="urn:medication-374372000" />
                <code>
                    <coding>
                        <system value="http://snomed.info/sct" />
                        <code value="374372000" />
                        <display value="Betamethasone valerate 0.1% cream" />
                    </coding>
                </code>
            </Medication>
        </resource>
    </entry>
    <!--   Medication Request   -->
    <entry>
        <fullUrl value="urn:med-req-56745612" />
        <resource>
            <MedicationRequest>
                <id value="urn:med-req-56745612" />
                <status value="active" />
                <intent value="order" />
                <category>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/medicationrequest-category" />
                        <code value="outpatient" />
                        <display value="outpatient" />
                    </coding>
                </category>
                <priority value="routine" />
                <medicationReference>
                    <reference value="urn:medication-374372000" />
                    <display value="Betamethasone valerate 0.1% cream" />
                </medicationReference>
                <subject>
                    <reference value="urn:patient-748395739" />
                    <display value="Miss Carrie Oakey" />
                </subject>
                <authoredOn value="2020-05-20T10:51:00Z" />
                <requester>
                    <reference value="urn:staff-0001" />
                    <display value="Dr Justin Thyme" />
                </requester>
                <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>
                <substitution>
                    <allowedBoolean value="false" />
                </substitution>
            </MedicationRequest>
        </resource>
    </entry>
</Bundle>

{
    "resourceType": "Bundle",
    "id": "8b79e3a6-bff4-44c1-8924-63786afd6412",
    "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": "https://fhir.hl7.org.uk//CodeSystem/message-event",
                    "code": "prescription-order",
                    "display": "Prescription Order"
                },
                "source": {
                    "name": "ACME Clinical Systems",
                    "software": "ACME ePMA",
                    "version": "3.5.68",
                    "endpoint": "urn:nhs-uk:addressing:ods:T48NT"
                },
                "focus":  [
                    {
                        "reference": "urn:med-req-56745612"
                    }
                ]
            }
        },
        {
            "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-0001",
            "resource": {
                "resourceType": "Practitioner",
                "id": "urn:staff-0001",
                "name":  [
                    {
                        "text": "Dr Justin Thyme",
                        "family": "Thyme",
                        "given":  [
                            "Justin"
                        ],
                        "prefix":  [
                            "Dr"
                        ]
                    }
                ],
                "qualification":  [
                    {
                        "code": {
                            "coding":  [
                                {
                                    "system": "https://fhir.hl7.org.uk/Id/gmc-number",
                                    "code": "2145879",
                                    "display": "General Medical Council"
                                }
                            ]
                        }
                    }
                ]
            }
        },
        {
            "fullUrl": "urn:medication-374372000",
            "resource": {
                "resourceType": "Medication",
                "id": "urn:medication-374372000",
                "code": {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "374372000",
                            "display": "Betamethasone valerate 0.1% cream"
                        }
                    ]
                }
            }
        },
        {
            "fullUrl": "urn:med-req-56745612",
            "resource": {
                "resourceType": "MedicationRequest",
                "id": "urn:med-req-56745612",
                "status": "active",
                "intent": "order",
                "category":  [
                    {
                        "coding":  [
                            {
                                "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
                                "code": "outpatient",
                                "display": "outpatient"
                            }
                        ]
                    }
                ],
                "priority": "routine",
                "medicationReference": {
                    "reference": "urn:medication-374372000",
                    "display": "Betamethasone valerate 0.1% cream"
                },
                "subject": {
                    "reference": "urn:patient-748395739",
                    "display": "Miss Carrie Oakey"
                },
                "authoredOn": "2020-05-20T10:51:00Z",
                "requester": {
                    "reference": "urn:staff-0001",
                    "display": "Dr Justin Thyme"
                },
                "dosageInstruction":  [
                    {
                        "timing": {
                            "repeat": {
                                "duration": 2,
                                "durationUnit": "wk",
                                "frequency": 2,
                                "period": 1,
                                "periodUnit": "d"
                            }
                        },
                        "method": {
                            "coding":  [
                                {
                                    "system": "http://snomed.info/sct",
                                    "code": "417924000",
                                    "display": "Apply"
                                }
                            ]
                        }
                    }
                ],
                "substitution": {
                    "allowedBoolean": false
                }
            }
        }
    ]
}
Bundle.id[0]8b79e3a6-bff4-44c1-8924-63786afd6412
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]https://fhir.hl7.org.uk//CodeSystem/message-event
Bundle.entry[0].resource[0].event[0].code[0]prescription-order
Bundle.entry[0].resource[0].event[0].display[0]Prescription Order
Bundle.entry[0].resource[0].source[0].name[0]ACME Clinical Systems
Bundle.entry[0].resource[0].source[0].software[0]ACME ePMA
Bundle.entry[0].resource[0].source[0].version[0]3.5.68
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:med-req-56745612
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-0001
Bundle.entry[2].resource[0].id[0]urn:staff-0001
Bundle.entry[2].resource[0].name[0].text[0]Dr Justin Thyme
Bundle.entry[2].resource[0].name[0].family[0]Thyme
Bundle.entry[2].resource[0].name[0].given[0]Justin
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/gmc-number
Bundle.entry[2].resource[0].qualification[0].code[0].coding[0].code[0]2145879
Bundle.entry[2].resource[0].qualification[0].code[0].coding[0].display[0]General Medical Council
Bundle.entry[3].fullUrl[0]urn:medication-374372000
Bundle.entry[3].resource[0].id[0]urn:medication-374372000
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]374372000
Bundle.entry[3].resource[0].code[0].coding[0].display[0]Betamethasone valerate 0.1% cream
Bundle.entry[4].fullUrl[0]urn:med-req-56745612
Bundle.entry[4].resource[0].id[0]urn:med-req-56745612
Bundle.entry[4].resource[0].status[0]active
Bundle.entry[4].resource[0].intent[0]order
Bundle.entry[4].resource[0].category[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/medicationrequest-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].priority[0]routine
Bundle.entry[4].resource[0].medication[0].reference[0]urn:medication-374372000
Bundle.entry[4].resource[0].medication[0].display[0]Betamethasone valerate 0.1% cream
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].authoredOn[0]2020-05-20T10:51:00Z
Bundle.entry[4].resource[0].requester[0].reference[0]urn:staff-0001
Bundle.entry[4].resource[0].requester[0].display[0]Dr Justin Thyme
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.entry[4].resource[0].substitution[0].allowed[0]False
Bundle
back to top