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.

CommunicationRequest

in-app message

NHS App Patient in-app message

{
"resourceType": "CommunicationRequest",
"id": "941f9751-aa2a-4749-88c1-201266f7b538",
"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": [
{
"contentString": "You have a new appointment, please confirm you can attend. Open the Onboarded Third Party appointment [here](https://www.nhsapp.service.nhs.uk/appointments/hospital-appointments)"
}
],
"sender": {
"display": "Onboarded Third Party"
},
"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="941f9751-aa2a-4749-88c1-201266f7b538" />
<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>
<contentString value="You have a new appointment, please confirm you can attend. Open the Onboarded Third Party appointment [here](https://www.nhsapp.service.nhs.uk/appointments/hospital-appointments)" />
</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>
<sender>
<display value="Onboarded Third Party" />
</sender>
</CommunicationRequest>
CommunicationRequest

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

EPS Notification

EPS Patient notification
{
"resourceType": "CommunicationRequest",
"id": "270de8ea-1fcc-4c0d-9928-f46248c66abb",
"status": "active",
"subject": {
"reference": "urn:uuid:848d8470-bd51-494e-9347-8142ea75cb23"
},
"payload": [
{
"contentString": "Please make an appointment to see your GP. Review date due"
},
{
"contentReference": {
"reference": "urn:uuid:d0f003a0-8763-43d5-a264-ce52a38901c9",
"display": "List of Repeat Medications for re-ordering"
}
}
],
"requester": {
"type": "Organization",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RBA"
},
"display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST"
},
"recipient": [
{
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9453740519"
}
}
]
}
<CommunicationRequest xmlns="http://hl7.org/fhir">
<id value="270de8ea-1fcc-4c0d-9928-f46248c66abb" />
<status value="active" />
<subject>
<reference value="urn:uuid:848d8470-bd51-494e-9347-8142ea75cb23" />
</subject>
<payload>
<contentString value="Please make an appointment to see your GP. Review date due" />
</payload>
<payload>
<contentReference>
<reference value="urn:uuid:d0f003a0-8763-43d5-a264-ce52a38901c9" />
<display value="List of Repeat Medications for re-ordering" />
</contentReference>
</payload>
<requester>
<type value="Organization" />
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="RBA" />
</identifier>
<display value="TAUNTON AND SOMERSET NHS FOUNDATION TRUST" />
</requester>
<recipient>
<type value="Patient" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9453740519" />
</identifier>
</recipient>
</CommunicationRequest>
CommunicationRequest

EPS Medication Dispatch

{
"resourceType": "CommunicationRequest",
"id": "7dd3a8e2-bc45-4676-9582-7208febd5bc0",
"status": "active",
"subject": {
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9876543210"
},
"display": "Miss Bernie Kanfeld"
},
"payload": [
{
"contentString": "Your medication Paracetamol 500mg soluble tablets (Alliance Healthcare (Distribution) Ltd) 60 tablet has been dispatched."
},
{
"contentReference": {
"reference": "https://int.api.service.nhs.uk/electronic-prescriptions/MedicationDispense/fd833d33-f128-4fa2-a807-1fc8a7db2658",
"identifier": {
"system": "https://fhir.nhs.uk/Id/prescription-dispense-item-number",
"value": "fd833d33-f128-4fa2-a807-1fc8a7db2658"
}
}
}
],
"requester": {
"type": "Organization",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "VNE51"
},
"display": "The simple pharmacy"
},
"recipient": [
{
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9876543210"
},
"display": "Miss Bernie Kanfeld"
}
],
"reasonCode": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/message-event",
"code": "dispense-notification",
"display": "Dispense Notification"
}
]
}
]
}
<CommunicationRequest xmlns="http://hl7.org/fhir">
<id value="7dd3a8e2-bc45-4676-9582-7208febd5bc0" />
<status value="active" />
<subject>
<type value="Patient" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9876543210" />
</identifier>
<display value="Miss Bernie Kanfeld" />
</subject>
<payload>
<contentString value="Your medication Paracetamol 500mg soluble tablets (Alliance Healthcare (Distribution) Ltd) 60 tablet has been dispatched." />
</payload>
<payload>
<contentReference>
<reference value="https://int.api.service.nhs.uk/electronic-prescriptions/MedicationDispense/fd833d33-f128-4fa2-a807-1fc8a7db2658" />
<identifier>
<system value="https://fhir.nhs.uk/Id/prescription-dispense-item-number" />
<value value="fd833d33-f128-4fa2-a807-1fc8a7db2658" />
</identifier>
</contentReference>
</payload>
<requester>
<type value="Organization" />
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="VNE51" />
</identifier>
<display value="The simple pharmacy" />
</requester>
<recipient>
<type value="Patient" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9876543210" />
</identifier>
<display value="Miss Bernie Kanfeld" />
</recipient>
<reasonCode>
<coding>
<system value="https://fhir.nhs.uk/CodeSystem/message-event" />
<code value="dispense-notification" />
<display value="Dispense Notification" />
</coding>
</reasonCode>
</CommunicationRequest>
CommunicationRequest

EPS Prescription Cancel

{
"resourceType": "CommunicationRequest",
"id": "4bd6f1a8-a5aa-4d3b-833b-f0dae3222025",
"status": "active",
"subject": {
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9453740519"
}
},
"payload": [
{
"contentString": "Prescription for Methotrexate 10mg/0.2ml solution for injection pre-filled syringes (13 July 2020) has been cancelled"
},
{
"contentReference": {
"reference": "https://int.api.service.nhs.uk/electronic-prescriptions/MedicationRequest/a54219b8-f741-4c47-b662-e4f8dfa49ab6",
"identifier": {
"system": "https://fhir.nhs.uk/Id/prescription-order-item-number",
"value": "a54219b8-f741-4c47-b662-e4f8dfa49ab6"
}
}
}
],
"requester": {
"type": "Organization",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "X2601"
},
"display": "NHS Digital Spine"
},
"recipient": [
{
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9453740519"
}
},
{
"type": "Organization",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "A99968"
}
}
],
"reasonCode": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/message-event",
"code": "prescription-order-response",
"display": "Prescription Order Response"
}
]
}
]
}
<CommunicationRequest xmlns="http://hl7.org/fhir">
<id value="4bd6f1a8-a5aa-4d3b-833b-f0dae3222025" />
<status value="active" />
<subject>
<type value="Patient" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9453740519" />
</identifier>
</subject>
<payload>
<contentString value="Prescription for Methotrexate 10mg/0.2ml solution for injection pre-filled syringes (13 July 2020) has been cancelled" />
</payload>
<payload>
<contentReference>
<reference value="https://int.api.service.nhs.uk/electronic-prescriptions/MedicationRequest/a54219b8-f741-4c47-b662-e4f8dfa49ab6" />
<identifier>
<system value="https://fhir.nhs.uk/Id/prescription-order-item-number" />
<value value="a54219b8-f741-4c47-b662-e4f8dfa49ab6" />
</identifier>
</contentReference>
</payload>
<requester>
<type value="Organization" />
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="X2601" />
</identifier>
<display value="NHS Digital Spine" />
</requester>
<recipient>
<type value="Patient" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9453740519" />
</identifier>
</recipient>
<recipient>
<type value="Organization" />
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="A99968" />
</identifier>
</recipient>
<reasonCode>
<coding>
<system value="https://fhir.nhs.uk/CodeSystem/message-event" />
<code value="prescription-order-response" />
<display value="Prescription Order Response" />
</coding>
</reasonCode>
</CommunicationRequest>
CommunicationRequest
back to top