NHS Booking and Referral Standard

Guide v1.1.0 | Core v1.1.0

back

Booking and Referrals into UEC (application 1) Change Log


This page will list all updates to the BaRS Application 1

  - 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

1.0.1

Application Change Log

This is a minor "patch" adressing a few small issues with the 1.0.0 release of the implementation guide.


Change Description Impact
Updated items to Change Log v1.0.0 Several corrections and updates have been made to the Change Log for BaRS-UEC1 v1.0.0 and 3 elements added to the change log. correction
Additional items added to Change Log v1.0.0 3 additional lines have been added that were missing from the original Change Log for BaRS-UEC1 v1.0.0 : MessageHeader.destination.endpoint, MessageHeader.source.endpoint, ServiceRequest.category.coding.display correction
Added additional cancellation guidance Additional guidance in the "how does it work?" section for the two cancellation flows was added to provide more clarification on payload composition non-breaking
Updated workflow diagram on How it works page Update the workflow image on how it works to remove referrence to ITK correction

Previous Releases


1.0.0

Application Change Log

Releasing of v1.0.0 following the sucessful Private Beta of BaRS-UEC1. There are a number of updates that have been applied since v1.0.0-alpha that have informed by the Private Beta. These are all detailed the in the change logs.

Change Description Impact
Referral response - e.g DNA/WNB The requirment to have the ability to send or receive referral responses like DNA/WNA(Safeguarding) resposnes has been removed from this version. There is no policy supporting this functionality currently. The responsability of the safeguarding will lie with the receiver. breaking
Use of BaRS-UEC1 to UTC The use of BaRS-UEC1 has been approved for use in 111-UTC, CAS-UTC non-breaking
  Flexible workflows are now optional
As long as an application supports a combined booking and referral or a standalone referral this meets the flexibility requirements. non-breaking
  Book-Rebook-Cancel
The previous requirement to mandate a sender to make a new booking prior to cancelling their original booking has been clinically reviewed and relaxed to allow the original booking to be cancelled first. non-breaking

Payload Change Log

FHIR Element Previous Current Other Referral/Booking Rationale Impact
MessageHeader.extension.CDSSExtension Software and Version Should Must Ref, Book Increased necessity for the current application. breaking
MessageHeader.destination.endpoint Updated Ref, Book Updated endpoint guidance to use the HTTPS instead of HTTP as this is more consistent with the current format. correction
MessageHeader.source.endpoint Updated Ref, Book Updated endpoint guidance to use the HTTPS instead of HTTP as this is more consistent with the current format. correction
MessageHeader.source.contact.system Must Should Ref, Book Relaxed necessity for the current application. non-breaking
MessageHeader.source.contact.value Must Should Ref, Book Relaxed necessity for the current application. non-breaking
MesssageHeader.definition Could Must Ref, Book Increased necessity for the current application to enable validation of the payload. breaking
MessageHeader.eventCoding.coding.display Should Must Ref, Book Increased necessity for the current application. This human readable value is being used for display to users. breaking
MessageHeader.reason.coding.display Should Must Ref, Book Increased necessity for the current application. This human readable value is being used for display to users. breaking
ServiceRequest.occurancePeriod.start Must Should Ref Relaxed necessity for the current application. correction
ServiceRequest.occurancePeriod.end Must Should Ref Relaxed necessity for the current application. correction
ServiceRequest.requester - Should Ref Updated necessity for the current application non-breaking
ServiceRequest.category.coding.display Should Must Ref Increased necessity for the current application. breaking
ServiceRequest.location Must May Ref Relaxed necessity for the current application. correction
ServiceRequest.supportingInfo - Should Ref Updated necessity for the current application. non-breaking
ServiceRequest.patientInstruction Removed Ref Removed, information is now contained within the careplan. non-breaking
Patient.extension.coding.display(NHS Number) Could Should Ref, Book Increased necessity for the current application. The human readable value is being used for display to users. correction
Patient.address - Should Ref, Book Updated necessity for the current application. correction
Patient.contact.extension(contactPreferrence) Must - Removed Ref, Book Removed, contact ext has been removed this is now communicated in through rank only. breaking correction
Patient.contact.telecom Should Must Ref, Book Increased necessity for the current application. There must always be a contact. breaking correction
Patient.extension(Birthsex) Removed Ref, Book Removed, this is to be recorded as an Observation correction
Patient.extension(Religion) Removed Ref, Book Removed, there are no values for this in UK Core. No additional guidance over core FHIR guidance. correction
Practitioner.identifier - Must Ref, Book Updated necessity for the current application. breaking
PractitionerRole.practioner.reference - Must Ref, Book Updated necessity for the current application. breaking
PractitionerRole.organization.reference - Must Ref, Book Updated necessity for the current application. breaking
MedicationStatement Updated Ref Updated the overall guidance for the resource. All necessity is based on UK Core. correction
MedicationStatement.subject.reference Should Must Ref Increased necessity for the current application. If there is a medication resource there MUST be a reference to the patient breaking
AllergyIntolerance Updated Ref Update the overall guidance for the resource. All necessity is based on UK Core. correction
Flag.category - Must Ref Updated necessity for the current application. To ensure the business process can be successfully executed. breaking
Flag.code - Must Ref Updated necessity for the current application. To ensure the business process can be successfully executed. breaking
QuestionnaireResponse.extension(Reason) - Must Ref Updated necessity for the current application. Without the extension you do not know what you are processing. breaking correction
QuestionnaireResponse.subject - Must Ref Updated necessity for the current application. breaking correction
QuestionaireResponse.item Must Updated Ref Updated necessity for the current application. See guidance on the way to use nested items for QuestionaireResponse. breaking correction
Observation.performer Must Should Ref Relaxed necessity for the current application. When using 111 Online the performer is the patient and therefore not always required. e.g BirthSex non-breaking
Observation.note Could Should Not Ref Updated necessity for the current application. Notes in an observation SHOULD be in the CarePlan. non-breaking
HealthcareService - Must Added Ref, Book Added resource to the guidance. The whole resource is included in the examples breaking correction
Consent.scope - Must Ref Updated necessity for the current application. breaking correction
Consent.category - Must Ref Updated necessity for the current application. breaking correction
Consent.patient.referrence - Must Ref Updated necessity for the current application. breaking correction
Consent.policyRule - Must Ref Updated necessity for the current application. breaking correction
Consent.dateTime - Must Ref Updated necessity for the current application. breaking correction
Booking Only
Appointment - Updated Book Updated the overall guidance for the resource. non-breaking
Appointment.status - Must Book Updated necessity and guidance for the current application. breaking correction
Appointment.start - Must Book Updated necessity and guidance for the current application. breaking correction
Appointment.end - Must Book Updated necessity and guidance for the current application. breaking correction
Appointment.slot.referrence - Must Book Updated necessity and guidance for the current application. breaking correction
Appointment.created - Must Book Updated necessity and guidance for the current application. breaking correction
back to top