From 68ef789871f773687988f52531bf18b39d8df455 Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Wed, 25 Mar 2026 09:16:02 +0000 Subject: [PATCH 1/8] UCC-Update --- CodeSystem/usecases-categories-bars.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CodeSystem/usecases-categories-bars.xml b/CodeSystem/usecases-categories-bars.xml index 856894c5..11fab27e 100644 --- a/CodeSystem/usecases-categories-bars.xml +++ b/CodeSystem/usecases-categories-bars.xml @@ -126,7 +126,7 @@ - + From 21f78d9fc2bdbea93018a4752a5241ac46729ddd Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Wed, 25 Mar 2026 10:54:55 +0000 Subject: [PATCH 2/8] CoreGuideVersionUpdated --- .../Live-ImplementationGuide-BaRS/Home/Core/1.4.0/Index.page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 5f5c7d27..bd8befc7 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 @@ -14,7 +14,7 @@ topic: design-core-1.4.0 v1.4.0 - v1.10.0 + v1.11.0 v1.4.0 From a45940fa845fd6826482c6d4764b1762dae1cfe7 Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Wed, 25 Mar 2026 11:02:37 +0000 Subject: [PATCH 3/8] AddedAPISpecLinkToApp8Index --- .../BaRS-Applications/Applications/BaRS-APP8/Index.page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 952b91ae..776097a7 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 @@ -42,7 +42,7 @@ This application supports the use of the following use cases: ### Overview -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 API Specification when developing to the standard. +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 [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.0) when developing to the standard. ### Data model endorsements From ade4dba4de5cfec4808ddb1d1f4c14c6c998348e Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Wed, 25 Mar 2026 11:10:00 +0000 Subject: [PATCH 4/8] UpdatedNHSNoReq It is not true it should not be include and contradicts the previous requirement of having a national validated identifier --- .../Applications/BaRS-APP8/Scope-and-Requirements.page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 4afd8ddb..45767d2b 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 @@ -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 **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 +- The national identifier **must** have a [verification status](https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-nhsnumberverificationstatus) of 'Number present and verified'. - 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 - The referral Receiver **must** accurately represent information made by the Sender to the end user. From 19b3db1790cca7db424e84e55be046a5383c324a Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Wed, 25 Mar 2026 11:19:05 +0000 Subject: [PATCH 5/8] MinorHowItWorksUpdates --- .../Applications/BaRS-APP8/How-does-it-work.page.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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 e6504b6f..a756f3b7 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 @@ -6,7 +6,7 @@ topic: APP8-HowDoesItWork 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: +This diagram illustrates the workflow and interactions of a referral request where a shortlist of healthcare service options are offered to a patient by a clinician:
@@ -26,6 +26,8 @@ The referral request is directed to a broker in this Application, rather than di The Sender will establish the patient need, identify a specific service or prepare a shortlist of healthcare services to support them, and package these in the referral request. The request is sent from the Sender to the broker (Receiver) and then onto the selected healthcare service (through [e-RS](https://digital.nhs.uk/services/e-referral-service) ). +Alternatively, where a self-referral workflow is undertaken, the steps are the same but only one healthcare service option is included in the referral request. + Directing the referral request will still engage the same BaRS mechanisms; utilising the NHSD-Target-Identifier. However, the Receiver is a consistent, known entity, rather than dynamically established during workflow. *NB - The definition of the broker NHSD-Target-Identifier has not yet been agreed.* From 1d3d065a30b0288552f82bad9800dc80cf60dd20 Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Wed, 25 Mar 2026 11:30:26 +0000 Subject: [PATCH 6/8] PayloadConsentChange removed reference to UEC --- .../Applications/BaRS-APP8/How-does-it-work.page.md | 2 +- .../BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) 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 a756f3b7..5144e05c 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 @@ -41,7 +41,7 @@ The Message Definition that defines this payload for this application is: {{link
-In addition to that the specific workflow parameters that are required are as follows: +In addition, the specific workflow parameters that are required are as follows:
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 eb011853..49e76f80 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 @@ -58,7 +58,7 @@ When a BARS Receiver processes information in a Flag resource; * rendering of Flag information must be in line with the {{pagelink:Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-rendering-BaRS-payloads.page.md, text:Principles for rendering BaRS Payload }}. ### Consent -In the BaRS UEC Applications the level of consent is stipulated to be for 'Direct Care' only. A referral **must** contain a Consent resource and it **must** adhere to the [example](https://simplifier.net/NHSBookingandReferrals/8fc39b95-89a6-45fb-914f-1458a10e9e14/~json) provided under the BaRS FHIR assets. +In BaRS Applications the level of consent is stipulated to be for 'Direct Care' only. A referral **must** contain a Consent resource and it **must** adhere to the [example](https://simplifier.net/NHSBookingandReferrals/8fc39b95-89a6-45fb-914f-1458a10e9e14/~json) provided under the BaRS FHIR assets.

From 15129025e6d14d9ee77d8ccd4470bd0b724eb80c Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Wed, 25 Mar 2026 11:44:03 +0000 Subject: [PATCH 7/8] PayloadAndERDUpdates --- .../EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg | 2 +- .../Applications/BaRS-APP8/Referral-Payload.page.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg b/BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg index 849f3ac9..7533d370 100644 --- a/BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg +++ b/BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg @@ -1,4 +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 +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.namee-RSdeviceName.typeuser-friendly-nameownerurn:uuid:GUID_5
\ No newline at end of file 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 845b4c2a..62c486f8 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 @@ -165,8 +165,8 @@ This payload is used to transmit all the necessary information that is required | Encounter.status | This MUST be populated with 'finished' or 'triaged'. | MUST | 1..1 | finished | | 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 | VR | -| Encounter.class.display | This MUST be populated with Display 'emergency'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | Virtual | +| Encounter.class.code | This MUST be populated with Code 'VR'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | VR | +| Encounter.class.display | This MUST be populated with Display 'virtual'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | virtual | | Encounter.subject | | MUST | 0..1 | | | Encounter.subject.reference | This MUST be populated with a reference to the Patient resource. | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | | Encounter.episodeOfCare | | MUST | 0..* | | @@ -501,7 +501,7 @@ This payload is used to transmit all the necessary information that is required | Flag.subject.reference | This MUST be populated with the subject that the flag refers to. Where the flag relates to the patient (e.g. reasonable adjustments) this will reference the Patient resource | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | | Flag.period | | SHOULD | 0..1 | | | Flag.period.start | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | -| Flag.period.end | Follow UK Core guidance for populating this element | MAY | 0..1 | 2023-03-08T12:01:08.4677672+00:00 | +| Flag.period.end | Follow UK Core guidance for populating this element | MAY | 0..1 | 2024-03-08T12:01:08.4677672+00:00 |

From 67c732551be1f0ead9f5eb6c1eba98ba1168bcc6 Mon Sep 17 00:00:00 2001 From: Carl De'ath <74620667+cda69@users.noreply.github.com> Date: Wed, 25 Mar 2026 12:58:42 +0000 Subject: [PATCH 8/8] Banners --- .../Applications/BaRS-APP6/Index.page.md | 2 +- .../Applications/BaRS-APP7/Index.page.md | 2 +- .../Applications/BaRS-APP8/Index.page.md | 10 +++++++--- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md index 5cb44f22..17fb92df 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md @@ -5,7 +5,7 @@ topic: Application6 # Referrals into an Ambulance Service Trust (Application 6) -