v1
latestOpenAPI 3.0.02026-07-142042.2 KBRetrieve referral requests for a patient
Overview
Use this endpoint to retrieve active e-RS referrals for an authenticated patient, including summary details relating to its current state.
Where the referral is currently being managed by a service provider, this endpoint will reference the Service ID for that service. This can then be used to retrieve the service information using [[HYPERLINK_A002]].
The referrals that are returned by this endpoint are the same referrals that are accessible to the patient via [[HYPERLINK_MANAGE_REFERRAL]].
Pre-requisites
In order to use this endpoint the patient must be an authenticated user.
The patient needs to have authenticated via [[HYPERLINK_NHS_LOGIN]] and meet the required [[HYPERLINK_PROOFING_LEVEL]] (currently this is "P9").
Use case
As an authenticated user
I want to retrieve my referrals
So that I can view and manage my referrals
Related endpoints
You can retrieve the attributes of a single service via [[HYPERLINK_A002]] using the Service ID
Query parameters
Parameter to supply a patient NHS Number.
Parameter to supply the category, defined as per http://snomed.info/sct. Supported only 'Patient referral', which is the value 3457005.
A URL parameter that returns the active Appointment or Task to a ServiceRequest. Please note that '_revinclude' query parameter can be supplied multiple times for example:
GET /ServiceRequest?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888&category=http://snomed.info/sct|3457005&_revinclude=Appointment:based-on&_revinclude=Task:focus
Headers
Arbitrary string value provided by API Consumer
Tends to be unique, but does not have to be
Returned, unchanged, in the response
Response
The Response contains a FHIR 'Bundle' that, in turn, contains 'ServiceRequest' resources where each 'ServiceRequest' resource can include the latest 'Task' or 'Appointment' associated to the 'ServiceRequest'.