Part of Integration process overview
Stage 1.3 - Explore our FHIR API
Learn about the NHS e-Referral Service API endpoints and see how they work using our sandbox environment.
Current live endpoints = 37
Overview
The FHIR API is the modern way to integrate healthcare software with the e-Referral Service.
Our API can be used to create and manage digital referrals in primary and secondary care.
Functionality is broken down into two distinct areas:
- Primary care referrer - organisations who send and manage referrals
- Secondary care provider - organisations who receive and manage referrals
You can refer back to our building healthcare software guide for use case information.
1. API Catalogue
These diagrams show our full endpoint catalogue.
For each functional area we provide a typical workflow so that you understand how these endpoints could fit together. These are example flows and not all endpoints may be required.
The business processes behind these workflows and endpoints are described in our use case guide.
2. Referrer endpoints
2.1 Create referrals and bookings
Using this workflow you can:
- create a referral request
- book or defer an appointment to a service
- send a referral to a triage service
- upload and manage attachments
Review the create referrals and bookings use case for more information.
2.2 Update and manage referrals
Using this workflow you can:
- change a referral shortlist
- cancel an appointment booking
- cancel a referral
Review the update and manage referrals use case for more information.
2.3 Create advice and guidance requests
Using this workflow you can create an advice and guidance request.
Review the create advice and guidance requests use case for more information.
2.4 Respond to advice and guidance requests
This referrer functionality is not yet available.
Updates about it's development will be made in our updates and releases section.
Using this workflow you will be able to:
- retrieve the advice and guidance requests worklist
- respond to advice
- convert an advice and guidance request to a referral
- end advice request
3. Provider endpoints
3.1 Retrieve clinical referral information and review referrals
Using this workflow you can:
- retrieve clinical referral information
- accept/reject a referral
- cancel an appointment booking to action later
- record a triage outcome
Review the retrieve clinical referral information and receive and review referrals use cases for more information.
Clinical referral information can include:
- structured clinical information added by an integrated primary care system
- service provider activity
- advice and guidance conversation
It is important that all clinical information is obtained using the endpoints below. Including clinical information across all related referrals in a pathway:
3.2 Receive and review advice and guidance requests
Using this workflow you can:
- retrieve advice and guidance requests worklist
- retrieve advice summary and conversations
- send advice response
- convert an advice and guidance request to a referral
Review the receive and review advice and guidance requests use case for more information.
4.0 User and service information
These endpoints are assistive functions which are not specific to a functional area.
They provide information about:
- a users role profile
- roles which a user can work on-behalf-of
- a service request
5.0 Try our open-access sandbox
Our sandbox offers a self-service environment which you can use for learning, experimentation and early testing.
It is open-access, doesn't require authorisation and returns hard-coded responses. The sandbox will only respond to an input that matches one of the examples provided. Otherwise, it is stateless.
You can try the sandbox feature from our Open API Specification (OAS).
Last edited: 26 March 2025 3:58 pm