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.
Find out more about integration and how to connect systems to the NHS e-Referral Service (e-RS)
Application Programming Interfaces (APIs)
The development of the N3/HSCN based interface approach is influenced by RESTful service interfaces and the emerging HL7 FHIR (Fast Healthcare Interoperability Resources) standard.
Find out more about FHIR.
What APIs are current available?
Clinical referral information (CRI) APIs are now in use at a variety of NHS Acute Trusts across the country allowing the electronic transfer of clinical documents between e-RS and integrated hospital systems. Find out more by reading our case study about Imperial College Healthcare.
These APIs can also potentially be used by providers who have referral assessment services (RAS) on e-RS to support the patient registration process.
Find out more about the guidance on using APIs with RAS.
Further APIs were added in January 2020 which provide the ability to:
- search for services via the e-RS directory of services (DoS)
- create referrals
- generate a patient letter
These are now in use, with case studies to follow.
Future planned developments
Our future integration developments ensure that the service is continually improved to make it easier, quicker and more efficient for third party solutions to connect.
The e-RS roadmap includes a timetable of the following planned system enhancements:
- enhancements to allow the booking and deferring of appointments through the API using the NHS e-Referral Service (e-RS)
- changes to the referrer APIs to facilitate the management of referral attachments and appointments
- provide functionality to redirect a referral through the API
- allow access to a wider range of referrals such as those that have had Appointment Slot Issues (ASIs)
- allow referrals sent to triage services to be progressed
- explore methods of authentication to APIs over the internet
Find out more about the above changes from the e-RS news page.
These developments are based on your feedback.
Find out how you can provide suggestions on how to improve e-RS integration.
We aim to deliver both new APIs, as well as updating existing ones so that we can continue to provide benefit to both patients and professional users.
Development and compliance
The health developer network provides all documentation on the engagement process, API architecture, setting up test environments, FHIR resources and all other development resources required to start building your software solution.