Booking and Referral Standard (BaRS) - FHIR API
Sends booking and referral information between NHS service providers using the Booking and Referral Standard as an HL7 FHIR R4 API. OpenAPI harvested verbatim (8 paths).
Booking and Referral Standard (BaRS) - FHIR API is one of 10 APIs that NHS England publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include FHIR, Booking, and Referrals. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 8 operations across 8 paths, organized into 5 resource areas, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against 3 base URLs: https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4, https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4, https://api.service.nhs.uk/booking-and-referral/FHIR/R4.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Booking and Referral Standard (BaRS) - FHIR API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (OAuth_Token).
By default, every request must be authenticated.
Paths & Operations 8
Across 8 paths, the API surfaces 8 operations — 7 GET, 1 POST. They span 5 resource areas: Metadata, Message, Slots, Booking, Referral. Each is listed below with its method, path, parameters, and response codes.
Schemas 13
The contract defines 13 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NHS England 9
Other APIs NHS England publishes across the network.