From 4a5006e0a9f098b71655042bcf384888f0f99f00 Mon Sep 17 00:00:00 2001 From: luci-davies Date: Mon, 23 Mar 2026 11:12:43 +0000 Subject: [PATCH 01/12] App 8 review - changes agreed --- .../BaRS-Applications/Applications/BaRS-APP8/Index.page.md | 4 +--- .../Applications/BaRS-APP8/Scope-and-Requirements.page.md | 6 +++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md index 83de00cc..519751e3 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md @@ -33,7 +33,7 @@ This application supports the use of the following use cases: |Use case | Name | Code| |--------------------------------------------------------------------------------|------|------| -| Improved Advice and Guidance to electronic-Referral Service (e-RS)| IAG to e-RS | A8T1 | +| Advice and Guidance to electronic-Referral Service (e-RS)| AG to e-RS | A8T1 | | 111Online to electronic-Referral Service (e-RS)| 111online to e-RS | A8T2 | | NHS.UK to electronic-Referral Service (e-RS)| nhs.uk to e-RS | A8T3 | @@ -48,6 +48,4 @@ This page provides guidance for implementing the Referral Standard (BaRS) specif NHS England teams within Referrals and Appointments, Digitial Urgent and Emergency Care and the National Pathway for Self-Referrals have co-produced the Application 8 standard to facilitate interoperability between existing systems for referral pathways. -This page provides guidance for implementing the Referral Standard (BaRS) specifically for the use cases listed above. It should be used alongside the {{pagelink:design-core-1.4.0, text:BaRS Core implementation guide}} and Payload Definitions when developing to the standard. -
\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md index 909ee480..7656dafa 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md @@ -6,7 +6,7 @@ TOPIC: APP8-ScopeAndRequirements ### Scope Overview This BaRS Application (Referrals from Advice and Guidance to eRS broker, Application 8) supports the following use case(s) ONLY: -* Improved Advice and Guidance to electronic-Referral Service (e-RS) +* Advice and Guidance to electronic-Referral Service (e-RS) * 111Online to electronic-Referral Service (e-RS) * NHS.UK to electronic-Referral Service (e-RS) @@ -55,7 +55,7 @@ The payload and workflow have been designed to support these services. Other {{p **Referral** - The referral Receiver **must** accept the referral request regardless of whether the patient is known to the service provider -- The referral Receiver **must** only accept potential patients who do **have** a national validated identifier e.g. NHS Number +- The referral Receiver **must** only accept potential patients who **have** a national validated identifier e.g. NHS Number - The national identifier **must** have a [verification status](https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-nhsnumberverificationstatus) of 'Number present and verified' otherwise, the referral Sender **must not** include it in the request - Any new or existing safeguarding concern, recorded as part of the assessment, **must** be included in the referral Sender's request - The referral Receiver **must** clearly identify any included safeguarding concern to the end user @@ -64,7 +64,7 @@ The payload and workflow have been designed to support these services. Other {{p - Where the referral was not successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.4.0, text:failure scenarios}} for more detail - Where the referral was not successful, the Sender **must** present an appropriate message to the end user. See {{pagelink:core-failure_scenarios-1.4.0, text:failure scenarios}} for more detail - The referral Sender **must** indicate consent to share (for Direct Care) to the Receiver -- The referral Sender **must** indicate the urgency (using the agreed codeset) of the request to the Receiver +- The referral Sender **must** indicate the urgency (using the [agreed codesystem](https://simplifier.net/nhsbookingandreferrals/bars-broker-priority-status)) of the request to the Receiver ### Audit From 9a28ea0f2321ff790a3d4607f29a1f36f63e3894 Mon Sep 17 00:00:00 2001 From: luci-davies Date: Mon, 23 Mar 2026 13:42:52 +0000 Subject: [PATCH 02/12] BP and OC text and table updates --- .../Applications/BaRS-APP5/Index.page.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md index 6e2ab0e5..31e5a701 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md @@ -30,6 +30,8 @@ topic: Application5 @@ -39,12 +41,12 @@ topic: Application5 This application supports the use of the following use cases: -| Use Case | Name | Code | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|-------| -| Deprecated - Primary Care to Community Pharmacy (Pharmacy First) | Primary Care to Community Pharmacy | referraltopharmacy | -| Primary Care to Community Pharmacy (Pharmacy First) | Primary Care to Community Pharmacy| A5T1 | -| Primary Care to Pharmacy Contraception (Oral Contraception for supply of initial or repeat prescriptions for Combined Oral Contraceptive (COC) or Proestogen Only Pill (POP)) | Primary Care to Pharmacy Contraception | A5T2 | -| Primary Care to Pharmacy Blood Pressure Check Service | Primary Care to Pharmacy Blood Pressure Check Service | A5T3 | +| Use Case | Name | Code | Status | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|-------|-------| +| Deprecated - Primary Care to Community Pharmacy (Pharmacy First) | Primary Care to Community Pharmacy | referraltopharmacy | Deprecated | +| Primary Care to Community Pharmacy (Pharmacy First) | Primary Care to Community Pharmacy| A5T1 | Live | +| Primary Care to Pharmacy Contraception (Oral Contraception for supply of initial or repeat prescriptions for Combined Oral Contraceptive (COC) or Proestogen Only Pill (POP)) | Primary Care to Pharmacy Contraception | A5T2 | Withdrawn | +| Primary Care to Pharmacy Blood Pressure Check Service | Primary Care to Pharmacy Blood Pressure Check Service | A5T3 | Withdrawn | NB - 'Primary Care' currently includes GP Practice and Online Consultation, as described in the [BaRS Clinical Safety Case Report (CSCR)](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/onboarding-support-information#downloads) From 39953f6d135fee20f9342ed3c76a5d8e2eac851a Mon Sep 17 00:00:00 2001 From: luci-davies Date: Mon, 23 Mar 2026 13:54:17 +0000 Subject: [PATCH 03/12] App 5 change log --- .../TRN-APP5/1.1.4.page.md | 7 ++++- .../TRN-APP5/1.2.0.page.md | 30 +++++++++++++++++++ .../Technical-Release-Notes/TRN-APP5/toc.yaml | 2 ++ 3 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.1.4.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.1.4.page.md index 3812e608..b91fe72d 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.1.4.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.1.4.page.md @@ -1,3 +1,5 @@ +
+
## {{page-title}}
@@ -23,8 +25,11 @@ This stable release (v1.1.4) of Application 5 sees minor corrections. | Patient.identifier.extension.valueCodeableConcept.coding.code | This SHOULD be populated. Where used this MUST either be number-present-and-verified or no NHS number MUST be sent, no other status is valid | 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 | Referral Request |Accommodate NHS No. Requirement | breaking | | Patient.identifier.extension.valueCodeableConcept.coding.display | This SHOULD be populated. Where used this MUST either be populated with 'Number present and-verified' no other status is valid | 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 | Referral Request |Accommodate NHS No. Requirement | breaking | +
+
+
-### Previous Releases + diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md new file mode 100644 index 00000000..3b0e8f97 --- /dev/null +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md @@ -0,0 +1,30 @@ +## {{page-title}} + +
+This stable release (v1.2.0) of Application 5 sees the withdrawl of Blood Pressure and Oral Contraception use cases. +
+ + +### Application Change Log + + +
+ + +| Change | Description | Impact | +|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------| +| Update to use case status | Withdrawl of Blood Pressure and Oral Contraception use cases | correction | + + +### Payload Change Log + +| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact | +|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------| + +| + +
+
+ +### Previous Releases + diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/toc.yaml index 47eb3690..30abf8ac 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/toc.yaml @@ -1,5 +1,7 @@ - name: Index filename: Index.page.md +- name: 1.2.0 + filename: 1.2.0.page.md - name: 1.1.4 filename: 1.1.4.page.md - name: 1.1.3 From 43365ab2176ba75a125b0defb2ad2dda54c5568b Mon Sep 17 00:00:00 2001 From: luci-davies Date: Mon, 23 Mar 2026 14:17:19 +0000 Subject: [PATCH 04/12] Edits to release note/change log app 5 in testing --- .../Home/Analysis/Releases/Current-Releases.page.md | 4 +++- .../Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md index a797fb3d..342c7850 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md @@ -20,7 +20,9 @@ Implementation Guide | 1.11.0 | v1 | Live | Current Release | 26/03 ### Overview of the release -Release 1.11.0 of the BaRS Implementation Guide introduces BaRS Application 8 "Referrals to a broker for Healthcare Service selection" as an alpha release. BaRS Application 8 is designed to create interoperability for referrals between NHS England products. The next phase of content and navigation changes in the Implementation Guide are delivered. They are focussed on: the Home page, the Analysis section (formerly About BaRS) and relocation of content from this area. These changes are based on user feedback. Also included in this release are minor changes to BaRS Application 6 and bug fixes and corrections throughout the guide. +Release 1.11.0 of the BaRS Implementation Guide introduces BaRS Application 8 "Referrals to a broker for Healthcare Service selection" as an alpha release. BaRS Application 8 is designed to create interoperability for referrals between NHS England products. The next phase of content and navigation changes in the Implementation Guide are delivered. They are focussed on: the Home page, the Analysis section (formerly About BaRS) and relocation of content from this area. These changes are based on user feedback. + +Application 5 is updated with the withdrawl of use cases for GP to Blood Pressure Check Service and GP to Pharmacy Contraception (Oral Contraception). Also included in this release are minor changes to BaRS Application 6 and bug fixes and corrections throughout the guide. A clinical safety assessment of the scope of this release has determined that it has not significantly changed the clinical safety profile of the BaRS. No new hazards have been identified in this release. The latest version of the BaRS clinical safety case and hazard log can be downloaded from the  BaRS FHIR API onboarding support information page . diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md index 3b0e8f97..2c0b77cd 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md @@ -13,7 +13,7 @@ This stable release (v1.2.0) of Application 5 sees the withdrawl of Blood Pressu | Change | Description | Impact | |-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------| -| Update to use case status | Withdrawl of Blood Pressure and Oral Contraception use cases | correction | +| Update to use case status | Withdrawl of Blood Pressure Check Service and Pharmacy Contraception (Oral Contraception) use cases | correction | ### Payload Change Log From 01d5d0bc0aa70b22a0d19785c6daab54f2b9b56f Mon Sep 17 00:00:00 2001 From: luci-davies Date: Mon, 23 Mar 2026 15:46:45 +0000 Subject: [PATCH 05/12] App 5 version number --- .../Home/Analysis/Releases/Current-Releases.page.md | 6 +++++- .../BaRS-Applications/Applications/BaRS-APP5/Index.page.md | 4 ++-- .../BaRS-Applications/Applications/Index.page.md | 4 ++++ .../Home/Applications/BaRS-Pre-releases/Index.page.md | 4 ++++ 4 files changed, 15 insertions(+), 3 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md index 342c7850..88bd6d25 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md @@ -11,7 +11,7 @@ Implementation Guide | 1.11.0 | v1 | Live | Current Release | 26/03 {{pagelink:application2, text:BaRS-APP2}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} {{pagelink:application3, text:BaRS-APP3}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app3,text:BaRS APP3 Change Log}} {{pagelink:application4, text:BaRS-APP4}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app4,text:BaRS APP4 Change Log}} -{{pagelink:application5, text:BaRS-APP5}} | 1.1.4 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app5,text:BaRS APP5 Change Log}} +{{pagelink:application5, text:BaRS-APP5}} | 1.2.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-app5,text:BaRS APP5 Change Log}} {{pagelink:application6, text:BaRS-APP6}} | 1.0.0-beta.7 | beta | | Current Release | 26/03/2026 | Pre-Release |{{pagelink:trn-app6,text:BaRS APP6 Change Log}} {{pagelink:application7, text:BaRS-APP7}} | 1.0.0-alpha.4 | alpha | | Current Release | 02/07/2025 | Pre-Release |{{pagelink:trn-app7,text:BaRS APP7 Change Log}} {{pagelink:application8, text:BaRS-APP8}} | 1.0.0-alpha | alpha | | Current Release | 26/03/2026 | Pre-Release |{{pagelink:trn-app8,text:BaRS APP8 Change Log}} @@ -179,6 +179,10 @@ Table detailing active versions of the latest Applications in Production (or cur Application 5 v1.1.4 v1.10.0 + + Application 5 v1.2.0 + v1.11.0 + Application 6 v1.0.0-beta.7 v1.11.0 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md index 31e5a701..d41f4969 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Index.page.md @@ -17,9 +17,9 @@ topic: Application5 - Application 5 v1.1.4 + Application 5 v1.2.0 v1.1.x - v1.10.0 + v1.11.0 v1.1.0 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md index 99631cd6..51b000c0 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md @@ -178,6 +178,10 @@ Table detailing active versions of the latest Applications in Production (or cur Application 5 v1.1.4 v1.10.0 + + Application 5 v1.2.0 + v1.11.0 + Application 6 v1.0.0-beta.7 v1.11.0 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md index 24a92a93..e003f64c 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md @@ -175,6 +175,10 @@ Table detailing active versions of the latest Applications in Production (or cur Application 5 v1.1.4 v1.10.0 + + Application 5 v1.2.0 + v1.11.0 + Application 6 v1.0.0-beta.7 v1.11.0 From 1ed922a60ed570905490c51ad63314aad3ef5966 Mon Sep 17 00:00:00 2001 From: luci-davies Date: Mon, 23 Mar 2026 16:41:02 +0000 Subject: [PATCH 06/12] App 8 version numbers and fixes --- .../Home/Analysis/Releases/Current-Releases.page.md | 4 ++-- .../BaRS-Applications/Applications/BaRS-APP8/Index.page.md | 4 ++-- .../BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md | 2 +- .../Applications/BaRS-Applications/Applications/Index.page.md | 4 ++-- .../Home/Applications/BaRS-Pre-releases/Index.page.md | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md index 88bd6d25..13a8d735 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md @@ -196,8 +196,8 @@ Table detailing active versions of the latest Applications in Production (or cur Application 8 v1.0.0-alpha v1.11.0 - v1.4.0 - 1.4.0 + v1.1.0 + 1.1.0 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md index 519751e3..952b91ae 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md @@ -18,9 +18,9 @@ topic: Application8 Application 8 v1.0.0-alpha - v1.4.x + v1.1.x v1.11.0 - v1.4.0 + v1.1.0 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md index 75a3064b..eb011853 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md @@ -20,7 +20,7 @@ There are two *coding* entries within *ServiceRequest.category* which are key to 1. Denotes the type of referral e.g. Transfer of care 2. Denotes the use case and must be populated with the relevant use case from [use-case CodeSystem]( https://simplifier.net/nhsbookingandreferrals/usecases-categories-bars -). e.g. IAG to e-RS. Please refer to the guidance in {{pagelink:core-SPUseCaseCategories-1.4.0, text:use-case categories}} +). e.g. AG to e-RS. Please refer to the guidance in {{pagelink:core-SPUseCaseCategories-1.4.0, text:use-case categories}} ### Encounter Resource The Encounter is used to represent the interaction between a patient and healthcare service provider. It links with numerous other resources, to reflect the assessment performed. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md index 51b000c0..d3002f3b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md @@ -195,8 +195,8 @@ Table detailing active versions of the latest Applications in Production (or cur Application 8 v1.0.0-alpha v1.11.0 - v1.4.0 - 1.4.0 + v1.1.0 + 1.1.0 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md index e003f64c..41204f5f 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md @@ -192,8 +192,8 @@ Table detailing active versions of the latest Applications in Production (or cur Application 8 v1.0.0-alpha v1.11.0 - v1.4.0 - 1.4.0 + v1.1.0 + 1.1.0 From 5526853b935f703df9a83a7b142ea210f3be8fa6 Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Mon, 23 Mar 2026 17:24:10 +0000 Subject: [PATCH 07/12] minor-changes-230326 Core version tweaks updates to change eRS to e-RS updates to change IAG to AG --- .../EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg | 4 ++++ .../EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg | 4 ---- .../WorkFlows/Internal-Broker-AG-To-e-RS-1.0.0-alpha.svg | 4 ++++ .../WorkFlows/Internal-Broker-IAG-To-e-RS-1.0.0-alpha.svg | 4 ---- .../BaRS-APP8/Entity-Relationship-Diagrams.page.md | 4 ++-- .../Applications/BaRS-APP8/How-does-it-work.page.md | 2 +- .../Applications/BaRS-APP8/Referral-Payload.page.md | 6 +++--- .../Applications/BaRS-APP8/Scope-and-Requirements.page.md | 2 +- .../Home/Core/1.4.0/Index.page.md | 8 ++++---- 9 files changed, 19 insertions(+), 19 deletions(-) create mode 100644 BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg delete mode 100644 BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg create mode 100644 BaRS-Images/WorkFlows/Internal-Broker-AG-To-e-RS-1.0.0-alpha.svg delete mode 100644 BaRS-Images/WorkFlows/Internal-Broker-IAG-To-e-RS-1.0.0-alpha.svg diff --git a/BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg b/BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg new file mode 100644 index 00000000..849f3ac9 --- /dev/null +++ b/BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg @@ -0,0 +1,4 @@ + + + +FHIR BundleIdGUID_1FHIR MessageHeaderFullUrlurn:uuid:GUID_2eventCodingservicerequest-request*reasonnew**focusurn:uuid:GUID_4 (ServiceRequest)destinationurn:uuid:GUID_5 (Organisation)senderurn:uuid:GUID_6 (Organisation)source.endpoint'<system>/<value>' ++FHIR OrganisationFullUrlurn:uuid:GUID_5IdGUID_002FHIR OrganisationFullUrlurn:uuid:GUID_6IdGUID_001FHIR ServiceRequestFullUrlurn:uuid:GUID_4IdGUID_003categoryreferral***category
a8t1****
subjecturn:uuid:GUID_9 (Patient)basedOnurn:uuid:GUID_29 (CarePlan)encounterurn:uuid:GUID_10 (Encounter)requesterurn:uuid:GUID_11 (Practitioner)performerurn:uuid:GUID_35 (Device)FHIR PatientFullUrlurn:uuid:GUID_9IdGUID_004identifier3478526985 (NHS Number)FHIR EncounterFullUrlurn:uuid:GUID_10IdGUID_005identity(local system encounter ref)subjecturn:uuid:GUID_9 (Patient)episodeOfCareGUID_13FHIR PractitionerFullUrlurn:uuid:GUID_11IdGUID_006FHIR PractitionerRoleFullUrlurn:uuid:GUID_12IdGUID_007practitionerurn:uuid:GUID_11 (Practitioner)FHIR ConsentFullUrlurn:uuid:GUID_22IdGUID_013patienturn:uuid:GUID_9 (Patient)
Key: - 

Mandatory Resource
Receiver defined value (in http response)
Optional Resource
Resources
* https://simplifier.net/nhsdigitalspine/message-events
** https://simplifier.net/nhsdigitalspine/message-reason-servicerequest
*** https://simplifier.net/nhsdigitalspine/message-category-servicerequest
**** https://simplifier.net/nhsbookingandreferrals/usecases-categories-bars

+ Support for numerous valueSets
++ The Sender must populate the 'NHSD-Target-Identifier' value a Receiver needs to populate in order to send a response to them via the BaRS API

NB - All data elements note in FHIR resources must be included, if the resource is used. Other data elements will also be include - See Application Implementation Guidance for full detail.
Text
Entity map of FHIR Resources for BaRS ServiceRequest - Referral Request (AG to e-RS)
Sender defined value 
= 1 mandatory
= 0 or *
= 0 or 1
FHIR CarePlanFullUrlurn:uuid:GUID_29IdGUID_020subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)activity.detail.performer[(HealthcareService(s))]addressesurn:uuid:GUID_31 (Condition)activity.referenceurn:uuid:GUID_32 (Task)FHIR Encounter (Receiver new)FullUrlurn:uuid:GUID_30IdGUID_021identity(local system encounter ref)statusplannedsubjectGUID_004episodeOfCareGUID_13
Receiver included resource in http response only
FHIR OrganisationFullUrlurn:uuid:GUID_5IdGUID_002FHIR TaskFullUrlurn:uuid:GUID_32IdGUID_023statusrequestedintentordercode
792891000000102|Inbound referral
encounterurn:uuid:GUID_10 (Encounter)FHIR ConditionFullUrlurn:uuid:GUID_31IdGUID_022subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)clincalStatusactiveverificationStatusprovisionalcategory33962009 | Presenting complaintcode (freetext)HerniaFHIR HealthcareServiceFullUrlurn:uuid:GUID_33IdGUID_024FHIR HealthcareServiceFullUrlurn:uuid:GUID_34IdGUID_025FHIR HealthcareServiceFullUrlurn:uuid:GUID_28IdGUID_019
Array of HealthcareServices (Min 1, Max 20)
FHIR DeviceFullUrlurn:uuid:GUID_35IdGUID_026deviceName.nameeRSdeviceName.typeuser-friendly-nameownerurn:uuid:GUID_5 \ No newline at end of file diff --git a/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg b/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg deleted file mode 100644 index 4247ad1b..00000000 --- a/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -FHIR BundleIdGUID_1FHIR MessageHeaderFullUrlurn:uuid:GUID_2eventCodingservicerequest-request*reasonnew**focusurn:uuid:GUID_4 (ServiceRequest)destinationurn:uuid:GUID_5 (Organisation)senderurn:uuid:GUID_6 (Organisation)source.endpoint'<system>/<value>' ++FHIR OrganisationFullUrlurn:uuid:GUID_5IdGUID_002FHIR OrganisationFullUrlurn:uuid:GUID_6IdGUID_001FHIR ServiceRequestFullUrlurn:uuid:GUID_4IdGUID_003categoryreferral***category
a8t1****
subjecturn:uuid:GUID_9 (Patient)basedOnurn:uuid:GUID_29 (CarePlan)encounterurn:uuid:GUID_10 (Encounter)requesterurn:uuid:GUID_11 (Practitioner)performerurn:uuid:GUID_35 (Device)FHIR PatientFullUrlurn:uuid:GUID_9IdGUID_004identifier3478526985 (NHS Number)FHIR EncounterFullUrlurn:uuid:GUID_10IdGUID_005identity(local system encounter ref)subjecturn:uuid:GUID_9 (Patient)episodeOfCareGUID_13FHIR PractitionerFullUrlurn:uuid:GUID_11IdGUID_006FHIR PractitionerRoleFullUrlurn:uuid:GUID_12IdGUID_007practitionerurn:uuid:GUID_11 (Practitioner)FHIR ConsentFullUrlurn:uuid:GUID_22IdGUID_013patienturn:uuid:GUID_9 (Patient)
Key: - 

Mandatory Resource
Receiver defined value (in http response)
Optional Resource
Resources
* https://simplifier.net/nhsdigitalspine/message-events
** https://simplifier.net/nhsdigitalspine/message-reason-servicerequest
*** https://simplifier.net/nhsdigitalspine/message-category-servicerequest
**** https://simplifier.net/nhsbookingandreferrals/usecases-categories-bars

+ Support for numerous valueSets
++ The Sender must populate the 'NHSD-Target-Identifier' value a Receiver needs to populate in order to send a response to them via the BaRS API

NB - All data elements note in FHIR resources must be included, if the resource is used. Other data elements will also be include - See Application Implementation Guidance for full detail.
Text
Entity map of FHIR Resources for BaRS ServiceRequest - Referral Request - IA&G to eRS
Sender defined value 
= 1 mandatory
= 0 or *
= 0 or 1
FHIR CarePlanFullUrlurn:uuid:GUID_29IdGUID_020subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)activity.detail.performer[(HealthcareService(s))]addressesurn:uuid:GUID_31 (Condition)activity.referenceurn:uuid:GUID_32 (Task)FHIR Encounter (Receiver new)FullUrlurn:uuid:GUID_30IdGUID_021identity(local system encounter ref)statusplannedsubjectGUID_004episodeOfCareGUID_13
Receiver included resource in http response only
FHIR OrganisationFullUrlurn:uuid:GUID_5IdGUID_002FHIR TaskFullUrlurn:uuid:GUID_32IdGUID_023statusrequestedintentordercode
792891000000102|Inbound referral
encounterurn:uuid:GUID_10 (Encounter)FHIR ConditionFullUrlurn:uuid:GUID_31IdGUID_022subjecturn:uuid:GUID_9 (Patient)encounterurn:uuid:GUID_10 (Encounter)clincalStatusactiveverificationStatusprovisionalcategory33962009 | Presenting complaintcode (freetext)HerniaFHIR HealthcareServiceFullUrlurn:uuid:GUID_33IdGUID_024FHIR HealthcareServiceFullUrlurn:uuid:GUID_34IdGUID_025FHIR HealthcareServiceFullUrlurn:uuid:GUID_28IdGUID_019
Array of HealthcareServices (Min 1, Max 20)
FHIR DeviceFullUrlurn:uuid:GUID_35IdGUID_026deviceName.nameeRSdeviceName.typeuser-friendly-nameownerurn:uuid:GUID_5 \ No newline at end of file diff --git a/BaRS-Images/WorkFlows/Internal-Broker-AG-To-e-RS-1.0.0-alpha.svg b/BaRS-Images/WorkFlows/Internal-Broker-AG-To-e-RS-1.0.0-alpha.svg new file mode 100644 index 00000000..ffeb683f --- /dev/null +++ b/BaRS-Images/WorkFlows/Internal-Broker-AG-To-e-RS-1.0.0-alpha.svg @@ -0,0 +1,4 @@ + + + +                                   Sender
Referral to 
e-RS?
Referral
Service Discovery
Yes
Alternate flow
No
Receiver
e-RS informs patient/client of HCS options
Acknowledge Referral
Patient/client reviews options 
Next action
New Workflow
Existing Workflow
Selects Healthcare Service
Makes referral from e-RS
Receive acknowledgment
Close case
Sender Assessment complete
Internal Broker - AG to e-RS (Clinician supported)
End
Shortlist Healthcare Services (HCS)
Direct referral to e-RS
 \ No newline at end of file diff --git a/BaRS-Images/WorkFlows/Internal-Broker-IAG-To-e-RS-1.0.0-alpha.svg b/BaRS-Images/WorkFlows/Internal-Broker-IAG-To-e-RS-1.0.0-alpha.svg deleted file mode 100644 index f23dad51..00000000 --- a/BaRS-Images/WorkFlows/Internal-Broker-IAG-To-e-RS-1.0.0-alpha.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -                                   Sender
Referral to 
e-RS?
Referral
Service Discovery
Yes
Alternate flow
No
Receiver
e-RS informs patient/client of HCS options
Acknowledge Referral
Patient/client reviews options 
Next action
New Workflow
Existing Workflow
Selects Healthcare Service
Makes referral from e-RS
Receive acknowledgment
Close case
Sender Assessment complete
Internal Broker - IAG to e-RS
End
Shortlist Healthcare Services (HCS)
Direct referral to e-RS
 \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Entity-Relationship-Diagrams.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Entity-Relationship-Diagrams.page.md index 960815bb..0768b282 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Entity-Relationship-Diagrams.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Entity-Relationship-Diagrams.page.md @@ -8,10 +8,10 @@ topic: APP8-EntityRelationshipDiagram Entity maps detail the relationship of the resources and elements within resources in the payloads.

-The below diagram details the ServiceRequest - Referral Request - Improved Advice and Guidance to e-RS (a8t1|IAG to e-RS) +The below diagram details the ServiceRequest - Referral Request - Improved Advice and Guidance to e-RS (a8t1|AG to e-RS)

- +


diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/How-does-it-work.page.md index 041a94a7..e6504b6f 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/How-does-it-work.page.md @@ -9,7 +9,7 @@ This section describes how the primary operations used in this Application work. This diagram illustrates the workflow and interactions of a referral request where healthcare options are offered to a patient by a clinician:
- + The Application also supports a self-referral workflow:
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md index 81f61229..845b4c2a 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md @@ -118,7 +118,7 @@ This payload is used to transmit all the necessary information that is required | ServiceRequest.category.coding | BaRS Use Case | MUST | 0..* | | | ServiceRequest.category.coding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/usecases-categories-bars | | ServiceRequest.category.coding.code | This MUST be populated with Code for the use-case. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' | MUST | 0..1 | A8T1 | -| ServiceRequest.category.coding.display | This MUST be populated with Display for the use-case. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' | MUST | 0..1 | Assessment to eRS broker | +| ServiceRequest.category.coding.display | This MUST be populated with Display for the use-case. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' | MUST | 0..1 | Assessment to e-RS broker | | ServiceRequest.code | This MUST be populated, if including orderDetail | COULD | 0..1 | | | ServiceRequest.code.coding | This MUST be populated with a SNOMED Coded Value. This should be kept generic with the main request and next step being reserved for Task.Code | MUST | 0..1 | | | ServiceRequest.code.coding.system | This MUST be populated with the SNOMED Code System | MUST | 0..1 | http://snomed.info/sct | @@ -140,7 +140,7 @@ This payload is used to transmit all the necessary information that is required | ServiceRequest.requester | | MUST | 0..1 | | | ServiceRequest.requester.reference | This MUST be populated with a reference to the Practitioner resource. This is the Healthcare Professional making the request. This does not strictly need to be a clinician. | MUST | 0..1 | urn:uuid:8c63d621-3424-4f57-8699-e8e22d32423g | | ServiceRequest.performer | | MUST | 0..* | | -| ServiceRequest.performer.reference | This MUST be populated with a reference to Device resource e.g. eRS which will act as a broker. The Sender is not choosing the final healthcare service destination but offering options for the broker to resolve with the patient/client | MUST | 0..1 | urn:uuid:f014ff0a-f352-4b7d-9c22-171389875ab9 | +| ServiceRequest.performer.reference | This MUST be populated with a reference to Device resource e.g. e-RS which will act as a broker. The Sender is not choosing the final healthcare service destination but offering options for the broker to resolve with the patient/client | MUST | 0..1 | urn:uuid:f014ff0a-f352-4b7d-9c22-171389875ab9 |

@@ -390,7 +390,7 @@ This payload is used to transmit all the necessary information that is required | Device.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | | Device.status | This MUST be populated with 'active' - Fixed Value | MUST | 1..1 | active | | Device.deviceName | | | | | -| Device.deviceName.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | eRS | +| Device.deviceName.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | e-RS | | Device.deviceName.type | This MUST be populated with 'user-friendly-name' - Fixed Value | MUST | 1..1 | user-friendly-name | | Device.owner | | MUST | 1..1 | | | Device.owner.reference | This MUST be populated with a reference to the Patient | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md index 909ee480..8781e601 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md @@ -5,7 +5,7 @@ TOPIC: APP8-ScopeAndRequirements ## {{page-title}} ### Scope Overview -This BaRS Application (Referrals from Advice and Guidance to eRS broker, Application 8) supports the following use case(s) ONLY: +This BaRS Application (Referrals from Advice and Guidance to e-RS broker, Application 8) supports the following use case(s) ONLY: * Improved Advice and Guidance to electronic-Referral Service (e-RS) * 111Online to electronic-Referral Service (e-RS) * NHS.UK to electronic-Referral Service (e-RS) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.4.0/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.4.0/Index.page.md index 481706bc..5f5c7d27 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.4.0/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.4.0/Index.page.md @@ -13,7 +13,7 @@ topic: design-core-1.4.0 - v1.3.1 + v1.4.0 v1.10.0 v1.4.0 @@ -22,7 +22,7 @@ topic: design-core-1.4.0 -# BaRS Core 1.3.1 +# BaRS Core 1.4.0 BaRS consists of BaRS Core that provides a core set of functionality and BaRS Applications that provide distinct functionality for each use case. @@ -31,7 +31,7 @@ You will find here a set of documentation, specifications and services that desc

> Expand for full Core directory -• {{pagelink:design-core-1.4.0 , text: Core 1.3.1}}
+• {{pagelink:design-core-1.4.0 , text: Core 1.4.0}}
  • {{pagelink:core-EndToEndWorkflow-1.4.0 , text:End to end workflow}}
    • {{pagelink:core-EndToEndWorkflow-ServiceDiscovery-1.4.0 , text:Service Discovery}}
    • {{pagelink:core-EndToEndWorkflow-BaRSAuth-1.4.0 , text:Authenticate with BaRS}}
@@ -243,7 +243,7 @@ For more detail please visit the {{pagelink:core-StandardPattern-document-refere From 32e11060d4eb5b55a28114491cf96e19fb83d55b Mon Sep 17 00:00:00 2001 From: luci-davies Date: Mon, 23 Mar 2026 17:53:27 +0000 Subject: [PATCH 08/12] Correction to non-breaking --- .../Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md index 2c0b77cd..1a08b093 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP5/1.2.0.page.md @@ -13,7 +13,7 @@ This stable release (v1.2.0) of Application 5 sees the withdrawl of Blood Pressu | Change | Description | Impact | |-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------| -| Update to use case status | Withdrawl of Blood Pressure Check Service and Pharmacy Contraception (Oral Contraception) use cases | correction | +| Update to use case status | Withdrawl of Blood Pressure Check Service and Pharmacy Contraception (Oral Contraception) use cases | non-breaking | ### Payload Change Log 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 09/12] 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 |
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md index c89420f6..b32d8b92 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Response-Payload.page.md @@ -154,33 +154,32 @@ ONLY)

-| 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 10/12] 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 @@ <status value="active" /> - <date value="2025-03-24" /> + <date value="2026-03-24" /> <useContext> <code> <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" /> @@ -29,8 +29,8 @@ <coding> <!-- Use cases supported by this MessageDefinition Application --> <system value="https://fhir.nhs.uk/CodeSystem/usecases-categories-bars" /> - <code value="a6t3" /> - <display value="CAD to CAD Mutual Aid Request" /> + <code value="a6t1" /> + <display value="CAD to CAD Out of Area Referral" /> </coding> </valueCodeableConcept> </useContext> From c9029a2fcc841be77b6ee7631fe54d3b9fd47a2b Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Tue, 24 Mar 2026 10:57:58 +0000 Subject: [PATCH 11/12] NBRS-4469 Updated SNOMED Codes on PTS Q & QR --- Examples/Questionnaire for PTS.xml | 10 +++++----- Examples/QuestionnaireResponse for PTS.xml | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Examples/Questionnaire for PTS.xml b/Examples/Questionnaire for PTS.xml index 1320f8aa..d5d85199 100644 --- a/Examples/Questionnaire for PTS.xml +++ b/Examples/Questionnaire for PTS.xml @@ -24,14 +24,14 @@ <valueCoding> <system value="http://snomed.info/sct"/> <code value="78064003"/> - <display value="Breathing (observable entity)"/> + <display value="Breathing"/> </valueCoding> </answerOption> <answerOption> <valueCoding> <system value="http://snomed.info/sct"/> <code value="1023001"/> - <display value="Not Breathing (finding)"/> + <display value="Not Breathing"/> </valueCoding> </answerOption> </item> @@ -44,7 +44,7 @@ <operator value="="/> <answerCoding> <code value="78064003"/> - <display value="Breathing (observable entity)"/> + <display value="Breathing"/> </answerCoding> </enableWhen> <required value="false"/> @@ -72,7 +72,7 @@ <operator value="="/> <answerCoding> <code value="78064003"/> - <display value="Breathing (observable entity)"/> + <display value="Breathing"/> </answerCoding> </enableWhen> <required value="false"/> @@ -100,7 +100,7 @@ <operator value="="/> <answerCoding> <code value="78064003"/> - <display value="Breathing (observable entity)"/> + <display value="Breathing"/> </answerCoding> </enableWhen> <required value="false"/> diff --git a/Examples/QuestionnaireResponse for PTS.xml b/Examples/QuestionnaireResponse for PTS.xml index f7f0fcc7..02d4c07c 100644 --- a/Examples/QuestionnaireResponse for PTS.xml +++ b/Examples/QuestionnaireResponse for PTS.xml @@ -30,7 +30,7 @@ <valueCoding> <system value="http://snomed.info/sct" /> <code value="78064003" /> - <display value="Breathing (observable entity)" /> + <display value="Breathing" /> </valueCoding> </answer> </item> From 8f967dc16cf11981de1ced795af92ca483682cc7 Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Tue, 24 Mar 2026 13:35:22 +0000 Subject: [PATCH 12/12] NBRS-4485 Org cardinality updated to 2..* from 1..* --- ...MessageDefinition-ServiceRequest-Response-Referral-Short.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MessageDefinition/BARS-MessageDefinition-ServiceRequest-Response-Referral-Short.xml b/MessageDefinition/BARS-MessageDefinition-ServiceRequest-Response-Referral-Short.xml index 60ed49c8..dc6a8bc9 100644 --- a/MessageDefinition/BARS-MessageDefinition-ServiceRequest-Response-Referral-Short.xml +++ b/MessageDefinition/BARS-MessageDefinition-ServiceRequest-Response-Referral-Short.xml @@ -71,7 +71,7 @@ <focus> <code value="Organization" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" /> - <min value="1" /> + <min value="2" /> <max value="*" /> </focus> <focus>