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.

push notification

NHS App Patient push notification

{
    "resourceType": "CommunicationRequest",
    "id": "d4df7fed-adac-401e-86a3-9f80d115d2e4",
    "identifier":  [
        {
            "system": "https://fhir.nhs.uk/NHSApp/campaign-id",
            "value": "optional campaign id"
        },
        {
            "system": "https://fhir.nhs.uk/NHSApp/request-id",
            "value": "optional request reference"
        }
    ],
    "status": "active",
    "payload":  [
        {
            "contentReference": {
                "reference": "https://www.nhsapp.service.nhs.uk/patient/messages/app-messaging",
                "display": "You have a new message. The message may contain something important."
            }
        }
    ],
    "recipient":  [
        {
            "type": "Patient",
            "identifier": {
                "system": "https://fhir.nhs.uk/Id/nhs-number",
                "value": "9903002157"
            }
        }
    ],
    "requester": {
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RTD"
        },
        "display": "THE NEWCASTLE UPON TYNE HOSPITALS NHS FOUNDATION TRUST"
    }
}
<CommunicationRequest xmlns="http://hl7.org/fhir">
    <id value="d4df7fed-adac-401e-86a3-9f80d115d2e4" />
    <identifier>
        <system value="https://fhir.nhs.uk/NHSApp/campaign-id" />
        <value value="optional campaign id" />
    </identifier>
    <identifier>
        <system value="https://fhir.nhs.uk/NHSApp/request-id" />
        <value value="optional request reference" />
    </identifier>
    <status value="active" />
    <payload>
        <contentReference>
            <reference value="https://www.nhsapp.service.nhs.uk/patient/messages/app-messaging" />
            <display value="You have a new message. The message may contain something important." />
        </contentReference>
    </payload>
    <requester>
        <identifier>
            <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
            <value value="RTD" />
        </identifier>
        <display value="THE NEWCASTLE UPON TYNE HOSPITALS NHS FOUNDATION TRUST" />
    </requester>
    <recipient>
        <type value="Patient" />
        <identifier>
            <system value="https://fhir.nhs.uk/Id/nhs-number" />
            <value value="9903002157" />
        </identifier>
    </recipient>
</CommunicationRequest>
CommunicationRequest
back to top