We have detected that you are using Internet Explorer to visit this website. Internet Explorer is now being phased out by Microsoft. As a result, NHS Digital no longer supports any version of Internet Explorer for our web-based products, as it involves considerable extra effort and expense, which cannot be justified from public funds. Some features on this site will not work. You should use a modern browser such as Edge, Chrome, Firefox, or Safari. If you have difficulty installing or accessing a different browser, contact your IT support team.
Referral Assessment Service with API integration - NHS e-Referral Service
Guidance for service providers on using Application Programming Interfaces (APIs) with Referral Assessment Service (RAS) within the NHS e-Referral Service (e-RS).
About e-RS APIs
An API allows communication and information to be shared between systems. This means that if another system is developed to utilise an API (such as a GP system, PAS or Electronic Patient Record system) it's possible to access e-RS functionality directly within that system without having to load e-RS in a web browser.
For example, all new referrals for review could be accessed directly from a PAS or EPR system and this information could be used to create an encounter record on the PAS – no more copying and pasting or re-keying between windows.
It also opens up the possibility to manage referrals in ways that are not possible using the web-based interface.
Current RAS implementation (without API integration)
Healthcare providers may choose to put in place a RAS to triage referrals in support of more complex clinical pathways. Unlike a directly bookable service in e-RS, a RAS request has no appointment booking and for this reason there is no electronic information sent from e-RS to the service provider (hospital) PAS.
As a result, if the hospital wants to keep a record of the RAS request the service provider staff must either manually register, or update, the patient information on their hospital PAS.
Find out more information about RAS.
Potential RAS solution (with API integration)
System (PAS) suppliers with API integration can download the Referrals for Review worklist which contains both booked appointments and RAS requests.
The APIs can also provide information such as patient NHS number, a PDF of the clinical referral information and any attachments (including the referral letter, if provided).
An API integrated system could be enhanced to download this information and create or update its patient registration records electronically.
The development to achieve such outcomes is dependent on a supplier integrating with e-RS via the APIs.
Currently, the Clinical Referral Information (CRI) API is available and in use in several providers, as well as new APIs providing the ability to accept, reject or request an administrator to redirect a referral (using e-RS) now being available.
Organisations are encouraged to work with their PAS suppliers to ensure the workflows and functionality of any integration with their system fit local processes.
Interested service providers should encourage their system suppliers to find out more information about the e-Referral API Hub.
If you have any questions or need more information regarding e-Referral APIs, please contact the team by emailing firstname.lastname@example.org.