NHS Booking and Referral Standard

Guide v1.1.0 | Core v1.1.0

back

BaRS API Spec Change Log


This page will list all updates to the BaRS API Specification.

  - Indicates a change inspired by provider or supplier feedback.

Each section will reference only changes for its specific version.

1.0.0

Change Log

Change Description Impact
Additions to Headers and requirements change Additional header item and requirement changes for existing headers breaking correction
Additions and changes to query parameters New parameters and format changes to existing parameters breaking correction
Guidance and QoL changes Guidance updates and corrections correction
General Corrections and general changes. correction

This Section will list all updates to the BaRS API Specification within the 1.0.0 major release.

This Change log and the specification will be published in preparation for post the March 2023 post private beta release.

Headers

The Accept Header must now include a version. The version is mandatory, the specification now shows the Accept header as mandatory to reflect this.

--header 'Accept: application/fhir+json; version=1.0.0-beta'
  The following Access Control headers have been made mandatory where they are currently included.

  • NHSD-End-User-Organisation (Required)
  • NHSD-Requesting-Software (Required)
  The following Access Control headers have been reintroduced to the GET /metadata and GET /MessageDefinition endpoints. For consistency, the mandated items match other endpoints.

  • NHSD-End-User-Organisation (Required)
  • NHSD-Requesting-Software (Required)
  • NHSD-Requesting-Practitioner

Parameters

The following parameter has been added to the GET /ServiceRequest endpoint to support searching by identifiers.

  • ServiceRequest.identifier
    • This will be a unique booking reference number/identifier of a referral, or a unique UUID/GUID for the referral. This is not the same as the ServiceRequest.id

The context parameter for GET /MessageDefinition now allows a preferred system|value format, as opposed to a value.

/MessageDefinition?context=http://fhir.nhs.uk/Id/dos-service-id|2000099999

Guidance and QOL

The descriptions and guidance for all Access Control headers have been expanded.

  • NHSD-End-User-Organisation (Required)
  • NHSD-Requesting-Software (Required)
  • NHSD-Requesting-Practitioner

The description and guidance for _include parameters on GET /Slot has been expanded.

  • expressions have been added for clarity.
  • minimum usage guidance added.

A simplified diagram has been added to clarify the description of the end-to-end process in the API overview.

  Identified typos and spelling mistakes have been corrected.

The description and guidance for GET /metadata has been expanded.

  • usage and expected content has been added.
  • guidance on obtaining the BaRS Proxy CapabilityStatement has been Added.

General

The API Spec Version has been uplifted to 1.0.0

BaRS Proxy production URL has been added to the Environments and Testing section.

The error handling link now correctly refers to the BaRS Core implementation guidance.

  Broken links within the Specifications schema examples have been rectified.

Broken links to the BaRS Standard documentation have been rectified.

  Examples included within the Specifications files have been updated for clarity.

  Examples referenced by the Specification have been updated for clarity.

The production environment is now listed in the Specification.

The API is now described as in production beta.

1.1.0

Change Log

Change Description Impact
Publication of the 1.1.0 Specification along side 1.0.0 1.1.0 Specification (alpha) launched Addition
Additions of DocumentReference Endpoints Additional header item and requirement changes for existing headers Addition
Additions of use cases to context parameter example for GET /MessageDefinition New parameter additions correction
Example MessageDefinitions now contain a context code for use case. updated examples correction
Guidance and QoL changes Guidance updates and corrections correction
General Corrections and general changes. correction

This Section will list all updates to the BaRS API Specification within the 1.1.0 minor release.

Publication of the 1.1.0 API Specification

The API Spec page will now have a landing page to select the version of which you wish to view. At present this will present 1.0.0 and 1.1.0, with links to each specification.

DocumentReference

DocumentReference Endpoints have been added to the specification in preparation for future use cases.

The following endpoints are now available in the 1.1.0 specification. These endpoints will be used in future use cases and future iterations of current use cases.

  • GET /DocumentReference
  • POST /DocumentReference
  • GET /DocumentReference/[id]
  • PUT /DocumentReference/[id]
  • DELETE /DocumentReference/[id]

Parameters

The context parameter for GET /MessageDefinition has been ammended to accept a use case filter The target service identifier, Allowing the ability to filter returned message definitions by the specified service id, In this example a DoS id, can now be coupled with the BaRS use case category.

/MessageDefinition?context=http://fhir.nhs.uk/Id/dos-service-id|2000099999&context=https://fhir.nhs.uk/CodeSystem/usecases-categories-bars|REFERRALTOPHARMACY

Guidance and QOL

Additional Guidance for the GET /Slot endpoint.

Further guidance surrounding the usage of the include query parameter for GET /Slot has been added.

General

Further Typos and/or spelling and grammar errors have been corrected

back to top