Send booking and referral information between NHS service providers following the NHS Booking and Referral Standard (BaRS). Enables interoperable bookings and referrals across urgent and emergency care, primary care, and other NHS settings.
openapi: 3.0.0
info:
description: |
<section class="nhsd-m-emphasis-box nhsd-m-emphasis-box--important nhsd-!t-margin-bottom-6" aria-label="Important Information">
<div class="nhsd-a-box nhsd-a-box--border-yellow">
<div class="nhsd-m-emphasis-box__image-box">
<figure class="nhsd-a-image">
<picture class="nhsd-a-image__picture">
<img src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAyNS4xLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT48c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIGlkPSJMYXllcl8xIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCAxNDAgMTQwOyIgdmVyc2lvbj0iMS4xIiB2aWV3Qm94PSIwIDAgMTQwIDE0MCIgeD0iMHB4IiB4bWw6c3BhY2U9InByZXNlcnZlIiB5PSIwcHgiPgo8c3R5bGUgdHlwZT0idGV4dC9jc3MiPgoJLnN0MHtkaXNwbGF5Om5vbmU7fQoJLnN0MXtkaXNwbGF5OmlubGluZTtmaWxsOiMyMzFmMjA7fQoJLnN0MntmaWxsOiMyMzFmMjA7fQoJLnN0M3tmaWxsOm5vbmU7c3Ryb2tlOiMyMzFmMjA7c3Ryb2tlLXdpZHRoOjEuOTI7c3Ryb2tlLWxpbmVjYXA6cm91bmQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjEwO30KCS5zdDR7ZmlsbDojMjMxZjIwO30KCS5zdDV7ZmlsbDojMjMxZjIwO30KCS5zdDZ7ZmlsbDpub25lO3N0cm9rZTojMjMxZjIwO3N0cm9rZS13aWR0aDo1O3N0cm9rZS1taXRlcmxpbWl0OjEwO30KPC9zdHlsZT4KPGcgY2xhc3M9InN0MCI+Cgk8cGF0aCBjbGFzcz0ic3QxIiBkPSJNNzAsNi45NWw1NCwzMS41djYzLjExbC01NCwzMS41bC01NC0zMS41VjM4LjQ1TDcwLDYuOTUgTTcwLDBMMTAsMzV2NzBsNjAsMzVsNjAtMzVWMzVMNzAsMEw3MCwweiIvPgo8L2c+CjxnPgoJPHBhdGggY2xhc3M9InN0MiIgZD0iTTEwOS44NiwzOS44NXY1NUg4NS43Yy0zLjA2LDAtNS4xNCwzLjA2LTcuMDgsNWgtMTcuNWMtMS45NC0xLjk0LTQuMDMtNS03LjA4LTVIMjkuODd2LTU1aDI1ICAgYzUuMjgsMCwxMC44MywxLjMyLDE1LDQuNzljNC4xNy0zLjQ3LDkuNzItNC43OSwxNS00Ljc5SDEwOS44NnogTTY0Ljg2LDU0Ljg1YzAtMy44OS03LjIyLTUtMTAtNWgtMTV2MzVoMTMuNzUgICBjNS42MiwwLDcuNTcsMC42OSwxMS4yNSw1VjU0Ljg1eiBNOTkuODYsNDkuODVoLTE1Yy0yLjc4LDAtMTAsMS4xMS0xMCw1djM1YzMuNjgtNC4zMSw1LjYyLTUsMTEuMjUtNWgxMy43NVY0OS44NXoiLz4KPC9nPgo8L3N2Zz4K" alt="" style="object-fit:fill">
</picture>
</figure>
</div>
<div class="nhsd-m-emphasis-box__content-box">
<div data-uipath="website.contentblock.emphasis.content" class="nhsd-t-word-break">
<p class="nhsd-t-body">This API forms part of the <a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/About-BaRS/About-BaRS?version=1.6.0">Booking and Referral Standard (BaRS)</a>.<br>This API specification should be used in conjunction with the <a href="https://simplifier.net/guide/nhsbookingandreferralstandard" class="nhsd-a-link">BaRS implementation guide</a> for your use case.</p>
</div>
</div>
</div>
</section>
## 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:
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](https://simplifier.net/guide/nhsbookingandreferralstandard/home/design/bars-applications) the target may send a follow up request to indicate the outcome of a request.
<section class="nhsd-m-emphasis-box nhsd-m-emphasis-box--important nhsd-!t-margin-bottom-6" aria-label="Important Information">
<div class="nhsd-a-box nhsd-a-box--border-yellow">
<div class="nhsd-m-emphasis-box__image-box">
<figure class="nhsd-a-image">
<picture class="nhsd-a-image__picture">
<img src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAyNS4xLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT48c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIGlkPSJMYXllcl8xIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCAxNDAgMTQwOyIgdmVyc2lvbj0iMS4xIiB2aWV3Qm94PSIwIDAgMTQwIDE0MCIgeD0iMHB4IiB4bWw6c3BhY2U9InByZXNlcnZlIiB5PSIwcHgiPgo8c3R5bGUgdHlwZT0idGV4dC9jc3MiPgoJLnN0MHtkaXNwbGF5Om5vbmU7fQoJLnN0MXtkaXNwbGF5OmlubGluZTtmaWxsOiMyMzFmMjA7fQoJLnN0MntmaWxsOiMyMzFmMjA7fQoJLnN0M3tmaWxsOm5vbmU7c3Ryb2tlOiMyMzFmMjA7c3Ryb2tlLXdpZHRoOjEuOTI7c3Ryb2tlLWxpbmVjYXA6cm91bmQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjEwO30KCS5zdDR7ZmlsbDojMjMxZjIwO30KCS5zdDV7ZmlsbDojMjMxZjIwO30KCS5zdDZ7ZmlsbDpub25lO3N0cm9rZTojMjMxZjIwO3N0cm9rZS13aWR0aDo1O3N0cm9rZS1taXRlcmxpbWl0OjEwO30KPC9zdHlsZT4KPGcgY2xhc3M9InN0MCI+Cgk8cGF0aCBjbGFzcz0ic3QxIiBkPSJNNzAsNi45NWw1NCwzMS41djYzLjExbC01NCwzMS41bC01NC0zMS41VjM4LjQ1TDcwLDYuOTUgTTcwLDBMMTAsMzV2NzBsNjAsMzVsNjAtMzVWMzVMNzAsMEw3MCwweiIvPgo8L2c+CjxnPgoJPHBhdGggY2xhc3M9InN0MiIgZD0iTTEwOS44NiwzOS44NXY1NUg4NS43Yy0zLjA2LDAtNS4xNCwzLjA2LTcuMDgsNWgtMTcuNWMtMS45NC0xLjk0LTQuMDMtNS03LjA4LTVIMjkuODd2LTU1aDI1ICAgYzUuMjgsMCwxMC44MywxLjMyLDE1LDQuNzljNC4xNy0zLjQ3LDkuNzItNC43OSwxNS00Ljc5SDEwOS44NnogTTY0Ljg2LDU0Ljg1YzAtMy44OS03LjIyLTUtMTAtNWgtMTV2MzVoMTMuNzUgICBjNS42MiwwLDcuNTcsMC42OSwxMS4yNSw1VjU0Ljg1eiBNOTkuODYsNDkuODVoLTE1Yy0yLjc4LDAtMTAsMS4xMS0xMCw1djM1YzMuNjgtNC4zMSw1LjYyLTUsMTEuMjUtNWgxMy43NVY0OS44NXoiLz4KPC9nPgo8L3N2Zz4K" alt="" style="object-fit:fill">
</picture>
</figure>
</div>
<div class="nhsd-m-emphasis-box__content-box">
<div data-uipath="website.contentblock.emphasis.content" class="nhsd-t-word-break">
<p class="nhsd-t-body">For a non-technical overview of how to build software that deals with referrals and bookings, see <a onclick="logGoogleAnalyticsEvent('Link click','General','/developer/guides-and-documentation/building-healthcare-software/referrals-and-bookings');" href="/developer/guides-and-documentation/building-healthcare-software/referrals-and-bookings" onkeyup="return vjsu.onKeyUp(event)" class="nhsd-a-link">Building healthcare software - referrals and bookings</a>.</p>
</div>
</div>
</div>
</section>
## Who can use this API
This API can only be used for the Booking and Referral Standard where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development. We'll ask you to demonstrate this as part of the digital onboarding process before your software goes live.
## Related APIs
The following APIs are related to this API:
* This API replaces the [NHS Booking - FHIR API](https://digital.nhs.uk/developer/api-catalogue/nhs-booking-fhir)
## API status and roadmap
This version of the API is in [Production](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses), meaning:
* it is available for testing in the integration environment
* it has availability in production
* it is NOT subject to breaking changes
To see our roadmap, or to suggest, comment or vote on features for this API, see our [interactive product backlog](https://nhs-digital-api-management.featureupvote.com/?order=popular&filter=allexceptdone&tag=booking-and-referral&deleted=0#controls).
If you have any other queries, please [contact us](https://digital.nhs.uk/developer/help-and-support).
## Service level
This API is a platinum service, meaning it is operational and supported 24 x 7 x 365.
For more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).
## Technology
This API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest) and uses HTTP POST to submit data.
It conforms to the [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) global standard for health care data exchange, specifically to [FHIR R4 (v4.0.1)](https://hl7.org/fhir/r4/).
It includes:
* country-specific FHIR extensions, which are built against [FHIR UK Core](https://digital.nhs.uk/services/fhir-uk-core), specifically [fhir.r4.ukcore.stu1 0.5.1](https://simplifier.net/packages/fhir.r4.ukcore.stu1/0.5.1)
* BaRS-specific FHIR extensions and ammendments, documented in the [BaRS FHIR project](https://simplifier.net/NHSBookingandReferrals)
## Network access
This API is available on the internet and also indirectly via HSCN.
For more details, see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).
## Security and authorisation
This API is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis),
meaning we authenticate the calling application but not the end user.
To use this access mode, use the following security pattern:
* [application-restricted RESTful API - signed JWT authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication)
For more details, see [BaRS Core - Security and authorisation](https://simplifier.net/guide/nhsbookingandreferralstandard/home/design/bars-core#Security-and-authorisation).
## Errors
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
* 400 to 499 if it failed because of a client error by your application
* 500 to 599 if it failed because of an error on our server
Example errors specific to each API are shown in the endpoints section, under Response. See the BaRS Core [Error Handling section](https://simplifier.net/guide/nhsbookingandreferralstandard/home/design/bars-core#core-ErrorHandling) for further information on error handling within the BaRS Standard.
## Environments and testing
| Environment | Base URL |
| ----------------- | ---------------------------------------------------------------------- |
| Sandbox | `https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4` |
| Integration test | `https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4` |
| Production | `https://api.service.nhs.uk/booking-and-referral/FHIR/R4` |
Our [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing) is for early developer testing and covers a limited number of scenarios with predefined responses. Please not this environment is stateless.
Our [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing) is for formal integration testing.
For more details see [integration testing with our RESTful APIs](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing-with-our-restful-apis).
## Onboarding
You need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it`s worth planning well ahead.
As part of this process, you need to demonstrate that you can manage risks and that your software conforms technically with the requirements for this API.
Information on this page might impact the design of your software. For details, see [Onboarding support information](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/onboarding-support-information).
To understand how our online digital onboarding process works, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding).
<div class="nhsd-m-emphasis-box nhsd-m-emphasis-box--emphasis nhsd-!t-margin-bottom-6" aria-label="Highlighted Information">
<div class="nhsd-a-box nhsd-a-box--border-blue">
<div class="nhsd-m-emphasis-box__image-box">
<figure class="nhsd-a-image">
<picture class="nhsd-a-image__picture">
<img src="http://digital.nhs.uk/binaries/content/gallery/icons/play-circle.svg?colour=231f20" alt="" style="object-fit:fill">
</picture>
</figure>
</div>
<div class="nhsd-m-emphasis-box__content-box">
<div data-uipath="website.contentblock.emphasis.content" class="nhsd-t-word-break"><p class="nhsd-t-body">To get started, sign in or create a <a href="http://onboarding.prod.api.platform.nhs.uk/">developer account</a>, then select 'product onboarding'.</p></div>
</div>
</div>
</div>
version: 1.0.0
title: Booking and Referral API
termsOfService: 'https://developer.nhs.uk/apis/uec-appointments'
contact:
email: [email protected]
url: 'https://developer.nhs.uk/apis/uec-appointments'
name: NHS Digital
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
servers:
- url: 'https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4'
description: Sandbox Server
- url: 'https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4'
description: Production
- url: 'https://api.service.nhs.uk/booking-and-referral/FHIR/R4'
description: Integration Server
tags:
- name: Booking
- name: Message
- name: Metadata
- name: Referral
- name: Slots
security:
- OAuth_Token: []
paths:
/metadata:
parameters:
- $ref: '#/components/parameters/RequestId_HParam'
- $ref: '#/components/parameters/CorrelationId_HParam'
- $ref: '#/components/parameters/TargetIdentifierMeta_HParam'
- $ref: '#/components/parameters/RequestingOrganisation_HParam'
- $ref: '#/components/parameters/RequestingPractitioner_HParam'
- $ref: '#/components/parameters/RequestingDevice_HParam'
- $ref: '#/components/parameters/Accept_HParam'
get:
tags:
- Metadata
summary: Get capability statement
description: |
### Returns the target endpoints CapabilityStatement
The sender must initially request the receiver's [CapabilityStatement](https://www.hl7.org/fhir/capabilitystatement.html) (GET /metadata) to establish how to interact with the receivers API (its capabilities). If the receiver does not support BaRS functionality the BaRS API will provide an error response to indicate this and the sender will pursue an alternative workflow.
A receiver may only implement a subset of the functionality within the standard and the CapabilityStatement will make this clear to a sender.
What is returned is a server level response to indicate what functionality the target API supports and how to interact with it. This includes its Version, Security, Endpoints and their associated parameters as well as which MessageDefinitions are supported.
Any given endpoint will describe its full capabilities as a client and as a server in response. As the Sender and Receiver roles are interchangeable in certain Application Workflows, all capabilities should be described.
The BaRS proxy will also respond with its own CapabilityStatement, which can be used as an example, by calling this endpoint and omitting the NHSD-Target-Identifier header.
operationId: getMeta
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/Capability'
example:
$ref: examples/metadata/BaRS_API_Capability_Statement.json
application/fhir+xml:
schema:
$ref: '#/components/schemas/Capability'
headers:
X-Correlation-Id:
description: 'The X-Correlation-Id from the request header, if supplied, mirrored back.'
schema:
type: string
format: uuid
example: 9562466f-c982-4bd5-bb0e-255e9f5e6689
X-Request-Id:
description: 'The X-Request-Id from the request header, if supplied, mirrored back.'
schema:
type: string
format: uuid
example: c1ab3fba-6bae-4ba4-b257-5a87c44d4a91
4XX:
$ref: '#/components/responses/4XX-BARS'
5XX:
$ref: '#/components/responses/5XX-BARS'
/MessageDefinition:
parameters:
- $ref: '#/components/parameters/RequestId_HParam'
- $ref: '#/components/parameters/CorrelationId_HParam'
- $ref: '#/components/parameters/RequestingOrganisation_HParam'
- $ref: '#/components/parameters/RequestingPractitioner_HParam'
- $ref: '#/components/parameters/RequestingDevice_HParam'
- $ref: '#/components/parameters/TargetIdentifier_HParam'
- $ref: '#/components/parameters/Accept_HParam'
get:
tags:
- Metadata
summary: Get Message Definition
description: |
### Returns MessageDefinitions supported by the target endpoint
The Message Definition retrieval is required to inform a Sender on building the payload. A request is made using the Service Identifier and workflow type values, linking to the useContext and event elements, respectively, in the Message Definition resource, returning a list of FHIR resources.
The order of workflow beyond this point is relatively flexible, the only stipulation being responses occurring after requests.
### Sender
The request for Message Definition is the next step for a Sender following the metadata acquisition.
The sender must request the Message Definition for the Service Identifier obtained previously, along with the type of workflow type e.g. booking-request, servicerequest-request. The Message Definition will contain a list of FHIR resources which the sender must include when making a booking or referral.
### Receiver
A receiver dictates what they need from a sender making a request and the MessageDefinition is the mechanism to support this. The Message Definition details what FHIR resources need to be included in the body (payload).
The receiver may support multiple services e.g. Out-of-Hours, Clinical Assessment Service under one organisation (on the same system) and consideration should be given to maintaining service identifiers and workflow type against Message Definitions. It's advisable to make this a configurable option which providers can maintain themselves as new services come onboard.
operationId: getMessageDefinition
parameters:
- $ref: '#/components/parameters/context_QParam'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/MessageDefinition'
example:
$ref: examples/message_definition/MessageDefinition_ServiceRequest-request_CaseTransfer.json
application/fhir+xml:
schema:
$ref: '#/components/schemas/MessageDefinition'
headers:
X-Correlation-Id:
description: 'The X-Correlation-Id from the request header, if supplied, mirrored back.'
schema:
type: string
format: uuid
example: 9562466f-c982-4bd5-bb0e-255e9f5e6689
X-Request-Id:
description: 'The X-Request-Id from the request header, if supplied, mirrored back.'
schema:
type: string
format: uuid
example: c1ab3fba-6bae-4ba4-b257-5a87c44d4a91
4XX:
$ref: '#/components/responses/4XX-BARS'
5XX:
$ref: '#/components/responses/5XX-BARS'
/$process-message:
parameters:
- $ref: '#/components/parameters/TargetIdentifier_HParam'
- $ref: '#/components/parameters/RequestId_HParam'
- $ref: '#/components/parameters/CorrelationId_HParam'
- $ref: '#/components/parameters/RequestingOrganisation_HParam'
- $ref: '#/components/parameters/RequestingPractitioner_HParam'
- $ref: '#/components/parameters/RequestingDevice_HParam'
- $ref: '#/components/parameters/Accept_HParam'
- $ref: '#/components/parameters/use-context_HParam'
post:
tags:
- Message
summary: Process a message
description: |
### Using $process-message
The inherent flexibility of the various workflows supported by BaRS is facilitated by the $process-message endpoint. The example in the "Try this API" feature for this endpoint is a referral request.
### Function
| Function| API Call|Description
| ---- | ---- | ---- |
| Making a referral request | POST /$process-message | The sender will POST a FHIR Bundle, including the FHIR resources defined in MessageDefinition requested previously, the 'focus' being a ServiceRequest resource, supported by Encounter, Observation, Flag etc. The MessageHeader resource will indicate the activity required through use of 'event', 'reason' and 'focus' data elements.<cr> The MessageHeader resource will indicate the activity required. An example of this can be found [here.](https://simplifier.net/NHSBookingandReferrals/79120f41-a431-4f08-bcc5-1e67006fcae0/~json)|
| Respond to a referral | POST /$process-message | A receiver wanting to respond to a request will direct their response to the Sender's $process-message endpoint, reversing the previous request/response roles. All implementers (senders or receivers) of BaRS must build a $process-message endpoint to be able to support the asynchronous workflows which involve such feedback responses. An example of this can be found [here.](https://simplifier.net/nhsbookingandreferrals/bc040878-cf51-4acf-9ede-7448fbb5be7c-duplicate-2)|
| Cancelling a referral | POST /$process-message | An updated payload request ensuring the status of the service request is set to 'revoked', as a minimum.An example of this can be found [here.](https://simplifier.net/nhsbookingandreferrals/a961e68a-50e9-4988-9b14-4bfa4629d761)|
| Making a booking | POST /$process-message | Once a slot has been identified, the sender makes a request to book through the $process-message endpoint. The receivers MessageDefinition defines the required FHIR resources and must including reference to the service request, if applicable. The MessageHeader resource will indicate the activity required.An example of this can be found [here.](https://simplifier.net/nhsbookingandreferrals/777a156c-af3c-4748-a8a3-7e95e4b0df9a)|
| Respond to a booking | POST /$process-message | A sender may receive a response to a booking they've made, for example, where a patient fails to attend. The original receiver (now the sender, in effect) will respond to the original sender (now the receiver) with an updated payload to reflect the current state of the booking e.g. DNA.|
| Cancelling a booking (and rebook) | POST /$process-message | An updated payload request ensuring the status of the appointment is set to 'cancelled', as a minimum.|
for more information on processing requests, please see the guidance within our [End-to-End Workflow](https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/Design--Core#End-to-end-workflow) documentation.
operationId: processMessage
requestBody:
description: Message Details
required: true
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/MessageBundle'
example:
$ref: examples/process_message/POST-body.json
application/fhir+xml:
schema:
$ref: '#/components/schemas/MessageBundle'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/MessageBundle'
example:
$ref: examples/process_message/POST-success.json
application/fhir+xml:
schema:
$ref: '#/components/schemas/MessageBundle'
headers:
X-Correlation-Id:
description: 'The X-Correlation-Id from the request header, if supplied, mirrored back.'
schema:
type: string
format: uuid
example: 9562466f-c982-4bd5-bb0e-255e9f5e6689
X-Request-Id:
description: 'The X-Request-Id from the request header, if supplied, mirrored back.'
schema:
type: string
format: uuid
example: c1ab3fba-6bae-4ba4-b257-5a87c44d4a91
4XX:
$ref: '#/components/responses/4XX-BARS'
5XX:
$ref: '#/components/responses/5XX-BARS'
/Slot:
parameters:
- $ref: '#/components/parameters/RequestId_HParam'
- $ref: '#/components/parameters/CorrelationId_HParam'
- $ref: '#/components/parameters/TargetIdentifier_HParam'
- $ref: '#/components/parameters/RequestingOrganisation_HParam'
- $ref: '#/components/parameters/RequestingPractitioner_HParam'
- $ref: '#/components/parameters/RequestingDevice_HParam'
- $ref: '#/components/parameters/Accept_HParam'
get:
tags:
- Slots
summary: Get slots
description: |
### Get available slots
A call to Slots is for querying a target endpoint for suitable slots to book a new Appointment into for a patient.
A request for slots support various filter parameters but requires the service identifier, slot status(es) and a timeframe to limit the search.
As documented in the [NHS Booking Standard](https://developer.nhs.uk/apis/uec-appointments/fs_slotmanagement.html), a receiver assigns the service identifier to groups of slots, under a schedule, which ties schedules together for a particular service.
operationId: getSlots
parameters:
- name: status
in: query
description: |
Status values that need to be considered for filter.
If attempting to filter by multiple status' they must be separated with commas as opposed to defining the query parameter twice as defined in [FHIR Guidance](https://hl7.org/fhir/search.html#combining)
For example "GET [base]/Slot?status=free,busy".
required: true
explode: true
schema:
type: array
items:
type: string
enum:
- free
- busy
default: free
- name: start
in: query
required: true
description: |
Slot start date/time (yyyy-mm-ddThh:mm:ss+00:00).
To search for time windows within which Slots must start, use "greater than" and "less than" searching.
For example "GET [base]/Slot?start=ge2022-03-01T12:00:00+00:00&start=le2022-03-01T13:30:00+00:00".
The definition of the time window within which Slots are requested is provided by using this parameter twice.
The values must include an offset indicating UTC in the [FHIR dateTime format](https://www.hl7.org/fhir/datatypes.html#primitive). This is the case for all dateTimes in the BaRS standard.
schema:
format: datetime
type: string
example: '2022-03-01T12:00:00+00:00'
- name: Schedule.actor:HealthcareService
in: query
required: false
description: |
A single service ID can be provided to indicate the service for which appointment slots are returned for.
schema:
type: string
example: '2000099999'
- name: _include
in: query
description: |
Inclusions that drive the rescusive depth of the search. There is a minimum of the following _include parameters required for current Applications.
* Slot:schedule
* Schedule:actor:HealthcareService
**Note**: Both _include and _revinclude share the same syntax - up to three components, separated by colon characters (:).
Unlike search queries, this is not a FHIRPath expression
The full list of applicable _includes are shown below. If any cannot be honored the Receiver will respond, ignoring the unsupported _include(s), with the url reflecting this omission in the responses Bundle.link.url.
|Expression | Inclusion |Description|
|------- |-------- |-------- |
| Slot:schedule | Schedule | Include Schedule Resources referenced within the Slot Resources|
| Schedule:actor:Practitioner | Practitioner | Include Practitioner Resources referenced within the Schedule Resources|
| Schedule:actor:PractitionerRole | PractitionerRole | Include Practitioner Role Resources referenced within the Schedule Resources |
| Schedule:actor:HealthcareService | HealthcareService | Include HealthcareService Resources referenced within the Schedule Resources|
| HealthcareService:providedBy | ProvidedBy | Include Organization Resources referenced within the HealthcareService Resources|
| HealthcareService:location | Location | Include Location Resources referenced within the HealthcareService Resources|
required: true
explode: true
schema:
type: array
items:
type: string
enum:
- 'Slot:schedule'
- 'Schedule:actor:Practitioner'
- 'Schedule:actor:PractitionerRole'
- 'Schedule:actor:HealthcareService'
- 'HealthcareService:providedBy'
- 'HealthcareService:location'
- 'Slot:*'
responses:
'200':
description: Success. A full example of a Slot Searchset response can be found [here]( https://simplifier.net/NHSBookingandReferrals/777a156c-af3c-4748-a8a3-7e95e4b0df9a-duplicate-2).
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/SearchBundleSlot'
example:
$ref: examples/slots/GET-success.json
application/fhir+xml:
schema:
$ref: '#/components/schemas/SearchBundleSlot'
headers:
X-Correlation-Id:
description: 'The X-Correlation-Id from the request header, if supplied, mirrored back.'
schema:
type: string
format: uuid
example: 9562466f-c982-4bd5-bb0e-255e9f5e6689
X-Request-Id:
description: 'The X-Request-Id from the request header, if supplied, mirrored back.'
schema:
type: string
format: uuid
example: c1ab3fba-6bae-4ba4-b257-5a87c44d4a91
4XX:
$ref: '#/components/responses/4XX-BARS'
5XX:
$ref: '#/components/responses/5XX-BARS'
/Appointment:
parameters:
- $ref: '#/components/parameters/RequestId_HParam'
- $ref: '#/components/parameters/CorrelationId_HParam'
- $ref: '#/components/parameters/TargetIdentifier_HParam'
- $ref: '#/components/parameters/RequestingOrganisation_HParam'
- $ref: '#/components/pa
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nhs-digital/refs/heads/main/openapi/booking-and-referral-fhir-api.yaml