Booking and Referral - FHIR API
Send booking and referral information between NHS service providers using our Booking and Referral FHIR API.
This API forms part of the Booking and Referral Standard (BaRS). This API specification should be used in conjunction with the BaRS implementation guide for your use case.
Overview
Use this API to send booking and referral information between NHS service providers.
You can:
- get a specific booking
- get bookings for a patient
- process a message, either a booking or a referral
- get message definition
- get capability statement
- get a specific referral
- get referrals for a patient
- get slots
The following describes the end-to-end process:
- Send a request from your sender application to this API, along with a service identifier header.
- This API redirects the request to the service associated with the service identifier header.
- The target backend handles the request and sends a response back to this API.
- This API returns the response to your sender application.
- In some applications the target may send a follow up request to indicate the outcome of a request.
For a non-technical overview of how to build software that deals with referrals and bookings, see Building healthcare software - referrals and bookings.
Versions
This API has multiple versions as follows:
| Version | Status | Documentation | |
|---|---|---|---|
| 1.2.2-alpha | In development | Booking and referral - FHIR API v 1.2.2-alpha | |
| 1.1.6 | In development | ||
| 1.0.6 | In production |
Last edited: 21 May 2025 12:58 pm