Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
Examples
DOS-Bundle-SearchResults-Example
Example of a Bundle Searchset Results.
| Bundle |
| id : DOS-Bundle-SearchResults-Example |
| meta |
| versionId : 0.1.0 |
| lastUpdated : 2024-07-16T15:01:30.8185338+00:00 |
| type : searchset |
| timestamp : 2024-07-16T12:15:10+00:00 |
| total : 8 |
| link |
| relation : self |
| url : https://simplifier.net/nhsbookingandreferrals/777a156c-af3c-4748-a8a3-7e95e4b0df9a-duplicate-2 |
| entry |
| fullUrl : http://example.org/fhir/Slot/RR8-SJUH-TAUTO-001 |
| resource |
| id : RR8-SJUH-TAUTO-001 |
| meta |
| lastUpdated : 2024-07-16T15:01:30.8185338+00:00 |
| extension |
| url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel |
| value |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-DeliveryChannel |
| code : Telephone |
| display : Telephone |
| serviceCategory |
| coding |
| system : http://terminology.hl7.org/CodeSystem/service-category |
| code : 14 |
| display : Emergency Department |
| schedule |
| reference : Schedule/DoS-Schedule-RR8-LEEDSSJUH-Example |
| status : free |
| start : 2024-07-22T09:00:00+00:00 |
| end : 2024-07-22T10:00:00+00:00 |
| search |
| mode : include |
| entry |
| fullUrl : http://example.org/fhir/Slot/RR8-SJUH-TAUTO-002 |
| resource |
| id : RR8-SJUH-TAUTO-002 |
| meta |
| lastUpdated : 2024-07-16T15:01:30.8185338+00:00 |
| extension |
| url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel |
| value |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-DeliveryChannel |
| code : Telephone |
| display : Telephone |
| serviceCategory |
| coding |
| system : http://terminology.hl7.org/CodeSystem/service-category |
| code : 14 |
| display : Emergency Department |
| schedule |
| reference : Schedule/DoS-Schedule-RR8-LEEDSSJUH-Example |
| status : free |
| start : 2024-07-22T10:00:00+00:00 |
| end : 2024-07-22T10:30:00+00:00 |
| search |
| mode : include |
| entry |
| fullUrl : http://example.org/fhir/Slot/RR8-SJUH-TAUTO-003 |
| resource |
| id : RR8-SJUH-TAUTO-003 |
| meta |
| lastUpdated : 2024-07-16T15:01:30.8185338+00:00 |
| extension |
| url : https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel |
| value |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-DeliveryChannel |
| code : Telephone |
| display : Telephone |
| serviceCategory |
| coding |
| system : http://terminology.hl7.org/CodeSystem/service-category |
| code : 14 |
| display : Emergency Department |
| schedule |
| reference : Schedule/DoS-Schedule-RR8-LEEDSSJUH-Example |
| status : free |
| start : 2024-07-22T11:00:00+00:00 |
| end : 2024-07-22T11:30:00+00:00 |
| search |
| mode : include |
| entry |
| fullUrl : http://example.org/fhir/Schedule/DoS-Schedule-RR8-LEEDSSJUH-Example |
| resource |
| id : DoS-Schedule-RR8-LEEDSSJUH-Example |
| meta |
| lastUpdated : 2024-07-16T15:01:30.8185338+00:00 |
| identifier |
| system : https://fhir.leedssth.nhs.uk/Diary/id |
| value : 8622dfdb-dc6a-47b6-b3a7-2eb2829db287 |
| active : True |
| serviceCategory |
| coding |
| system : http://terminology.hl7.org/CodeSystem/service-category |
| code : 14 |
| display : Emergency Department |
| serviceType |
| coding |
| system : http://terminology.hl7.org/CodeSystem/service-type |
| code : 117 |
| display : Emergency Medical |
| specialty |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode |
| code : 110 |
| display : Trauma and Orthopaedics |
| actor |
| reference : HealthcareService/DoS-HealthcareService-OrthopaedicService-Example |
| display : Trauma and Orthopaedics Service |
| actor |
| reference : PractitionerRole/PractitionerRole-JoeSmithLeedsSTH-Example |
| display : Paedatrician |
| actor |
| reference : Practitioner/Practitioner-JoeSmith-Example |
| display : Dr. Joe Smith |
| actor |
| reference : Location/DoS-Location-HospitalSJUH-Example |
| display : St James' University Hospital, Leeds |
| planningHorizon |
| start : 2024-07-22T09:00:00+00:00 |
| end : 2024-07-29T10:00:00+00:00 |
| search |
| mode : include |
| entry |
| fullUrl : http://example.org/fhir/HealthcareService/DoS-HealthcareService-OrthopaedicService-Example |
| resource |
| id : DoS-HealthcareService-OrthopaedicService-Example |
| meta |
| lastUpdated : 2024-07-16T15:01:30.8185338+00:00 |
| identifier |
| system : https://fhir.leedssth.nhs.uk/MyHealthcare/Services |
| value : 100 |
| active : True |
| providedBy |
| reference : Organization/UKCore-Organization-LeedsTeachingHospital-Example |
| display : St James' University Hospital, Leeds |
| location |
| reference : Location/DoS-Location-HospitalSJUH-Example |
| name : Trauma and Orthopaedics Service |
| search |
| mode : include |
| entry |
| fullUrl : http://example.org/fhir/Practitioner/Practitioner-JoeSmith-Example |
| resource |
| id : Practitioner-JoeSmith-Example |
| meta |
| lastUpdated : 2024-07-16T15:01:30.8185338+00:00 |
| identifier |
| use : official |
| system : https://fhir.hl7.org.uk/Id/gmc-number |
| value : C9999999 |
| name |
| family : Smith |
| given : Joe |
| prefix : Dr |
| qualification |
| code |
| coding |
| system : http://terminology.hl7.org/CodeSystem/v2-0360 |
| code : MD |
| display : Doctor of Medicine |
| search |
| mode : include |
| entry |
| fullUrl : http://example.org/fhir/PractitionerRole/PractitionerRole-JoeSmithLeedsSTH-Example |
| resource |
| id : PractitionerRole-JoeSmithLeedsSTH-Example |
| meta |
| lastUpdated : 2024-07-16T15:01:30.8185338+00:00 |
| identifier |
| system : https://fhir.nhs.uk/Id/sds-role-profile-id |
| value : R0260 |
| practitioner |
| reference : Practitioner/Practitioner-JoeSmith-Example |
| code |
| coding |
| system : http://terminology.hl7.org/CodeSystem/practitioner-role |
| code : doctor |
| display : Doctor |
| organization |
| identifier |
| system : https://fhir.nhs.uk/Id/ods-organization-code |
| value : RR8 |
| display : Leeds Teaching Hospitals NHS Trust |
| specialty |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode |
| code : 110 |
| display : Trauma and Orthopaedics |
| telecom |
| system : phone |
| value : 0113 243 3144 |
| telecom |
| system : email |
| value : jsmithgppracticeg@nhs.net |
| telecom |
| system : email |
| value : orthopaedics@leedsuniversitynhs.net |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/contactpoint-comment |
| value : reporting |
| search |
| mode : match |
| entry |
| fullUrl : http://example.org/fhir/Location/DoS-Location-HospitalSJUH-Example |
| resource |
| id : DoS-Location-HospitalSJUH-Example |
| meta |
| lastUpdated : 2024-07-16T15:01:30.8185338+00:00 |
| identifier |
| system : https://fhir.nhs.uk/Id/ods-site-code |
| value : RR813 |
| name : ST JAMES'S UNIVERSITY HOSPITAL |
| type |
| coding |
| system : http://terminology.hl7.org/CodeSystem/v3-RoleCode |
| code : HOSP |
| display : Hospital |
| telecom |
| system : phone |
| value : 0113 243 3144 |
| address |
| line : ST. JAMES'S UNIVERSITY HOSPITAL |
| line : BECKETT STREET |
| city : LEEDS |
| postalCode : LS9 7TF |
| country : ENGLAND |
| position |
| longitude : 143.20196 |
| latitude : -37.22866 |
| managingOrganization |
| reference : Organization/UKCore-Organization-LeedsTeachingHospital-Example |
| search |
| mode : include |
| entry |
| fullUrl : http://example.org/fhir/Organization/UKCore-Organization-LeedsTeachingHospital-Example |
| resource |
| id : UKCore-Organization-LeedsTeachingHospital-Example |
| identifier |
| use : official |
| system : https://fhir.nhs.uk/Id/ods-organization-code |
| value : RR8 |
| name : LEEDS TEACHING HOSPITALS NHS TRUST |
| telecom |
| system : phone |
| value : 0113 243 3144 |
| address |
| line : ST. JAMES'S UNIVERSITY HOSPITAL |
| line : BECKETT STREET |
| city : LEEDS |
| postalCode : LS9 7TF |
| country : ENGLAND |
| search |
| mode : include |
{
},
{
"url": "https://simplifier.net/nhsbookingandreferrals/777a156c-af3c-4748-a8a3-7e95e4b0df9a-duplicate-2"
}
],
{
},
{
{
}
]
}
}
],
{
{
}
]
}
],
},
},
}
},
{
},
{
{
}
]
}
}
],
{
{
}
]
}
],
},
},
}
},
{
},
{
{
}
]
}
}
],
{
{
}
]
}
],
},
},
}
},
{
},
{
}
],
{
{
}
]
}
],
{
{
}
]
}
],
{
{
}
]
}
],
{
},
{
},
{
},
{
}
],
}
},
}
},
{
"fullUrl": "http://example.org/fhir/HealthcareService/DoS-HealthcareService-OrthopaedicService-Example",
},
],
},
],
},
}
},
{
},
],
],
{
{
}
]
}
}
]
},
}
},
{
},
],
},
{
{
}
]
}
],
},
},
{
{
}
]
}
],
{
},
{
},
{
{
}
]
}
]
},
}
},
{
},
],
{
{
}
]
}
],
],
"ST. JAMES'S UNIVERSITY HOSPITAL",
"BECKETT STREET"
],
},
},
}
},
}
},
{
"fullUrl": "http://example.org/fhir/Organization/UKCore-Organization-LeedsTeachingHospital-Example",
],
],
{
"ST. JAMES'S UNIVERSITY HOSPITAL",
"BECKETT STREET"
],
}
]
},
}
}
]
}
</meta>
<url value="https://simplifier.net/nhsbookingandreferrals/777a156c-af3c-4748-a8a3-7e95e4b0df9a-duplicate-2" />
</link>
<Slot>
</meta>
</coding>
</valueCodeableConcept>
</extension>
</coding>
</serviceCategory>
</schedule>
</Slot>
</resource>
</search>
</entry>
<Slot>
</meta>
</coding>
</valueCodeableConcept>
</extension>
</coding>
</serviceCategory>
</schedule>
</Slot>
</resource>
</search>
</entry>
<Slot>
</meta>
</coding>
</valueCodeableConcept>
</extension>
</coding>
</serviceCategory>
</schedule>
</Slot>
</resource>
</search>
</entry>
<Schedule>
</meta>
</identifier>
</coding>
</serviceCategory>
</coding>
</serviceType>
</coding>
</specialty>
</actor>
</actor>
</actor>
</actor>
</planningHorizon>
</Schedule>
</resource>
</search>
</entry>
<fullUrl value="http://example.org/fhir/HealthcareService/DoS-HealthcareService-OrthopaedicService-Example" />
<HealthcareService>
</meta>
</identifier>
</providedBy>
</location>
</HealthcareService>
</resource>
</search>
</entry>
<Practitioner>
</meta>
</identifier>
</name>
</coding>
</code>
</qualification>
</Practitioner>
</resource>
</search>
</entry>
<fullUrl value="http://example.org/fhir/PractitionerRole/PractitionerRole-JoeSmithLeedsSTH-Example" />
<PractitionerRole>
</meta>
</identifier>
</practitioner>
</identifier>
</organization>
</coding>
</code>
</coding>
</specialty>
</telecom>
</telecom>
</extension>
</telecom>
</PractitionerRole>
</resource>
</search>
</entry>
<Location>
</meta>
</identifier>
</coding>
</type>
</telecom>
</address>
</position>
</managingOrganization>
</Location>
</resource>
</search>
</entry>
<fullUrl value="http://example.org/fhir/Organization/UKCore-Organization-LeedsTeachingHospital-Example" />
<Organization>
</identifier>
</telecom>
</address>
</Organization>
</resource>
</search>
</entry>
</Bundle>
DoS-OperationOutcome-AccessDeniedAuthRequired-Example
Example of error message indicating access has been denied to process the request.
| OperationOutcome |
| id : DoS-OperationOutcome-AccessDeniedAuthRequired-Example |
| issue |
| severity : error |
| code : security |
| details |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode |
| version : 1.0.0 |
| code : ACCESS_DENIED |
| display : Access has been denied to process this request |
| diagnostics : Authentication is required |
{
{
{
}
]
},
}
]
}
</coding>
</details>
</issue>
</OperationOutcome>
DoS-OperationOutcome-InternalServerError-Example
Example of error message indicating an internal server error has occured. e.g. Can't connect to DB
| OperationOutcome |
| id : DoS-OperationOutcome-InternalServerError-Example |
| issue |
| severity : fatal |
| code : exception |
| diagnostics : Internal server error |
{
]
}
</issue>
</OperationOutcome>
DoS-OperationOutcome-InvalidSearchDataAndIdentifierValue-Example
Example of error message indicating an invalid identifier value was provided as a search parameter (e.g. Invalid ODS Code, Missing ODS Code?)
| OperationOutcome |
| id : DoS-OperationOutcome-InvalidSearchDataAndIdentifierValue-Example |
| issue |
| severity : error |
| code : value |
| details |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode |
| version : 1.0.0 |
| code : INVALID_SEARCH_DATA |
| display : Invalid search data |
| diagnostics : Invalid identifier value: ODS code 'H82028' must follow format ^[A-Z0-9]{5,12}$ |
{
{
{
}
]
},
}
]
}
</coding>
</details>
<diagnostics value="Invalid identifier value: ODS code 'H82028' must follow format ^[A-Z0-9]{5,12}$" />
</issue>
</OperationOutcome>
DoS-OperationOutcome-InvalidSearchDataAndIdentifierSys-Example
Example of error message indicating an invalid identifier system was provided as a search parameter.
| OperationOutcome |
| id : DoS-OperationOutcome-InvalidSearchDataAndIdentifierSys-Example |
| issue |
| severity : error |
| code : code-invalid |
| details |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode |
| version : 1.0.0 |
| code : INVALID_SEARCH_DATA |
| display : Invalid search data |
| diagnostics : Invalid identifier system 'foo' - expected '_odsOrganisationCode' |
{
{
{
}
]
},
}
]
}
</coding>
</details>
</issue>
</OperationOutcome>
DoS-OperationOutcome-InvalidSearchDataMissingSearchParam-Example
Example of error message indicating a required search parameter was missing.
| OperationOutcome |
| id : DoS-OperationOutcome-InvalidSearchDataMissingSearchParam-Example |
| issue |
| severity : error |
| code : value |
| details |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode |
| version : 1.0.0 |
| code : INVALID_SEARCH_DATA |
| display : Invalid search data |
| diagnostics : The request is missing the 'revinclude=Endpoint:organization' parameter, which is required to include linked Endpoint resources. |
{
{
{
}
]
},
"diagnostics": "The request is missing the 'revinclude=Endpoint:organization' parameter, which is required to include linked Endpoint resources."
}
]
}
</coding>
</details>
<diagnostics value="The request is missing the 'revinclude=Endpoint:organization' parameter, which is required to include linked Endpoint resources." />
</issue>
</OperationOutcome>
DoS-OperationOutcome-UnsupportedServicePatient-Example
Example of error message indicating an incorrect request was sent.
| OperationOutcome |
| id : DoS-OperationOutcome-UnsupportedServicePatient-Example |
| issue |
| severity : error |
| code : not-supported |
| details |
| coding |
| system : https://fhir.hl7.org.uk/CodeSystem/UKCore-SpineErrorOrWarningCode |
| version : 1.0.0 |
| code : UNSUPPORTED_SERVICE |
| display : Unsupported service |
| diagnostics : Unsupported service: 'Patient' |
{
{
{
}
]
},
}
]
}
</coding>
</details>
</issue>
</OperationOutcome>