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.

Task

Task - Form Complete

{
"resourceType": "Task",
"id": "06570d9e-1dd7-49b6-8276-c903eef74b73",
"identifier": [
{
"system": "https://tools.ietf.org/html/rfc4122",
"value": "06570d9e-1dd7-49b6-8276-c903eef74b73"
}
],
"status": "requested",
"intent": "order",
"code": {
"coding": [
{
"system": "http://hl7.org/fhir/CodeSystem/task-code",
"code": "fulfill",
"display": "Fulfill the focal request"
}
]
},
"focus": {
"reference": "https://example.fhir.nhs.uk/Questionnaire/Simple-Blood-Pressure"
},
"for": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9876543210"
}
},
"owner": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "FE048"
}
},
"requester": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RR8"
},
"display": "LEEDS TEACHING HOSPITALS NHS TRUST"
},
"authoredOn": "2023-02-22T12:00:00+00:00",
"note": [
{
"text": "Please perfrom this health check on this patient."
}
],
"reasonCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "275944005",
"display": "Hypertension monitoring"
}
],
"text": "Code is for demonstration purposes and is probably not correct"
}
}
<Task xmlns="http://hl7.org/fhir">
<id value="06570d9e-1dd7-49b6-8276-c903eef74b73" />
<identifier>
<system value="https://tools.ietf.org/html/rfc4122" />
<value value="06570d9e-1dd7-49b6-8276-c903eef74b73" />
</identifier>
<status value="requested" />
<intent value="order" />
<code>
<coding>
<system value="http://hl7.org/fhir/CodeSystem/task-code" />
<code value="fulfill" />
<display value="Fulfill the focal request" />
</coding>
</code>
<focus>
<reference value="https://example.fhir.nhs.uk/Questionnaire/Simple-Blood-Pressure" />
</focus>
<for>
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9876543210" />
</identifier>
</for>
<authoredOn value="2023-02-22T12:00:00+00:00" />
<requester>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="RR8" />
</identifier>
<display value="LEEDS TEACHING HOSPITALS NHS TRUST" />
</requester>
<owner>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="FE048" />
</identifier>
</owner>
<reasonCode>
<coding>
<system value="http://snomed.info/sct" />
<code value="275944005" />
<display value="Hypertension monitoring" />
</coding>
<text value="Code is for demonstration purposes and is probably not correct" />
</reasonCode>
<note>
<text value="Please perfrom this health check on this patient." />
</note>
</Task>
Task

Task - Fulfil Patient Referral

{
"resourceType": "Task",
"id": "f9ba86b1-2c3d-441f-840f-324396128771",
"contained": [
{
"resourceType": "PractitionerRole",
"id": "requester",
"practitioner": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/sds-user-id",
"value": "0987654321"
}
},
"organization": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RR8"
},
"display": "LEEDS TEACHING HOSPITALS NHS TRUST"
}
}
],
"status": "requested",
"intent": "order",
"identifier": [
{
"system": "https://tools.ietf.org/html/rfc4122",
"value": "f9ba86b1-2c3d-441f-840f-324396128771"
}
],
"code": {
"coding": [
{
"system": "http://hl7.org/fhir/CodeSystem/task-code",
"code": "fulfill",
"display": "Fulfill the focal request"
}
]
},
"focus": {
"reference": "https://api.ers-service.nhs.uk/FHIR/R4/ServiceRequest/dafb61c6-7042-40aa-a72d-843f1936b573",
"identifier": {
"system": "https://fhir.nhs.uk/Id/UBRN",
"value": "000000070000"
}
},
"for": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9446368138"
}
},
"owner": {
"reference": "https://directory.spineservices.nhs.uk/R4/Organization/RR8",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RR8"
}
},
"requester": {
"reference": "#requester"
},
"authoredOn": "2021-10-09T12:00:00+00:00",
"reasonCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "306185001",
"display": "Referral to cardiac surgery service"
}
]
}
}
<Task xmlns="http://hl7.org/fhir">
<id value="f9ba86b1-2c3d-441f-840f-324396128771" />
<contained>
<PractitionerRole>
<id value="requester" />
<practitioner>
<identifier>
<system value="https://fhir.nhs.uk/Id/sds-user-id" />
<value value="0987654321" />
</identifier>
</practitioner>
<organization>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="RR8" />
</identifier>
<display value="LEEDS TEACHING HOSPITALS NHS TRUST" />
</organization>
</PractitionerRole>
</contained>
<identifier>
<system value="https://tools.ietf.org/html/rfc4122" />
<value value="f9ba86b1-2c3d-441f-840f-324396128771" />
</identifier>
<status value="requested" />
<intent value="order" />
<code>
<coding>
<system value="http://hl7.org/fhir/CodeSystem/task-code" />
<code value="fulfill" />
<display value="Fulfill the focal request" />
</coding>
</code>
<focus>
<reference value="https://api.ers-service.nhs.uk/FHIR/R4/ServiceRequest/dafb61c6-7042-40aa-a72d-843f1936b573" />
<identifier>
<system value="https://fhir.nhs.uk/Id/UBRN" />
<value value="000000070000" />
</identifier>
</focus>
<for>
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9446368138" />
</identifier>
</for>
<authoredOn value="2021-10-09T12:00:00+00:00" />
<requester>
<reference value="#requester" />
</requester>
<owner>
<reference value="https://directory.spineservices.nhs.uk/R4/Organization/RR8" />
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="RR8" />
</identifier>
</owner>
<reasonCode>
<coding>
<system value="http://snomed.info/sct" />
<code value="306185001" />
<display value="Referral to cardiac surgery service" />
</coding>
</reasonCode>
</Task>
Task

Task - Validate Referral

A referral (FHIR ServiceRequest) needs checking before it is sent to a service provider.

{
"resourceType": "Task",
"id": "9f7d3feb-5442-4df7-83ef-7afd2e99f0e5",
"status": "requested",
"intent": "order",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "386053000",
"display": "Evaluation procedure"
}
]
},
"focus": {
"reference": "https://server.fire.ly/ServiceRequest/eb13327f-e990-4667-b37a-89eb93a94c47"
},
"for": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
},
"owner": {
"identifier": {
"system": "http://fhir.nhs.net/Id/ers-service",
"value": "11002"
}
},
"restriction": {
"period": {
"end": "2022-01-25T16:40:00+00:00"
}
},
"meta": {
"versionId": "3c1f41e5-6454-48bc-bc01-2059d2e29413",
"lastUpdated": "2022-03-10T13:33:21.603+00:00"
}
}
<Task xmlns="http://hl7.org/fhir">
<id value="9f7d3feb-5442-4df7-83ef-7afd2e99f0e5" />
<meta>
<versionId value="3c1f41e5-6454-48bc-bc01-2059d2e29413" />
<lastUpdated value="2022-03-10T13:33:21.603+00:00" />
</meta>
<status value="requested" />
<intent value="order" />
<code>
<coding>
<system value="http://snomed.info/sct" />
<code value="386053000" />
<display value="Evaluation procedure" />
</coding>
</code>
<focus>
<reference value="https://server.fire.ly/ServiceRequest/eb13327f-e990-4667-b37a-89eb93a94c47" />
</focus>
<for>
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9912003888" />
</identifier>
</for>
<owner>
<identifier>
<system value="http://fhir.nhs.net/Id/ers-service" />
<value value="11002" />
</identifier>
</owner>
<restriction>
<period>
<end value="2022-01-25T16:40:00+00:00" />
</period>
</restriction>
</Task>
Task

Task - Review LabReport

A laboratory report (FHIR DiagnosticReport) needs acknowledging and reviewing. This is a FHIR R4 uplift of University Hospital Southampton - Tests Results Acknowledgement

{
"resourceType": "Task",
"id": "31aa8607-1262-4c73-a34b-08dafb845aa7",
"contained": [
{
"resourceType": "PractitionerRole",
"id": "requester",
"practitioner": {
"identifier": {
"system": "https://fhir.hl7.org.uk/Id/gmc-number",
"value": "C9999998"
},
"display": "Dr A N OTHER"
},
"organization": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RHM"
},
"display": "UNIVERSITY HOSPITAL SOUTHAMPTON NHS FOUNDATION TRUST"
}
}
],
"status": "requested",
"intent": "order",
"identifier": [
{
"system": "https://tools.ietf.org/html/rfc4122",
"value": "31aa8607-1262-4c73-a34b-08dafb845aa7"
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "324861000000109",
"display": "Review of patient laboratory test report"
}
]
},
"focus": {
"reference": "https://fhir.uhs.nhs.uk/FHIR/DiagnosticReport/af155342-c16b-483c-a98d-12a271417152"
},
"for": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9446368138"
}
},
"requester": {
"reference": "#requester"
},
"authoredOn": "2022-04-16T12:00:00+00:00"
}
<Task xmlns="http://hl7.org/fhir">
<id value="31aa8607-1262-4c73-a34b-08dafb845aa7" />
<contained>
<PractitionerRole>
<id value="requester" />
<practitioner>
<identifier>
<system value="https://fhir.hl7.org.uk/Id/gmc-number" />
<value value="C9999998" />
</identifier>
<display value="Dr A N OTHER" />
</practitioner>
<organization>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="RHM" />
</identifier>
<display value="UNIVERSITY HOSPITAL SOUTHAMPTON NHS FOUNDATION TRUST" />
</organization>
</PractitionerRole>
</contained>
<identifier>
<system value="https://tools.ietf.org/html/rfc4122" />
<value value="31aa8607-1262-4c73-a34b-08dafb845aa7" />
</identifier>
<status value="requested" />
<intent value="order" />
<code>
<coding>
<system value="http://snomed.info/sct" />
<code value="324861000000109" />
<display value="Review of patient laboratory test report" />
</coding>
</code>
<focus>
<reference value="https://fhir.uhs.nhs.uk/FHIR/DiagnosticReport/af155342-c16b-483c-a98d-12a271417152" />
</focus>
<for>
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9446368138" />
</identifier>
</for>
<authoredOn value="2022-04-16T12:00:00+00:00" />
<requester>
<reference value="#requester" />
</requester>
</Task>
Task

Task - Check Prescription

A workflow process for a prescription order to be clinically checked
{
"resourceType": "Task",
"id": "ac990628-a2be-4213-9b03-f0ae83c70099",
"contained": [
{
"resourceType": "PractitionerRole",
"id": "requester",
"practitioner": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/sds-user-id",
"value": "2238910010"
},
"display": "Dr Liz Scott"
},
"organization": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RBA"
},
"display": "The Acute Trust"
},
"telecom": [
{
"system": "phone",
"use": "work",
"value": "01234567890"
}
]
}
],
"identifier": [
{
"system": "https://tools.ietf.org/html/rfc4122",
"value": "ac990628-a2be-4213-9b03-f0ae83c70099"
}
],
"status": "requested",
"intent": "order",
"groupIdentifier": {
"system": "https://fhir.nhs.uk/Id/prescription-order-number",
"value": "83C40E-B81001-00123C"
},
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "299441000000105",
"display": "Checking prescription"
}
]
},
"focus": {
"reference": "MedicationRequest/ee86a018-779c-4809-999f-a9d89cdfd30f"
},
"for": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9453740519"
},
"display": "MISS ETTA CORY"
},
"authoredOn": "2022-04-15T12:00:00+00:00",
"requester": {
"reference": "#requester"
},
"note": [
{
"text": "Can you check this prescription?"
}
]
}
<Task xmlns="http://hl7.org/fhir">
<id value="ac990628-a2be-4213-9b03-f0ae83c70099" />
<contained>
<PractitionerRole>
<id value="requester" />
<practitioner>
<identifier>
<system value="https://fhir.nhs.uk/Id/sds-user-id" />
<value value="2238910010" />
</identifier>
<display value="Dr Liz Scott" />
</practitioner>
<organization>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="RBA" />
</identifier>
<display value="The Acute Trust" />
</organization>
<telecom>
<system value="phone" />
<value value="01234567890" />
<use value="work" />
</telecom>
</PractitionerRole>
</contained>
<identifier>
<system value="https://tools.ietf.org/html/rfc4122" />
<value value="ac990628-a2be-4213-9b03-f0ae83c70099" />
</identifier>
<groupIdentifier>
<system value="https://fhir.nhs.uk/Id/prescription-order-number" />
<value value="83C40E-B81001-00123C" />
</groupIdentifier>
<status value="requested" />
<intent value="order" />
<code>
<coding>
<system value="http://snomed.info/sct" />
<code value="299441000000105" />
<display value="Checking prescription" />
</coding>
</code>
<focus>
<reference value="MedicationRequest/ee86a018-779c-4809-999f-a9d89cdfd30f" />
</focus>
<for>
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9453740519" />
</identifier>
<display value="MISS ETTA CORY" />
</for>
<authoredOn value="2022-04-15T12:00:00+00:00" />
<requester>
<reference value="#requester" />
</requester>
<note>
<text value="Can you check this prescription?" />
</note>
</Task>
Task
back to top