Status:
This endpoint has been deprecated, meaning you should not use it for new integrations.
Instead, please use our newer e-RS FHIR API solution which is documented here: https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir
API
Base URL (Dev1): https://api.dev1.ers.ncrs.nhs.uk/ers-api/
| Request Type | URL |
|---|---|
| POST | v1/ReferralRequest/$ers.fetchworklist |
Related FHIR model
Description
This API lets authorised users retrieve the ‘Referrals for Review’ work list. This work list gives details of new or outstanding referrals sent to the service by GPs and others. It includes their key attributes.
Input
Header
Provide ASID of the end-point system and equivalent Session Key generated for the SSO Token-ID.
Example
XAPI_ASID:200000000220
HTTP_X_SESSION_KEY:pro-xapi-session_5a399946-23c5-4543-8c4f-7eca38732a58
Content-Type:application/json+fhir
Body
Provide ‘Referrals for Review’ worklist parameter.
Example
{
"resourceType": "Parameters",
"meta": {
"versionId":"1",
"profile": [
"http://fhir.nhs.uk/OperationDefinition/ers-fetchworklist-operation-1"
]
},
"parameter": [
{
"name": "listType",
"valueCodeableConcept": {
"coding": [
{
"system": "http://fhir.nhs.uk/ValueSet/ers-referrallistselector-1",
"code": "REFERRALS_FOR_REVIEW"
}
]
}
},
{
"name": "service",
"valueIdentifier": {
"system": "http://fhir.nhs.uk/Id/ers-service",
"value": "6167685"
}
},
{
"name": "specialtyAssignedIndicator",
"valueCodeableConcept": {
"coding": [
{
"system": "http://fhir.nhs.uk/ValueSet/ers-assignedindicator-1",
"code": "ASSIGNED"
}
]
}
},
{
"name": "specialty",
"valueCodeableConcept": {
"coding": [
{
"system": "http://fhir.nhs.uk/ValueSet/ers-specialty-1",
"code": "EAR_NOSE_THROAT"
}
]
}
},
{
"name": "location",
"valueIdentifier": {
"system": "http://fhir.nhs.uk/Id/ods-site-code",
"value": "RCD00"
}
},
{
"name": "clinicianAssignedIndicator",
"valueCodeableConcept": {
"coding": [
{
"system": "http://fhir.nhs.uk/ValueSet/ers-assignedindicator-1",
"code": "ASSIGNED"
}
]
}
},
{
"name": "clinician",
"valueIdentifier": {
"system": "http://fhir.nhs.uk/Id/sds-user-id",
"value": "100000873988"
}
}
]
}
Output
If successful referrals under ‘Referrals for Review’ worklist are returned. The response code 200 (OK) is returned.
IN the response body each entry returned will include:
- UBRN
- Referral Id (internal to e-RS, not the UBRN)
- e-Referral Pathway Start Date
- Request Priority
- Appointment Date Time (if there is a Booked Appointment Booking only)
- NHS Number
- Clinical Information First Submitted Date (This is the First Submission from the Referrer Clinical Information related to the Appointment Request)
- Clinical Information Last Updated Date (If recorded for the Appointment Request, this is the Last Alteration Date Time from the Referrer Clinical information for the Appointment Request)
- Printing Complete Flag of the Referrer Clinical Information associated with the Appointment Request (a boolean to show the state of this flag)
- Clinician
- Specialty of the Service associated with the Booked Appointment Booking or Triage Deferral
- Status
- Referral Type: APPOINTMENT / TRIAGE_DEFERRAL
Example
{
"meta": {
"profile": [
"http://fhir.nhs.uk/StructureDefinition/ers-fetchworklist-list-1"
]
},
"resourceType": "List",
"contained": [
{
"id": "Practitioner-100000873988",
"meta": {
"profile": [
"http://fhir.nhs.uk/StructureDefinition/ers-practitioner-1"
]
},
"resourceType": "Practitioner",
"identifier": [
{
"system": "http://fhir.nhs.uk/Id/sds-user-id",
"value": "100000873988"
}
]
},
{
"id": "Patient-9461838328",
"meta": {
"profile": [
"http://fhir.nhs.uk/StructureDefinition/ers-patient-1"
]
},
"resourceType": "Patient",
"identifier": [
{
"system": "http://fhir.nhs.uk/Id/nhs-number",
"value": "9461838328"
}
]
}
],
"status": "current",
"mode": "snapshot",
"entry": [
{
"extension": [
{
"extension": [
{
"url": "specialty",
"valueCodeableConcept": {
"coding": [
{
"system": "http://fhir.nhs.uk/ValueSet/ers-specialty-1",
"code": "EAR_NOSE_THROAT"
}
]
}
},
{
"url": "requestContextStatus",
"valueCodeableConcept": {
"coding": [
{
"system": "http://fhir.nhs.uk/ValueSet/ers-requestcontextstatus-1",
"code": "NEVER_REVIEWED",
"display": "Never Reviewed"
}
]
}
},
{
"url": "allocatedClinician",
"valueReference": {
"reference": "#Practitioner-100000873988"
}
},
{
"url": "clinicalInfoPrinted",
"valueBoolean": false
},
{
"url": "clinicalInfoFirstSubmitted",
"valueDateTime": "2017-07-27T13:41:11.552Z"
},
{
"url": "dateWhenBookingMade",
"valueDateTime": "2017-07-27T13:42:10.967Z"
},
{
"url": "appointmentStart",
"valueDateTime": "2017-08-04T13:00:00.000Z"
},
{
"url": "priority",
"valueCodeableConcept": {
"coding": [
{
"system": "http://fhir.nhs.uk/ValueSet/ers-priority-1",
"code": "ROUTINE"
}
]
}
},
{
"url": "patient",
"valueReference": {
"reference": "#Patient-9461838328"
}
}
],
"url": "http://fhir.nhs.uk/StructureDefinition/extension-ers-referralsforreview-worklistitem-1"
}
],
"item": {
"reference": "ReferralRequest/000048417799"
}
}
]
}
Response Messages
| HTTP Status Code | Reason | Response Model | Headers |
|---|---|---|---|
| 403 | Forbidden | ||
| 422 | Unprocessable Entity – Provided data could not be processed due to a validation error. |
