NHS Booking and Referral Standard

Validation into CAS (Application 4) Change Log

This page will list all updates to the BaRS Application 4.

- Indicates a change inspired by provider or supplier feedback.

Key	Description
non-breaking	Non-breaking changed introduced to the standard since the last release
breaking	Breaking changed introduced to the standard since the last release
correction	Correction to the standard since the last release

2.0.0

This is a major release with a significant change to the Implementation Guidance and examples for v2.0.0. The changes are detailed in the change log.

Application Change Log

Change	Description	Impact
Updated requirements to support additional NHS No. Status	Extended requirement to support NHS No. status of 'Number present but not traced'	breaking

Payload Change Log

FHIR Element	Previous	Current	Other	Referral/Booking	Rationale	Impact
Patient.identifier.extension.valueCodeableConcept.coding.code	Follow UK Core guidance for populating this element	This SHOULD be populated. Where used this MUST be 'number-present-and-verified' or 'number-present-but-not-traced', else no NHS number MUST be sent. No other statuses are permitted.	Update	Validation Request	Accommodate NHS No. Requirement	breaking
Patient.identifier.extension.valueCodeableConcept.coding.display	Follow UK Core guidance for populating this element	This SHOULD be populated. Where used this MUST be populated with 'Number present and verified' or 'Number present but not traced'. No other statuses are permitted.	Update	Validation Request	Accommodate NHS No. Requirement	breaking
Patient.identifier.extension.valueCodeableConcept.coding.code	Follow UK Core guidance for populating this element	This SHOULD be populated. Where used this MUST be 'number-present-and-verified' or 'number-present-but-not-traced', else no NHS number MUST be sent. No other statuses are permitted.	Update	Intermin Validation Response	Accommodate NHS No. Requirement	breaking
Patient.identifier.extension.valueCodeableConcept.coding.display	Follow UK Core guidance for populating this element	This SHOULD be populated. Where used this MUST be populated with 'Number present and verified' or 'Number present but not traced'. No other statuses are permitted.	Update	Intermin Validation Response	Accommodate NHS No. Requirement	breaking
Patient.identifier.extension.valueCodeableConcept.coding.code	Follow UK Core guidance for populating this element	This SHOULD be populated. Where used this MUST be 'number-present-and-verified' or 'number-present-but-not-traced', else no NHS number MUST be sent. No other statuses are permitted.	Update	Full Validation Response	Accommodate NHS No. Requirement	breaking
Patient.identifier.extension.valueCodeableConcept.coding.display	Follow UK Core guidance for populating this element	This SHOULD be populated. Where used this MUST be populated with 'Number present and verified' or 'Number present but not traced'. No other statuses are permitted.	Update	Full Validation Response	Accommodate NHS No. Requirement	breaking

Previous Releases

1.2.3

This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.2.3.

Application Change Log

Change	Description	Impact
Simplified cancellation guidance	Updated cancellation guidance, for validations, under 'How does it work?', now pointing to Standard Patterns documentation. Reworded the description on use of Message Definitions when building a cancellation request.	non-breaking
Clarified cancellation payload guidance	Updated cancellation guidance, for validation, under 'Payloads for Requestors', clarifying a Validation can be considered as a type of 'referral' when reading Standard Pattern documentation.	non-breaking
Updates to Validation Request, Interim Validation Response, Validation Response	bundle.meta.versionID added to payload for consistency across BaRS documentation	correction
Interim Validation Response - CAS to 999 Rejected link to example	broken link resolved	correction
Updates to Scope and Requirements, Payloads for Responders and Validation Response payload	text "datetime" updated to "dateTime" for consistency	correction
patient.identifier.system	Implementation Guidance updated for consistency across BaRS documentation	correction

Payload Change Log

FHIR Element	Previous	Current	Other	Referral/Booking	Rationale	Impact
bundle.meta.versionID		This MUST be populated with the version of the Application the bundle complies with. The Receiver will read this to know whether they are capable of processing.	Update	Interim Validation Response	Implementation guidance added	correction
bundle.meta.versionID		This MUST be populated with the version of the Application the bundle complies with. The Receiver will read this to know whether they are capable of processing.	Update	Validation Response	Implementation guidance added	correction
bundle.meta.versionID		This MUST be populated with the version of the Application the bundle complies with. The Receiver will read this to know whether they are capable of processing.	Update	Validation Request	Implementation guidance added	correction
careplan.period.start	datetime	dateTime	Update	Validation Response	Implementation guidance added	correction
patient.identifier.system		This SHOULD be populated with the namespace for the Identifier	Update	Validation Request	Implementation Guidance consistent across all applications	correction
patient.identifier.system		This SHOULD be populated with the namespace for the Identifier	Update	Interim Validation Response	Implementation Guidance consistent across all applications	correction
patient.identifier.system		This SHOULD be populated with the namespace for the Identifier	Update	Validation Response	Implementation Guidance consistent across all applications	correction

Previous Releases

1.2.2

This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.2.2.

Application Change Log

Change	Description	Impact
Implementation Guidance updated	encounter.class.display value corrected from "Emergency" to "emergency"	correction
NHSD-Requesting-Practioner Examples updated	FHIRPractioner corrected to FHIRPractionerRole	correction

Payload Change Log

FHIR Element	Other	Referral/Booking	Rationale	Impact
encounter.class.display	Update	Validation Request	encounter.class.display value corrected from "Emergency" to "emergency" in Implementation Guidance	correction
encounter.class.display	Update	Interim Validation Response	encounter.class.display value corrected from "Emergency" to "emergency" in Implementation Guidance	correction
encounter.class.display	Update	Validation Response	encounter.class.display value corrected from "Emergency" to "emergency" in Implementation Guidance	correction

1.2.1

Application 4 has been updated to now support additional use cases. This application supports the use of the following use cases:

999 Ambulance Service Trust (AST) validation request to Clinical Assessment Service (CAS)
999 AST to Falls Lifting Service (new)
999 AST to Community Services (new)

New Use Case Categories have been added to support the new use cases.

Application Change Log

Change	Description	Impact
use case codes added	use case codes were not explicitly defined	correction

1.2.0

Application 4 has been updated to now support additional use cases. This application supports the use of the following use cases:

999 Ambulance Service Trust (AST) validation request to Clinical Assessment Service (CAS)
999 AST to Falls Lifting Service (new)
999 AST to Community Services (new)

New Use Case Categories have been added to support the new use cases.

Application Change Log

Change	Description	Impact
- New Use-Cases added	New use cases added for use in Application 4 - 999 AST to Falls Lifting Service (new), 999 AST to Community Services (new)	non-breaking
- Updated guidance	Updated guidance to include the new use cases including examples for use in Application 4.	non-breaking

Payload Change Log

FHIR Element	Previous	Current	Other	Referral/Booking	Rationale	Impact
ServiceRequest.category.coding			Update	Booking/Referral Request	Updated guidance to reflect this additional value for use case categories	Addition

1.1.1

This release includes the latest Use-Cases Category codes used by Application 4.

Application Change Log

Change	Description	Impact
New Use-Case Category codes	New Use-Cases Category codes added for use in Application 4.	correction
Updates to Application 4 Examples	Updates to all Application 4 Examples to include the latest Use-Case Category codes.	non-breaking

Payload Change Log

FHIR Element	Previous	Current	Other	Referral/Booking	Rationale	Impact
ServiceRequest.category.code			Update	Validation Request / Interim Response / Final Response	The new Use-Case Codes have been made generic	correction
Patient.extension.valueCodeableConcept	Patient.extension.url.valueCodeableConcept	Patient.extension.valueCodeableConcept	Update	Validation Request / Interim Response / Final Response	FHIR path incorrect	correction
Patient.extension.valueCodeableConcept.coding	Patient.extension.url.valueCodeableConcept.coding	Patient.extension.url.valueCodeableConcept.coding	Update	Validation Request / Interim Response / Final Response	FHIR path incorrect	correction
Patient.extension.valueCodeableConcept.coding	1..1	0..*	Update	Validation Request / Interim Response / Final Response	FHIR path incorrect	correction
Patient.extension.valueCodeableConcept.coding.system	Patient.extension.url.valueCodeableConcept.coding.system	Patient.extension.valueCodeableConcept.coding.system	Update	Validation Request / Interim Response / Final Response	FHIR path incorrect	correction
Patient.extension.valueCodeableConcept.coding.code	Patient.extension.url.valueCodeableConcept.coding.code	Patient.extension.valueCodeableConcept.coding.code	Update	Validation Request / Interim Response / Final Response	FHIR path incorrect	correction
Patient.extension.valueCodeableConcept.coding.display	Patient.extension.url.valueCodeableConcept.coding.display	Patient.extension.valueCodeableConcept.coding.display	Update	Validation Request / Interim Response / Final Response	FHIR path incorrect	correction
Patient.extension.valueCodeableConcept	Patient.extension.url.valueCodeableConcept	Patient.extension.valueCodeableConcept	Update	Booking Request	FHIR path incorrect	correction

1.1.0

This is v1.1.0 - Validation into CAS(Application 4) which include the new requirement to reject a validation request from the CAS.

Application Change Log

Change	Description	Impact
New Reject Validation Request functionality	This version introduces a new requirement that allows a Responder(Receiver) to reject a validation request. e.g Failed Contact	non-breaking
New Use Case Category added	In line with the future direction of BaRS, Application 4 now requires an additional ServiceRequest.category.code. This drives workflow.	breaking
New guidance for Use Case Category	In line with the future direction of BaRS, Application 4 now requires an additional ServiceRequest.category.code in the ServiceRequest resource. This has been updated throughout the guide to include references to the new Use Case Category. Additional information about the use of Use Case Category can be found in standard pattern for BaRS operations.	breaking
Bug fixes	A number of bug fixes and corrections have been made to the implementation guidance for Application 4	correction

Payload Change Log

FHIR Element	Previous	Current	Other	Referral/Booking	Rationale	Impact
Encounter.status			New	Interim Response	A status of 'cancelled' is to be used	non-breaking
Encounter.reasonCode.coding.system	FIXED		New	Interim Response	No longer a fixed value. A new CodeSystem is used when a Rejection is sent. https://fhir.nhs.uk/CodeSystem/rejected-reasons-bars	non-breaking
Encounter.reasonCode.coding.code	FIXED		New	Interim Response	No longer a fixed value. A Code from the relevant CodeSystem should be used.	non-breaking
Encounter.reasonCode.coding.display	FIXED		New	Interim Response	No longer a fixed value. A Display from the relevant CodeSystem should be used.	non-breaking
Encounter.reasonCode.text			New	Interim Response	Supporting text for the Rejection can now be included	non-breaking
ServiceRequest.category	0..1	1..1		Validation Request / Interim Response / Final Response	Updated in line with the BaRS Profile	correction

1.0.0

This is v1.0.0 - Validation into CAS(application 4) which supports the use case:

for 999 Ambulance Service Trust (AST) validation requests to Clinical Assessment Service (CAS)

Application Change Log

Change	Description	Impact
Application 4 released	The release of Referral into UEC for Validation (Application 4) v1.0.0 to the guide	breaking
- Correction to Interim Message Definition	Correction to BaRS-messageDefinition-serviceRequest-response-validation-interim message definition in line with example and ERD, to include missing resources: HealthcareService, PractitionerRole, Practitioner, Organization	non-breaking
Correction to Interim Response payload	Correction to Interim Response payload in line with example and ERD to include HealthcareService resource in line with example and ERD	non-breaking
Guidance update for Encounter	Correction to Interim Response payload guidance for Encounter, Practitioner and PractitionerRole to reference Responder rather than Requester in line with example and ERD	non-breaking
Interim Payload correction	Correction to Interim Response payload to remove ServiceRequest.basedon and ServiceRequest.location.reference in line with example	non-breaking
Corrections to Implementation Guide documentation.	Minor text corrections to the guide to maintain consistency	non-breaking
Correct MessageHeader.Definition for Interim and Final Response	Update the payload implementation guidance to reference the correct Message Definition for Interim and Final Responses.	correction
Correction to Flag (Scene Safety) guidance	Correction to Flag (Scene Safety) guidance for Validation request and Final validation Response.	non-breaking
Correction to scene-safety-codes-bars codesystem	Codes referencing "trapped" have been removed from the Scene Safety Codes	correction

Payload Change Log

FHIR Element	Previous	Current	Other	Referral/Booking	Rationale	Impact
ServiceRequest.performer.reference	MUST	SHOULD		Interim Response	In line with update to guidance as a non breaking change	non-breaking
Encounter (Interim)	1..3	2..2		Interim Response	An Interim response includes 2 encounter resources (requester's and responder's).	breaking

1.0.0-beta

This is a pre-release of v1.0.0-beta - Validation into CAS(application 4) which supports the use case - for 999 Ambulance Service Trust (AST) validation requests to Clinical Assessment Service (CAS)

Application Change Log

Change	Description	Impact
Application 4 released	The first release of Referral into UEC for Validation (Application 4) v1.0.0-beta to the guide

Payload Change Log

FHIR Element	Previous	Current	Other	Referral/Booking	Rationale	Impact