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] 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