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/
| Method | URL |
|---|---|
| GET | v1/Binary/$ers.generateCRI?UBRN={UBRN} |
Related FHIR model
Description
This API lets users create a real-time Portable Document Format (PDF) of the referral. This is suitable for integration into a 3rd party system. You can find the Clinical Information for a referral request using a UBRN.
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
Accept:*/*
Output
If successful a PDF of clinical referral information for referral is returned. The response code 200 (OK) is returned.
Notes
Get the Clinical Referral Information for a Referral Request identified by the given UBRN.
Parameters
| Parameter | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| UBRN | UBRN | Query | String |
Response Messages
| HTTP Status Code | Reason |
|---|---|
| 200 | OK |
| 403 | Forbidden |
| 404 | Not Found |
