NHS Booking and Referral Standard

Guide v1.8.1 | Core v1.1.5 | Package v1.34.0

General Improvements Change Log

This page will list all general improvements for BaRS.

handshake

- Indicates a change inspired by provider or supplier feedback.

1.8.1

Implementation Guide Changes

Change	Description
Use case categories added	All applications have been updated with their required use of use case categories
Existing use case categories have been corrected where needed	existing use case categories have been corrected where required
BaRS Core addition of use context header	HTTP header for auditing and logging has been added to assist with NHSE reporting.
Bug fixes and corrections	There have been several bug fixes and corrections in the guide, these includes typos, broken links or corrections.
Improvements to the the Build Section	Several improvements to the Testing and Environments pages
Application 6 TKW changes	Application 6 is now available in the TKW

Previous Releases

1.8.0

Implementation Guide Changes

Change	Description
Applications 1 and 2 minor updates	Corrections to the FHIR element guidance for HealthcareService.identifier.value
Applications 4 - New Use Cases	Application 4 expands functionality to additional use cases, Falls Lifting Service and Community Services.
Applications 5 - New Use Cases	Application 5 expands functionality to additional use cases, Oral Contraception, Blood Pressure and Online Consultations.
Applications 6 minor updates	Application 6 has been updated to include links to the examples created for the application.
Applications 7 v1.0.0-alpha Release	Application 7 v1.0.0-alpha has now been released (under pre-releases)
Core Updates - v1.0.4 and v1.1.4	Updated examples and guidance for both versions.
Core Updates - v1.2.0-alpha	Publication of the 1.2.0-alpha Specification along side existing core version 1.0.0 and 1.1.0
Deploy section revised	The Deployment guidance has been updated to reflect the supplier and provider feedback and to align with the structure of the Beta Deployment Guide
Bug fixes and corrections	There have been several bug fixes and corrections in the guide, these includes typos, broken links or corrections.

1.7.0

Implementation Guide Changes

Change	Description
- Applications 5 moved to v1.0.0	Applications 5 has been moved from the pre-releases section to the "BaRS Applications" section to reflect progression from beta to stable release
Bug fixes and corrections	There have been several bug fixes and corrections in the guide, these includes typos, broken links or corrections.

1.6.0

Implementation Guide Changes

Change	Description
Application 4,5,6 Use Context Updates	Updated the description and use context codes throughout the applications 4,5,6.
Addition of Use Context for Application 1,2,3	Use Context has been added to Applications 1,2,3 to ensure all applications of BaRS now work in a consistant manner and will support the multiple use use cases of each application.
Concurrent Core Versions	Core Versions were split for concurrent versions. Command 'pagelink' could not render: Page not found. branches from previous 1.2.1 excluding feature additions 1.2.x (alpha).
Updates to Standard Patterns	There has been an update across the guide to move standard patterns to a central area

Implementation Guide Changes

Change	Description
Application 1 Scope change	This BaRS application has now been made available for use with a number of additional use cases
Application 2 Scope Change	This BaRS application has now been made available for use with a number of additional use cases
- Application 4 v1.1.0 release	Application 4 v1.1.0 has now been released and includes new functionality that allows a Receiver(Responder) to send a Rejection response in an Interim message.
- Application 6 v1.0.0-beta release	Application 6 v1.0.0-beta has now been released (under pre-releases)
Header Logo changed	Changed header logo from NHS Digital to NHS England
Package version reference added	"Hero Banner" updated with reference to package version
Release notes updated	Release notes page updated to include the package version too
- Versioning tables simplified	The Versioning Matrix and Application page version tables have undergone several adjustments following feedback
- Min Versioning correction in pre-release	The Min Versioning for applications have been corrected for pre-release versions.

Implementation Guide Changes

Change	Description
New application added	Added new section for Application 6 (under pre-releases)
- Applications 3 moved to v1.0.0	Applications 3 has been moved from the pre-releases section to the "BaRS Applications" section to reflect progression from beta to stable release
- Applications 4 moved to v1.0.0	Applications 4 has been moved from the pre-releases section to the "BaRS Applications" section to reflect progression from beta to stable release
- New "Versioning Matrix" section added	New section was added to "BaRS Applications" and "BaRS Pre-Releases" sections
Changes to BaRS Application 1,2 and 5	Minor corrections and updates across applications 1,2 and 5 with full details listed on the individual change logs.

Implementation Guide Changes

Change	Description
Publication of Referral into UEC (Application 3)	The first publication of documentation for Referral into UEC (Application 3) v1.0.0-beta to the guide
Publication of Referral into UEC for Validation (Application 4)	Ther first publication of documentation for Referral into UEC for Validation (Application 4) v1.0.0-beta to the guide
Message Header guidance moved to Core	All guidance for Message Header has been moved out of the individual applications to Standard Pattern for BaRS Operations
Cancellation guidance moved to Core	All guidance for Cancellations has been moved out of the individual applications to Standard Pattern for BaRS Operations
Changes to BaRS Application 1	Referrenced failure scenarios in the Requirements-Referral/Booking that discuss these scenarios. Grammer corrections throughout. The removal of the NHSD-Requesting-Person = {FHIR Person (Base64 Encoded)} as mentioned in the API spec from the 'How Does it work' text. Correction to the description of the use of Certificates and endpoints within Constraints. Moved generic Message Header guidance to Standard Pattern for BaRS Operations.
Changes to BaRS Application 2	Referrenced failure scenarios in the Requirements-Referral/Booking that discuss these scenarios. Grammer corrections throughout. The removal of the NHSD-Requesting-Person = {FHIR Person (Base64 Encoded)} as mentioned in the API spec from the 'How Does it work' text. Correction to the description of the use of Certificates and endpoints within Constraints. Moved generic Message Header guidance to Standard Pattern for BaRS Operations.
Changes to BaRS Application 5	Grammer corrections throughout. The removal of the NHSD-Requesting-Person = {FHIR Person (Base64 Encoded)} as mentioned in the API spec from the 'How Does it work' text. Correction to the description of the use of Certificates and endpoints within Constraints.
Change to Authentication and Authorisation	The removal of the NHSD-Requesting-Person = {FHIR Person (Base64 Encoded)} as mentioned in the API spec from the 'How Does it work' text. Moved generic Message Header guidance to Standard Pattern for BaRS Operations.

Implementation Guide Changes

Change	Description
Application 5 v1.0.0-beta update	Multiple changes made to Application 5 : BaRS-APP5
API Implentation Guidance	Corrections To guidance and aesthetic changes
Build> Testing and Environments> Onboarding	Correction to Receiver Firewall Amendments - IPs updated
Build> Testing and Environments> TKW	Updated all Patient.Identifier sentinel values to reflect traceable patients on the INT Spine
Build> Testing and Environments> TKW	Added new table with list of full patient details to allow full PDS traces on INT Spine
Build> Testing and Environments> TKW	Updated UserTest DoS Service 2000071898 because the name has changed
Caching Requirements	Moved from BaRS Applications (1 and 5) to BaRS Core

Implementation Guide Changes

Change	Description
New application added	Added new section for Application 5

Implementation Guide Changes

Change	Description
Fixed issue with menu in Design/BaRS Core	The "Failure Scenarios" subsection had an erroneous entry in left-hand navigation. This has been removed
Updated release notes structure	This change was to accomodate historical releases by hiding them in an expander
Improved release notes navigation	a "back" button was added to each of the release note detail sections
Updated FHIR assets section	Simplified approach with a link out to the full Simplifier project
TKW - Updated context description	Now includes detail of deployment on INT and rationale adopting this appraoch
TKW - Corrected sentinel values	Some sentinel values for referencing UserTest DoS were out of date and did not return
TKW - Updated Response scenarios	Added the sentinel values, under the Scenarios section, to elicit responses for interim and full Validation responses
TKW - Added table of DoS Service Ids	Table of DoS Service Ids and how to obtain them to use as sentinel values for TKW Scenarios
TKW - Updated image	Update image detailing how to use MAIT Portal to send requests to a Receiver solution
BARS-UEC-1 Application	Corrected how elements ServiceRequest.supportInfo and CarePlan.supportingInfo must be populated
BARS-UEC-2 Application	Corrected how elements ServiceRequest.supportInfo and CarePlan.supportingInfo must be populated
Fixed broken or incorrect links on "Home Page"	Some links were linking to the wrong page
Help and Support - fixed broken external links	Some external linkswere broken or still "boiler plate" links
Updated Change Log naming	Change Log names have been changed to more in line with the rest of the change log names
Updated wording on releases	Wording of guidance around support for new releases of Core was updated to provide more clarity

General Improvements

Improvement	Rationale
Digital Onboarding	Development of the SCAL process for BaRS to a digital, self service platform.
Endpoint Review process	A Review process for changes to the Endpoint Catalogue to lower the chance of misconfiguration.
TKW	Development and release of the TKW tool to support the developmment of BaRS V1.0.0
New BaRS Application Names	New naming convention for BaRS Applications and the use cases that they are endorsed to support

Implementation Guide Changes

Change	Description
First release of the Implementation Guide	All aspects of the Implementation Guide have either been created or updated as part of the creation and release of v1.0.0 of the BaRS Standard

back to top