Skip to main content

Booking and Referral - FHIR API

Send booking and referral information between NHS service providers using our Booking and Referral FHIR API.

Page contents

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

Care provider A (sender)
Care provider A (...
route
booking
or referral
request
route...
BaRS
FHIR API
BaRS...
send
referral
send...
Care provider D
(receiver)
Care provider D...
Care provider C
(receiver)
Care provider C...
Care provider B
(receiver)
Care provider B...
API routes request based on service identifier
API routes request...
send
booking
send...
Text is not SVG - cannot display How BaRS works to send booking and referral information between NHS service providers.

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:

  1. Send a request from your sender application to this API, along with a service identifier header.
  2. This API redirects the request to the service associated with the service identifier header.
  3. The target backend handles the request and sends a response back to this API.
  4. This API returns the response to your sender application.
  5. 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.0 In development   Booking and referral - FHIR API v 1.2.0
1.1.0 In development  

Booking and Referral - FHIR API v1.1.0

1.0.0 In production  

Booking and Referral - FHIR API v1.0.0

Last edited: 2 November 2023 11:45 am