From 6d5a7c7f3d5d0fcc96ea2d0f321372f2e9c7e755 Mon Sep 17 00:00:00 2001
From: Carl De'ath <74620667+cda69@users.noreply.github.com>
Date: Tue, 24 Mar 2026 10:45:49 +0000
Subject: [PATCH 1/4] NBRS-4518
Response Encounter.statusHistory amended
---
.../TRN-APP6/1.0.0-beta.7.page.md | 6 ++-
.../BaRS-APP6/Response-Payload.page.md | 53 +++++++++----------
2 files changed, 30 insertions(+), 29 deletions(-)
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.7.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.7.page.md
index 66dc9142..b5fb41b3 100644
--- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.7.page.md
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP6/1.0.0-beta.7.page.md
@@ -20,8 +20,10 @@ This is a minor "patch" with clarifications to limited areas of the Implementati
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| patient.id | This SHOULD be populated with the name of the questionnaire responses contained within. | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | Update | Referral Request |Bug fix | correction |
| patient.id | This SHOULD be populated with the name of the questionnaire responses contained within. | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | Update | Referral Response |Bug fix | correction |
-
-
+| Encounter.statusHistory | List of past and current encounter statuses | List of past and current encounter statuses. These SHOULD NOT be populated in the Receiver's Encounter and asynchronous responses. | Update | Referral Response |Bug fix | correction |
+| Encounter.statusHistory.status | The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them | This SHOULD NOT be populated in the Receiver's response Encounter. | Update | Referral Response |Bug fix | correction |
+| Encounter.statusHistory.period | The time that the encounter was in the specified status. | This SHOULD NOT be populated in the Receiver's response Encounter. | Update | Referral Response |Bug fix | correction |
+| Encounter.statusHistory.period.start | The time that the encounter started in the specified status. | This SHOULD NOT be populated in the Receiver's response Encounter. | Update | Referral Response |Bug fix | correction |
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------|
-| Encounter | https://simplifier.net/hl7fhirukcorer4/ukcore-encounter | | 1..1 | |
-| Encounter.id | MUST only be generated by the originating system of the encounter as the id for the resource in the original HTTP request. It MUST be echoed back when returning an encounter. Subsequent new Encounters will be generated by the originating system of that encounter. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
-| Encounter.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
-| Encounter.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter |
-| Encounter.status | The status must be set to the current Encounter status:
- When the case is waiting for a resource to be allocated OR a resource has been cancelled, this MUST be populated with 'planned'
- When the case has had a resource allocated this MUST be populated with 'in-progress'
- For a case where the resource has cleared the scene this MUST be populated with 'finished'
- Where a Mutual Aid or Call Assist request is being rejected, this MUST be populated with 'cancelled' | MUST | 1..1 | in-progress |
-| Encounter.statusHistory | List of past and current encounter statuses | MUST | 0..* | |
-| Encounter.statusHistory.status |
The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them | MUST | 1..1 | planned |
-| Encounter.statusHistory.period |
The time that the encounter was in the specified status. | | | |
-| Encounter.statusHistory.period.start |
The time that the encounter started in the specified status. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 |
-| Encounter.class | | MUST | 1..1 | |
-| Encounter.class.system | This MUST be populated with CodeSystem 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | http://terminology.hl7.org/CodeSystem/v3-ActCode |
-| Encounter.class.code | This MUST be populated with Code 'EMER'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | EMER |
-| Encounter.class.display | This MUST be populated with Display 'emergency'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | emergency |
-| Encounter.subject | | MUST | 0..1 | |
-| Encounter.subject.reference | This MUST be a reference to the Patient resource. | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
-| Encounter.episodeOfCare | | MUST | 0..* | |
-| Encounter.episodeOfCare.reference | This MUST be populated with the JourneyID which links all encounters within the patient’s journey. This MUST be created at the patient’s first contact and passed in all subsequent referrals. | MUST | 1..1 | 9589fb37-87a2-48d8-968f-b371429208a8 |
-| Encounter.period | | MUST | 0..1 | |
-| Encounter.period.start | This MUST be populated with the Encounter start time. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
-| Encounter.reasonCode | Reason for Rejection -This MUST be populated if the response it a rejection. | MUST | 0..1 | |
-| Encounter.reasonCode.system | This MUST be populated with the following system - https://fhir.nhs.uk/CodeSystem/rejection-reason-bars | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/rejected-reasons-bars |
-| Encounter.reasonCode.code | This MUST be populated with a value from https://fhir.nhs.uk/CodeSystem/rejection-reason-bars | MUST | 0..1 | RRNA |
-| Encounter.reasonCode.display | This MUST be populated with the code description | MUST | 0..1 | Requested resource not available within timescale |
-| Encounter.reasonCode.text | This SHOULD be populated with a free text reason for cancellation. This MUST be populated if the Encounter.reasonCode.code is populated with 'OTH' | SHOULD | 0..1 | We have a paramedic but not available for 30 mins |
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|--------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|--------------------------------------------------------------|
+| Encounter | In this interaction this resource represents the Receiver's encounter. This is the focus resource for this response.
https://simplifier.net/hl7fhirukcorer4/ukcore-encounter | | 1..1 | |
+| Encounter.id | MUST only be generated by the originating system of the encounter as the id for the resource in the original HTTP request. It MUST be echoed back when returning an encounter. Subsequent new Encounters will be generated by the originating system of that encounter. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
+| Encounter.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Encounter.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter |
+| Encounter.status | The status must be set to the current Encounter status:
- When the case is waiting for a resource to be allocated OR a resource has been cancelled, this MUST be populated with 'planned'
- When the case has had a resource allocated this MUST be populated with 'in-progress'
- For a case where the resource has cleared the scene this MUST be populated with 'finished'
- Where a Mutual Aid or Call Assist request is being rejected, this MUST be populated with 'cancelled' | MUST | 1..1 | in-progress |
+| Encounter.statusHistory | List of past and current encounter statuses. These SHOULD NOT be populated in the Receiver's Encounter and asynchronous responses. | SHOULD NOT | 0..* | |
+| Encounter.statusHistory.status |
This SHOULD NOT be populated in the Receiver's response Encounter. | SHOULD NOT | 1..1 | |
+| Encounter.statusHistory.period |
This SHOULD NOT be populated in the Receiver's response Encounter. | SHOULD NOT | | |
+| Encounter.statusHistory.period.start |
This SHOULD NOT be populated in the Receiver's response Encounter. | SHOULD NOT | 1..1 | |
+| Encounter.class | | MUST | 1..1 | |
+| Encounter.class.system | This MUST be populated with CodeSystem 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | http://terminology.hl7.org/CodeSystem/v3-ActCode |
+| Encounter.class.code | This MUST be populated with Code 'EMER'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | EMER |
+| Encounter.class.display | This MUST be populated with Display 'Emergency'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | Emergency |
+| Encounter.subject | | MUST | 0..1 | |
+| Encounter.subject.reference | This MUST be a reference to the Patient resource. | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
+| Encounter.episodeOfCare | | MUST | 0..* | |
+| Encounter.episodeOfCare.reference | This MUST be populated with the JourneyID which links all encounters within the patient’s journey. This MUST be created at the patient’s first contact and passed in all subsequent referrals. | MUST | 1..1 | 9589fb37-87a2-48d8-968f-b371429208a8 |
+| Encounter.period | | MUST | 0..1 | |
+| Encounter.period.start | This MUST be populated with the Encounter start time. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| Encounter.reasonCode | Reason for Rejection -This MUST be populated if the response it a rejection. | MUST | 0..1 | |
+| Encounter.reasonCode.system | This MUST be populated with the following system - https://fhir.nhs.uk/CodeSystem/rejection-reason-bars | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/rejected-reasons-bars |
+| Encounter.reasonCode.code | This MUST be populated with a value from https://fhir.nhs.uk/CodeSystem/rejection-reason-bars | MUST | 0..1 | RRNA |
+| Encounter.reasonCode.display | This MUST be populated with the code description | MUST | 0..1 | Requested resource not available within timescale |
+| Encounter.reasonCode.text | This SHOULD be populated with a free text reason for cancellation. This MUST be populated if the Encounter.reasonCode.code is populated with 'OTH' | SHOULD | 0..1 | We have a paramedic but not available for 30 mins |
From 6f9ee2cd490dcf093dff2996f0b38e5ea3a08d77 Mon Sep 17 00:00:00 2001
From: Carl De'ath <74620667+cda69@users.noreply.github.com>
Date: Tue, 24 Mar 2026 10:50:56 +0000
Subject: [PATCH 2/4] NBRS-4486
Updated MessageDef Short Response to align with 9's OOA
---
...ageDefinition-ServiceRequest-Response-Referral-Short.xml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/MessageDefinition/BARS-MessageDefinition-ServiceRequest-Response-Referral-Short.xml b/MessageDefinition/BARS-MessageDefinition-ServiceRequest-Response-Referral-Short.xml
index 9e660ae8..60ed49c8 100644
--- a/MessageDefinition/BARS-MessageDefinition-ServiceRequest-Response-Referral-Short.xml
+++ b/MessageDefinition/BARS-MessageDefinition-ServiceRequest-Response-Referral-Short.xml
@@ -6,7 +6,7 @@
@@ -29,8 +29,8 @@
-
-
+
+
-
-
-
-
-
-