NHS England FHIR Implementation Guide (deprecated)

Important Announcement regarding this Implementation Guide
  • As of 04/10/2023, this implementation guide has been deprecated and all development on the legacy NHS England FHIR Implementation Guide assets has ceased.
  • Therefore, vendors looking to start new implementations or looking to update existing implementations should use the new NHS England Implementation Guide. Vendors continuing to implement legacy NHS England FHIR Implementation Guide based solutions do so at their own risk and on the understanding that no maintenance or support will be available.

patient appointment

{
    "resourceType": "Bundle",
    "id": "8994e1bd-8147-4437-8b8a-2b1c21ec9207",
    "identifier": {
        "system": "https://tools.ietf.org/html/rfc4122",
        "value": "8994e1bd-8147-4437-8b8a-2b1c21ec9207"
    },
    "type": "message",
    "timestamp": "07/12/2018 10:30:16",
    "entry":  [
        {
            "fullUrl": "urn:uuid:ea7221b8-3cc0-4b11-bc95-585b056b5428",
            "resource": {
                "resourceType": "MessageHeader",
                "eventCoding": {
                    "system": "https://fhir.nhs.uk/CodeSystem/message-event",
                    "code": "appointment",
                    "display": "Appointment"
                },
                "destination":  [
                    {
                        "endpoint": "urn:nhs-uk:addressing:ods:GP0001",
                        "receiver": {
                            "identifier": {
                                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                                "value": "GP0001"
                            },
                            "display": "Cumbria Starling Medical Centre"
                        }
                    }
                ],
                "sender": {
                    "identifier": {
                        "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                        "value": "RBA"
                    }
                },
                "source": {
                    "endpoint": "urn:nhs-uk:addressing:ods:RR8"
                },
                "focus":  [
                    {
                        "reference": "urn:uuid:70c35c4a-65f4-4a03-bcf7-d1041ab999fd"
                    }
                ]
            }
        },
        {
            "fullUrl": "urn:uuid:70c35c4a-65f4-4a03-bcf7-d1041ab999fd",
            "resource": {
                "resourceType": "Appointment",
                "status": "booked",
                "specialty":  [
                    {
                        "coding":  [
                            {
                                "system": "https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty",
                                "code": "370",
                                "display": "Medical Oncology Service"
                            }
                        ]
                    }
                ],
                "description": "Reason for calling",
                "start": "01/17/2019 15:00:00",
                "end": "01/17/2019 15:10:00",
                "created": "01/17/2019 14:32:22",
                "participant":  [
                    {
                        "actor": {
                            "reference": "urn:uuid:90578a68-b711-4d05-885d-42fdc435b02a",
                            "type": "Patient",
                            "display": "Peter Chalmers"
                        },
                        "status": "needs-action"
                    },
                    {
                        "actor": {
                            "type": "Practitioner",
                            "identifier": {
                                "system": "https://fhir.hl7.org.uk/Id/gmc-number",
                                "value": "G1234567"
                            },
                            "display": "Dr Razia Ali"
                        },
                        "status": "accepted"
                    },
                    {
                        "actor": {
                            "type": "Location",
                            "identifier": {
                                "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                                "value": "RBA11"
                            },
                            "display": "MUSGROVE PARK HOSPITAL"
                        },
                        "status": "needs-action"
                    }
                ]
            }
        },
        {
            "fullUrl": "urn:uuid:90578a68-b711-4d05-885d-42fdc435b02a",
            "resource": {
                "resourceType": "Patient",
                "identifier":  [
                    {
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "9453740519"
                    }
                ],
                "name":  [
                    {
                        "use": "official",
                        "family": "CORY",
                        "given":  [
                            "ETTA"
                        ],
                        "prefix":  [
                            "MISS"
                        ]
                    }
                ],
                "gender": "female",
                "birthDate": "1999-01-04",
                "address":  [
                    {
                        "use": "home",
                        "line":  [
                            "123 Dale Avenue",
                            "Long Eaton",
                            "Nottingham"
                        ],
                        "postalCode": "NG10 1NP"
                    }
                ],
                "generalPractitioner":  [
                    {
                        "identifier": {
                            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                            "value": "B81001"
                        }
                    }
                ]
            }
        }
    ]
}
<Bundle xmlns="http://hl7.org/fhir">
    <id value="8994e1bd-8147-4437-8b8a-2b1c21ec9207" />
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="8994e1bd-8147-4437-8b8a-2b1c21ec9207" />
    </identifier>
    <type value="message" />
    <timestamp value="2018-07-12T10:30:16+00:00" />
    <entry>
        <fullUrl value="urn:uuid:ea7221b8-3cc0-4b11-bc95-585b056b5428" />
        <resource>
            <MessageHeader>
                <!--  MESH mailbox ID of message sender  -->
                <eventCoding>
                    <system value="https://fhir.nhs.uk/CodeSystem/message-event" />
                    <code value="appointment" />
                    <display value="Appointment" />
                </eventCoding>
                <destination>
                    <endpoint value="urn:nhs-uk:addressing:ods:GP0001" />
                    <receiver>
                        <identifier>
                            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                            <value value="GP0001" />
                        </identifier>
                        <display value="Cumbria Starling Medical Centre" />
                    </receiver>
                </destination>
                <sender>
                    <identifier>
                        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                        <value value="RBA" />
                    </identifier>
                </sender>
                <source>
                    <endpoint value="urn:nhs-uk:addressing:ods:RR8" />
                </source>
                <focus>
                    <reference value="urn:uuid:70c35c4a-65f4-4a03-bcf7-d1041ab999fd" />
                </focus>
            </MessageHeader>
        </resource>
    </entry>
    <entry>
        <fullUrl value="urn:uuid:70c35c4a-65f4-4a03-bcf7-d1041ab999fd" />
        <resource>
            <Appointment>
                <status value="booked" />
                <specialty>
                    <coding>
                        <system value="https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty" />
                        <code value="370" />
                        <display value="Medical Oncology Service" />
                    </coding>
                </specialty>
                <description value="Reason for calling" />
                <start value="2019-01-17T15:00:00.000Z" />
                <end value="2019-01-17T15:10:00.000Z" />
                <created value="2019-01-17T14:32:22.579+00:00" />
                <participant>
                    <actor>
                        <reference value="urn:uuid:90578a68-b711-4d05-885d-42fdc435b02a" />
                        <type value="Patient" />
                        <display value="Peter Chalmers" />
                    </actor>
                    <status value="needs-action" />
                </participant>
                <participant>
                    <actor>
                        <type value="Practitioner" />
                        <identifier>
                            <system value="https://fhir.hl7.org.uk/Id/gmc-number" />
                            <value value="G1234567" />
                        </identifier>
                        <display value="Dr Razia Ali" />
                    </actor>
                    <status value="accepted" />
                </participant>
                <participant>
                    <actor>
                        <type value="Location" />
                        <identifier>
                            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                            <value value="RBA11" />
                        </identifier>
                        <display value="MUSGROVE PARK HOSPITAL" />
                    </actor>
                    <status value="needs-action" />
                </participant>
            </Appointment>
        </resource>
    </entry>
    <entry>
        <fullUrl value="urn:uuid:90578a68-b711-4d05-885d-42fdc435b02a" />
        <resource>
            <Patient>
                <identifier>
                    <system value="https://fhir.nhs.uk/Id/nhs-number" />
                    <value value="9453740519" />
                </identifier>
                <name>
                    <use value="official" />
                    <family value="CORY" />
                    <given value="ETTA" />
                    <prefix value="MISS" />
                </name>
                <gender value="female" />
                <birthDate value="1999-01-04" />
                <address>
                    <use value="home" />
                    <line value="123 Dale Avenue" />
                    <line value="Long Eaton" />
                    <line value="Nottingham" />
                    <postalCode value="NG10 1NP" />
                </address>
                <generalPractitioner>
                    <identifier>
                        <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                        <value value="B81001" />
                    </identifier>
                </generalPractitioner>
            </Patient>
        </resource>
    </entry>
</Bundle>
Bundle
back to top