+
+
\ No newline at end of file
From 437f2432ddc9068874bb90c0f80da3252a652d28 Mon Sep 17 00:00:00 2001
From: Carl De'ath <74620667+cda69@users.noreply.github.com>
Date: Wed, 18 Mar 2026 22:12:34 +0000
Subject: [PATCH 02/14] Updates-after-MF-review
Most comments addressed
Others replied to.
---
CodeSystem/broker-priority-status.xml | 24 ++++++++++----------
CodeSystem/broker-referral-letter-status.xml | 20 ++++++++--------
CodeSystem/usecases-categories-bars.xml | 6 ++---
3 files changed, 25 insertions(+), 25 deletions(-)
diff --git a/CodeSystem/broker-priority-status.xml b/CodeSystem/broker-priority-status.xml
index c4163d44..ec1353a0 100644
--- a/CodeSystem/broker-priority-status.xml
+++ b/CodeSystem/broker-priority-status.xml
@@ -8,32 +8,32 @@
-
-
-
-
-
\ No newline at end of file
diff --git a/CodeSystem/broker-referral-letter-status.xml b/CodeSystem/broker-referral-letter-status.xml
index 6b39ab63..58feabe3 100644
--- a/CodeSystem/broker-referral-letter-status.xml
+++ b/CodeSystem/broker-referral-letter-status.xml
@@ -8,28 +8,28 @@
-
-
-
-
\ No newline at end of file
diff --git a/CodeSystem/usecases-categories-bars.xml b/CodeSystem/usecases-categories-bars.xml
index 3d85b7c7..856894c5 100644
--- a/CodeSystem/usecases-categories-bars.xml
+++ b/CodeSystem/usecases-categories-bars.xml
@@ -124,15 +124,15 @@
+
-
+
-
+
From 61b732157f6ca0bc39856d542bd575e3ce5f4a63 Mon Sep 17 00:00:00 2001
From: luci-davies
Date: Thu, 19 Mar 2026 15:29:22 +0000
Subject: [PATCH 03/14] Core change log
Created Core 1.4.0 change log
Demoted 1.3.1 change log
Removed "Previous releases" tag left in error on 1.3.0
---
.../BaRS-Core/1.3.0.page.md | 1 -
.../BaRS-Core/1.3.1.page.md | 6 +++++-
.../BaRS-Core/1.4.0.page.md | 15 +++++++++++++++
3 files changed, 20 insertions(+), 2 deletions(-)
create mode 100644 guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.4.0.page.md
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.3.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.3.0.page.md
index c031d7e1..698ceb15 100644
--- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.3.0.page.md
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.3.0.page.md
@@ -22,4 +22,3 @@ topic: TRN-Core-1.3.0
-### Previous Releases
\ No newline at end of file
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.3.1.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.3.1.page.md
index d7ceedb1..bbeec042 100644
--- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.3.1.page.md
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.3.1.page.md
@@ -2,6 +2,9 @@
topic: TRN-Core-1.3.1
---
+
-### Previous Releases
\ No newline at end of file
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.4.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.4.0.page.md
new file mode 100644
index 00000000..9b47681c
--- /dev/null
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/1.4.0.page.md
@@ -0,0 +1,15 @@
+---
+topic: TRN-Core-1.4.0
+---
+
+## {{page-title}}
+
+| Change | Description | Impact |
+|------------------------------------------|----------------------------------------|---------------------------------|
+| | Various updates and corrections throughout. | correction |
+
+
+
+
+
+### Previous Releases
\ No newline at end of file
From 79c9d496374fc47670ee7b5db7e9b71fc6627bbd Mon Sep 17 00:00:00 2001
From: luci-davies
Date: Thu, 19 Mar 2026 15:34:59 +0000
Subject: [PATCH 04/14] API Change log for 1.4.0 created
---
.../API-Spec-Change-Log/1.4.0.page.md | 28 +++++++++++++++++++
1 file changed, 28 insertions(+)
create mode 100644 guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.0.page.md
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.0.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.0.page.md
new file mode 100644
index 00000000..e9afa61a
--- /dev/null
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.0.page.md
@@ -0,0 +1,28 @@
+---
+topic: TRN-API-1.4.0
+---
+
+
+
+
+
+
From fa7212352571e21e5a07432f65cabba9bc4bc155 Mon Sep 17 00:00:00 2001
From: luci-davies
Date: Thu, 19 Mar 2026 15:37:26 +0000
Subject: [PATCH 05/14] TOC file updates for Core and API change logs
---
.../Technical-Release-Notes/API-Spec-Change-Log/toc.yaml | 2 ++
.../Releases/Technical-Release-Notes/BaRS-Core/toc.yaml | 2 ++
2 files changed, 4 insertions(+)
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/toc.yaml
index 5d9a1b8e..b4aa6d5d 100644
--- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/toc.yaml
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/toc.yaml
@@ -2,6 +2,8 @@
filename: Index.page.md
- name: Global
filename: Global.page.md
+- name: 1.4.0
+ filename: 1.4.0.page.md
- name: 1.3.0
filename: 1.3.0.page.md
- name: 1.2.0
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/toc.yaml
index c4319218..20a73de4 100644
--- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/toc.yaml
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/BaRS-Core/toc.yaml
@@ -1,5 +1,7 @@
- name: Index
filename: Index.page.md
+- name: 1.4.0
+ filename: 1.4.0.page.md
- name: 1.3.1
filename: 1.3.1.page.md
- name: 1.3.0
From 3a36114ee758966fe08d6371992216ade1d507d8 Mon Sep 17 00:00:00 2001
From: luci-davies
Date: Thu, 19 Mar 2026 15:42:14 +0000
Subject: [PATCH 06/14] Updates to the versioning tables
App 8 updated to minimum API and Core versions 1.4.0
---
.../Home/Analysis/Releases/Current-Releases.page.md | 8 ++++----
.../BaRS-Applications/Applications/Index.page.md | 4 ++--
.../Home/Applications/BaRS-Pre-releases/Index.page.md | 4 ++--
3 files changed, 8 insertions(+), 8 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 b9b2200a..a797fb3d 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
@@ -4,8 +4,8 @@ Product Link | Version | Handle | Phase | State | Releas
-----------------------|---------|---------|----------|-----------------|--------------|------------|-----------------
Implementation Guide | 1.11.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-General}}
[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.38.0) | 1.38.0| v1 | Live | Current Release | 26/03/2026 | Stable |
-{{pagelink:design-core-1.3.1, text:BaRS Core}} | 1.3.1 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}}
-[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_3_0) | 1.3.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-api}}
+{{pagelink:design-core-1.4.0, text:BaRS Core}} | 1.4.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}}
+[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_4_0) | 1.4.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-api}}
{{pagelink: build-testing, text: TKW}} | 1.0.21 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-tkw}}
{{pagelink:application1, text:BaRS-APP1}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}}
{{pagelink:application2, text:BaRS-APP2}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}}
@@ -190,8 +190,8 @@ Table detailing active versions of the latest Applications in Production (or cur
Application 8 v1.0.0-alpha
v1.11.0
- v1.11.0
- 1.3.0
+ v1.4.0
+ 1.4.0
Application 8 v1.0.0-alpha
v1.11.0
- v1.11.0
- 1.3.0
+ v1.4.0
+ 1.4.0
Application 8 v1.0.0-alpha
v1.11.0
- v1.11.0
- 1.3.0
+ v1.4.0
+ 1.4.0
Date: Thu, 19 Mar 2026 15:46:37 +0000
Subject: [PATCH 07/14] Update Index.page.md
---
.../BaRS-Applications/Applications/BaRS-APP8/Index.page.md | 4 ++--
1 file changed, 2 insertions(+), 2 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 0cc0d7b9..f42d5fc3 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.1.x
+ v1.4.x
v1.11.0
- v1.3.0
+ v1.4.0
From 65f5ced552a6a85bad4e9f91a2d70002f8e7b685 Mon Sep 17 00:00:00 2001
From: Carl De'ath <74620667+cda69@users.noreply.github.com>
Date: Thu, 19 Mar 2026 16:21:51 +0000
Subject: [PATCH 08/14] App8-First-Full-Draft
Updated
How does it work
Payloads
Referral Request
ERD
---
...MapIAGtoeRSReferralRequest-1.0.0-alpha.svg | 4 +
...nternal-Broker-IAG-To-e-RS-1.0.0-alpha.svg | 4 +
.../Entity-Relationship-Diagrams.page.md | 4 +-
.../BaRS-APP8/How-does-it-work.page.md | 18 +-
.../Applications/BaRS-APP8/Payloads.page.md | 20 +-
.../BaRS-APP8/Referral-Payload.page.md | 737 +++++++++---------
6 files changed, 387 insertions(+), 400 deletions(-)
create mode 100644 BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg
create mode 100644 BaRS-Images/WorkFlows/Internal-Broker-IAG-To-e-RS-1.0.0-alpha.svg
diff --git a/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg b/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg
new file mode 100644
index 00000000..18a6a033
--- /dev/null
+++ b/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg
@@ -0,0 +1,4 @@
+
+
+
+
\ 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
new file mode 100644
index 00000000..f23dad51
--- /dev/null
+++ b/BaRS-Images/WorkFlows/Internal-Broker-IAG-To-e-RS-1.0.0-alpha.svg
@@ -0,0 +1,4 @@
+
+
+
+
\ 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 f6aad729..960815bb 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 -
+The below diagram details the ServiceRequest - Referral Request - Improved Advice and Guidance to e-RS (a8t1|IAG 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 519418cb..dfaddf7c 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
@@ -7,16 +7,22 @@ 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:
-
+
-To support the workflows for this application of the standard the operations that need to be supported are:
+To support the workflows for this Application of the Standard the operations that need to be supported are:
-### Directing the Referral without a Service Discovery step
+### Directing the Referral
-
+The referral request is directed to a broker in this Application, rather than directly to a healthcare service expected to engage with the patient. The broker negotiates the next step in patient’s care journey with them, offering options and allowing the decide how to proceed. Service discovery still occurs during the assessment the Sender performs but instead of selecting a service at this stage, it is pushed to the broker.
+
+The Sender will establish the patient need, prepare a shortlist of healthcare services to support them and package these in the referral request. The request is from the Sender to the broker Receiver and then onto the selected healthcare service.
+
+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.
### Make a Referral
@@ -92,10 +98,6 @@ X-Request-Id =
X-Correlation-Id =
```
-### Cancel a Referral
-
-
-
### Bundle Processing - detailed
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 8246506b..9a2315ed 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,34 +20,36 @@ 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. Primary Care to Community Pharmacy. Please refer to the guidance in {{pagelink:core-SPUseCaseCategories-1.3.1, text:use-case categories}}
-
-*Please note that the use-case category 'referraltopharmacy' is now deprecated to allow for more granular use cases.*
+). e.g. IAG to e-RS. Please refer to the guidance in {{pagelink:core-SPUseCaseCategories-1.3.1, 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.
In the initial referral request, the Sender will include an Encounter resource as the container for their assessment, which established the need for the referral. This encounter **should** include a reference to the Sender's assessment under *encounter.identifier*. Additionally, the *encounter.episodeOfCare* **must** be populated with a 'Journey ID' reference which can be used in subsequent referrals to allow the audit of the route a patient took through service providers to resolve their initial request for care.
-A second Encounter resource is used to transfer the human readable reference of the newly created referral, at the Receiver side. When a referral request is made, the Receiver **should** include a new, secondary, encounter resource with the status of 'planned' in their synchronous HTTP response (200) to the Sender's request. This new 'planned' encounter will have both an Id and an Identifier value, indicating the Receiver's local reference and human readable one, respectively. This secondary, 'planned', encounter is not mandatory (cardinality of 0..1), unlike the primary encounter resource (1..1) (See the {{pagelink:APP5-EntityRelationshipDiagram}} for reference). The human readable (Identifier) reference is intended to allow Senders to provide something to the patient which they can take between services to support consistent joined up care, although, it is also a useful link for the services themselves to use when discussing a patient's transition of care. The local (Id) reference is not intended to be human readable but rather machine readable.
+A second Encounter resource is used to transfer the human readable reference of the newly created referral, at the Receiver side. When a referral request is made, the Receiver **should** include a new, secondary, encounter resource with the status of 'planned' in their synchronous HTTP response (200) to the Sender's request. This new 'planned' encounter will have both an Id and an Identifier value, indicating the Receiver's local reference and human readable one, respectively. This secondary, 'planned', encounter is not mandatory (cardinality of 0..1), unlike the primary encounter resource (1..1) (See the {{pagelink:APP8-EntityRelationshipDiagram}} for reference). The human readable (Identifier) reference is intended to allow Senders to provide something to the patient which they can take between services to support consistent joined up care, although, it is also a useful link for the services themselves to use when discussing a patient's transition of care. The local (Id) reference is not intended to be human readable but rather machine readable.
### CarePlan Resource
The CarePlan resource is used in a referral request to communicate the next steps in care, linking both the 'problem' identified (Condition resource, *careplan.addresses*), following the assessment performed by the Sender, and the required action to move the patient's issue to resolution (Task resource, *careplan.activity.reference*). The Receiver will utilise the detail in this resource to summarise what the previous assessment ascertained about the patient, to be used in any subsequent consultation with the patient. This overall clinical narrative and assessment output is included in this resource, under element *careplan.outcomeCodeableConcept.text*, as 'freetext'.
+Careplan includes the shortlist of healthcare services, under CarePlan.activity.details.performer, for the broker to negotiate with the patient.
+
+### Device Resource
+Device has been introduced in Application 8 because the Sender is not directing their request to a specific healthcare service but rather an internal broker. We are defining the broker (Receiver) as a FHIR Device. The broker is supporting the patient in their next step, choosing a healthcare service to undertake their care.
+In the BaRS payload, the Device is consider the performer of this next step and this is reflected in the FHIR bundle narrative by referencing Device under ServiceRequest.performer (see {{pagelink:APP8-EntityRelationshipDiagram}}).
+
### Condition Resource
The Condition resource is used to encapsulate the overall 'problem' the referral intends to resolve for the patient. The detail provided here underpins the rationale for the CarePlan and is a central resource for the Receiver looking for information about the patient and reason for referral.
-The key information about the 'problem' is comprised of two components within this Application, *condition.category* and *condition.code*. The category is used to qualify the code value, providing additional context to interpret the issue identified. For example, in this Application, the category will stipulate this is a 'presenting complaint', highlighting the provenance of the 'problem' for the Receiver to start their consultation. This is in addition to other specific status fields on the resource.
+The key information about the 'problem' is comprised of two components, *condition.category* and *condition.code*. The category is used to qualify the code value, providing additional context to interpret the issue identified. For example, the category will stipulate this is a 'presenting complaint', highlighting the provenance of the 'problem' to the Receiver.
### Task Resource
-The Task is used to direct the next action(s) required by the Sender making the referral. Task supports in fulfilling Careplan, which also references it. The narrative within the payload starts with the assessment performed by the Sender (*Encounter*), identifying a 'problem' (*Condition*) which a plan of care (*CarePlan*) is established to address. The Sender is unable to support the plan of care so transitions responsibility, via a referral (*ServiceRequest*), while directing the next requested action (*Task*).
-
-This Application utilises two elements within Task to direct the activity and timeframe, using *Task.code* and *Task.restriction*. The code will be a fixed value, indicating that a consultation is being request of the 'Community Pharmacist Consultation Service for minor illness' (Pharmacy First), dictating the action **should** take place within twenty-four hours, under the *restriction.period* element. The patient is responsible for attending the pharmacy so the timeframe is a guide, indicating when the request is expected to occur. The pharmacist will only contact the patient if they have concerns based on the referral content.
+The Task is used to direct the next action(s) required by the Sender making the referral. Task supports in fulfilling Careplan, which also references it. The narrative within the payload starts with the assessment performed by the Sender (*Encounter*), identifying a 'problem' (*Condition*) which a plan of care (*CarePlan*) is established to address. The Sender is unable to support the plan of care so transitions responsibility, via a referral (*ServiceRequest*) to the broker, while directing the next requested action (*Task*).
### Flag Resource
The Flag resource is used to communicate prospective warnings of potential issues when providing care to the patient. The population of the Flag Resource is optional as not all subjects will have relevant issues.
-BaRS Senders **should** populate Flag resources and **should** make adequate provision in their solution to support key flags in BaRS Application workflows, for example, Safeguarding, for this Application. When populating this resource, Senders **must** include both *flag.category* and *flag.code* values using the specific [BaRS CodeSystems](https://simplifier.net/nhsbookingandreferrals/~resources?category=CodeSystem&sortBy=DisplayName).
+BaRS Senders **should** populate Flag resources and **should** make adequate provision in their solution to support key flags in BaRS Application workflows, for example, Additional Patient Information. When populating this resource, Senders **must** include both *flag.category* and *flag.code* values using the specific [BaRS CodeSystems](https://simplifier.net/nhsbookingandreferrals/~resources?category=CodeSystem&sortBy=DisplayName).
When a BARS Receiver processes information in a Flag resource;
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 cc57046f..81f61229 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
@@ -3,9 +3,9 @@ topic: APP8-ReferralPayload
---
## {{page-title}}
-### Payload for requesting a referral, using Service Request
+### Payload for generating a referral to a broker, for a patient to select their next healthcare service from shortlist, using Service Request
-This payload is used to transmit all the necessary information that is required for pharmacies to accept a patient referred into their service.
+This payload is used to transmit all the necessary information that is required for an internal broker, such as e-RS, to reveiw a shortlist of healthcare services with a patient and decided the next step in their care journey.
@@ -36,10 +36,9 @@ This payload is used to transmit all the necessary information that is required
| Bundle.entry(s) | Follow BaRS profile guidance for populating this element | MUST | 1..* | |
| Bundle.entry.fullUrl | unique identifier for the resource entry. Transient id relative to the bundle | MUST | 0..1 | urn:uuid:1cbdfb97-5859-48a4-8301-d54eab818d68 |
| Bundle.entry.resourceType | Resources detailed in the message definition. | MUST | 0..1 | MessageHeader,Patient, Encounter |
-
-
+
> Message Header
@@ -50,49 +49,48 @@ This payload is used to transmit all the necessary information that is required
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| MessageHeader | https://simplifier.net/nhsbookingandreferrals/barsmessageheaderservicerequestrequest | | 1..1 | |
-| MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | |
-| MessageHeader.meta.profile | This MUST be populated with the structure definition for BaRSMessageHeader-servicerequest-request. | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSMEssageHeader-servicerequest-request |
-| MessageHeader.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
-| MessageHeader.extension | This MUST be populated with details of the Clinical Decision Support System used | SHOULD | 0..* | |
-| MessageHeader.extension.url | This MUST be populated with 'https://fhir.nhs.uk/StructureDefinition/CDSSExtension' - FIXED VALUE | SHOULD | 1..1 | https://fhir.nhs.uk/StructureDefinition/CDSSExtension |
-| MessageHeader.extension.extension | | SHOULD | 0..* | |
-| MessageHeader.extension.extension.url | This MUST be populated with the pre-defined Clinical Decision Support System software url - FIXED VALUE | SHOULD | 1..1 | RequesterCDSSSoftware |
-| MessageHeader.extension.extension.valueString | This MUST be populated with the Clinical Decision Support System software name e.g. Pathways | SHOULD | 0..1 | Pathways |
-| MessageHeader.extension.extension | | SHOULD | 0..* | |
-| MessageHeader.extension.extension.url | This MUST be populated with the pre-defined Clinical Decision Support System software Version url - FIXED VALUE | SHOULD | 1..1 | RequesterCDSSVersion |
-| MessageHeader.extension.extension.valueString | This MUST be populated with the Clinical Decision Support System software Version name e.g. 30.2.0 | SHOULD | 0..1 | 30.2.0 |
-| MessageHeader.eventcoding | | MUST | 1..1 | |
-| MessageHeader.eventcoding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/message-events-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-events-bars |
-| MessageHeader.eventcoding.code | The status MUST be populated with 'servicerequest-request'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-events-bars' - FIXED VALUE | MUST | 0..1 | servicerequest-request |
-| MessageHeader.destination | | MUST | 0..1 | |
-| MessageHeader.destination.receiver | | MUST | 0..1 | |
-| MessageHeader.destination.receiver.reference | This MUST be populated with the full url to the Receiving Organisation resource. | MUST | 0..1 | urn:uuid:10397afd-479c-42ea-9d5d-e4024481e0f8 |
-| MessageHeader.destination.endpoint | This MUST be populated with the system and Service ID separated by a pipe. for example https://fhir.nhs.uk/id/dos-service-id\|11111111, this is to ensure the receiver knows the intended destination. | MUST | 1..1 | https://fhir.nhs.uk/id/dos-service-id|1122334455 |
-| MessageHeader.sender | | MUST | 0..1 | |
-| MessageHeader.sender.reference | This MUST be populated. Follow BaRS profile guidance for populating this element | MUST | 0..1 | urn:uuid:07939a0c-2854-46ff-9282-ad906bc93679 |
-| MessageHeader.source | | MUST | 1..1 | |
-| MessageHeader.source.name | This MUST be populated with the sending system supplier name | MUST | 0..1 | NHS Trust |
-| MessageHeader.source.software | This SHOULD be populated with the sending software application name | SHOULD | 0..1 | Supplier Software |
-| MessageHeader.source.version | This SHOULD be populated with the sending software version | SHOULD | 0..1 | V1.0.0 |
-| MessageHeader.source.contact | | SHOULD | 0..1 | |
-| MessageHeader.source.contact.system | This SHOULD be populated with the Contact Type - phone \| fax \| email \| pager \| url \| sms \| other | SHOULD | 0..1 | phone |
-| MessageHeader.source.contact.value | This SHOULD be populated with the Contact Type value | SHOULD | 0..1 | +44 (0123) 123 4567 |
-| MessageHeader.source.endpoint | This MUST be populated with the system and Service ID separated by a pipe. for example https://fhir.nhs.uk/id/dos-service-id\|11111111, this is to ensure the receiver knows where any response messages SHOULD be addressed. | MUST | 1..1 | https://fhir.nhs.uk/id/dos-service-id|5566778899 |
-| MessageHeader.reason | | MUST | 0..1 | |
-| MessageHeader.reason.coding | | MUST | 0..1 | |
-| MessageHeader.reason.coding.system | This MUST be populated with 'https://fhir.nhs.uk/CodeSystem/message-reason-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-reason-bars |
-| MessageHeader.reason.coding.code | This MUST be populated with 'new' in a new message and 'update' for an update. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-events-bars' | MUST | 0..1 | new |
-| MessageHeader.reason.coding.display | This SHOULD be populated with 'new' in a new message and 'update' for an update. | SHOULD | 0..1 | New |
-| MessageHeader.focus | | MUST | 0..* | |
-| MessageHeader.focus.reference | This MUST be populated with a reference to the ServiceRequest | MUST | 0..1 | urn:uuid:236bb75d-90ef-461f-b71e-fde7f899802c |
-| MessageHeader.definition | This MUST be populated with the MessageDefinition the bundle is based on. This will be used for validation. Value - https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral | MUST | 0..1 | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral |
-
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------|
+| MessageHeader | A resource that describes the BaRS message being exchanged between two systems
https://simplifier.net/nhsbookingandreferrals/barsmessageheaderservicerequestrequest | | 1..1 | |
+| MessageHeader.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | |
+| MessageHeader.meta.profile | This MUST be populated with the structure definition for BaRSMessageHeader-servicerequest-request. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| MessageHeader.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSMEssageHeader-servicerequest-request |
+| MessageHeader.extension | This MUST be populated with details of the Clinical Decision Support System used | SHOULD | 0..* | |
+| MessageHeader.extension.url | This MUST be populated with 'https://fhir.nhs.uk/StructureDefinition/CDSSExtension' - FIXED VALUE | SHOULD | 1..1 | https://fhir.nhs.uk/StructureDefinition/CDSSExtension |
+| MessageHeader.extension.extension | | SHOULD | 0..* | |
+| MessageHeader.extension.extension.url | This MUST be populated with the pre-defined Clinical Decision Support System software url - FIXED VALUE | SHOULD | 1..1 | RequesterCDSSSoftware |
+| MessageHeader.extension.extension.valueString | This MUST be populated with the Clinical Decision Support System software name e.g. Pathways | SHOULD | 0..1 | Pathways |
+| MessageHeader.extension.extension | | SHOULD | 0..* | |
+| MessageHeader.extension.extension.url | This MUST be populated with the pre-defined Clinical Decision Support System software Version url - FIXED VALUE | SHOULD | 1..1 | RequesterCDSSVersion |
+| MessageHeader.extension.extension.valueString | This MUST be populated with the Clinical Decision Support System software Version name e.g. 30.2.0 | SHOULD | 0..1 | 30.2.0 |
+| MessageHeader.eventcoding | | MUST | 1..1 | |
+| MessageHeader.eventcoding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/message-events-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-events-bars |
+| MessageHeader.eventcoding.code | The status MUST be populated with 'servicerequest-request'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-events-bars' - FIXED VALUE | MUST | 0..1 | servicerequest-request |
+| MessageHeader.destination | | MUST | 0..1 | |
+| MessageHeader.destination.receiver | | MUST | 0..1 | |
+| MessageHeader.destination.receiver.reference | This MUST be populated with the full url to the Receiving Organisation resource. | MUST | 0..1 | urn:uuid:10397afd-479c-42ea-9d5d-e4024481e0f8 |
+| MessageHeader.destination.endpoint | This MUST be populated with the system and Service ID separated by a pipe. for example https://fhir.nhs.uk/id/dos-service-id\|11111111, this is to ensure the receiver knows the intended destination. In this Application, this will be a predefined broker. | MUST | 1..1 | https://fhir.nhs.uk/id/dos-service-id|1122334455 |
+| MessageHeader.sender | | MUST | 0..1 | |
+| MessageHeader.sender.reference | This MUST be populated. Follow BaRS profile guidance for populating this element | MUST | 0..1 | urn:uuid:07939a0c-2854-46ff-9282-ad906bc93679 |
+| MessageHeader.source | | MUST | 1..1 | |
+| MessageHeader.source.name | This MUST be populated with the sending system supplier name | MUST | 0..1 | NHS Trust |
+| MessageHeader.source.software | This SHOULD be populated with the sending software application name | SHOULD | 0..1 | Supplier Software |
+| MessageHeader.source.version | This SHOULD be populated with the sending software version | SHOULD | 0..1 | V1.0.0 |
+| MessageHeader.source.contact | | SHOULD | 0..1 | |
+| MessageHeader.source.contact.system | This SHOULD be populated with the Contact Type - phone \| fax \| email \| pager \| url \| sms \| other | SHOULD | 0..1 | phone |
+| MessageHeader.source.contact.value | This SHOULD be populated with the Contact Type value | SHOULD | 0..1 | +44 (0123) 123 4567 |
+| MessageHeader.source.endpoint | This MUST be populated with the system and Service ID separated by a pipe. for example https://fhir.nhs.uk/id/dos-service-id\|11111111, this is to ensure the receiver knows where any response messages SHOULD be addressed. | MUST | 1..1 | https://fhir.nhs.uk/id/dos-service-id|5566778899 |
+| MessageHeader.reason | | MUST | 0..1 | |
+| MessageHeader.reason.coding | | MUST | 0..1 | |
+| MessageHeader.reason.coding.system | This MUST be populated with 'https://fhir.nhs.uk/CodeSystem/message-reason-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-reason-bars |
+| MessageHeader.reason.coding.code | This MUST be populated with 'new' in a new message and 'update' for an update. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-events-bars' | MUST | 0..1 | new |
+| MessageHeader.reason.coding.display | This SHOULD be populated with 'new' in a new message and 'update' for an update. | SHOULD | 0..1 | New |
+| MessageHeader.focus | | MUST | 0..* | |
+| MessageHeader.focus.reference | This MUST be populated with a reference to the ServiceRequest | MUST | 0..1 | urn:uuid:236bb75d-90ef-461f-b71e-fde7f899802c |
+| MessageHeader.definition | This MUST be populated with the MessageDefinition the bundle is based on. This will be used for validation. Value - https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral | MUST | 0..1 | https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request-referral |
+
> Service Request
@@ -101,116 +99,129 @@ This payload is used to transmit all the necessary information that is required
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|-----------------------------------------------------------------------------|
-| ServiceRequest |https://simplifier.net/nhsbookingandreferrals/barsservicerequestrequestcasetransfer | | 1..1 | |
-| ServiceRequest.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
-| ServiceRequest.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | |
-| ServiceRequest.meta.profile | This MUST be populated with the structure definition for BaRSServiceRequest-request-referral | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSServiceRequest-request-referral |
-| ServiceRequest.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
-| ServiceRequest.basedOn | | MUST | 0..* | |
-| ServiceRequest.basedOnreference | This MUST be populated with a reference to the CarePlan resource | MUST | 0..1 | urn:uuid:236bb75d-90ef-461f-b71e-fde7f899802c |
-| ServiceRequest.status | This MUST be populated with one of three values: 'active', 'revoked' or 'entered-in-error'. 'revoked' is used when a SR is cancelled while 'entered-in-error' is used when sent to the wrong endpoint and needs to be removed. | MUST | 1..1 | active |
-| ServiceRequest.intent | This MUST be populated with 'plan' - FIXED VALUE | MUST | 1..1 | plan |
-| ServiceRequest.category | BaRS Referral Type | MUST | 1..1 | |
-| ServiceRequest.category.coding | | MUST | 0..* | |
-| ServiceRequest.category.coding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/message-category-servicerequest' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-category-servicerequest |
-| ServiceRequest.category.coding.code | This MUST be populated with Code 'referral'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-category-servicerequest' - FIXED VALUE | MUST | 0..1 | referral |
-| ServiceRequest.category.coding.display | This MUST be populated with Display 'Transfer of Care'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-category-servicerequest' | MUST | 0..1 | Transfer of Care |
-| 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 | A5T1 |
-| 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 | Primary Care to Community Pharmacy |
-| ServiceRequest.subject | Follow BaRS profile guidance for populating this element | MUST | 1..1 | |
-| ServiceRequest.subject.reference | This MUST be populated. Follow BaRS profile guidance for populating this element | MUST | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
-| ServiceRequest.encounter | | MUST | 0..1 | |
-| ServiceRequest.encounter.reference | This MUST be populated with a Reference to the Encounter resource | MUST | 0..1 | urn:uuid:8c63d621-4d86-4f57-8699-e8e22d49935d |
-| ServiceRequest.occurencePeriod | Timeframe within which pharmacy must manage the referral (Urgency) | MAY | 0..1 | |
-| ServiceRequest.occurencePeriod.start | The start of the period must be ‘now’. | MAY | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
-| ServiceRequest.occurencePeriod.end | The overall time by which the referral should be dealt with by the pharmacy. An overall 'urgency' or Service Level Agreement (SLA) of the referral could be determined based on the start and end values. If Task(s) has a restriction.period the shortest end value will determine when the next action should occur. | MAY | 0..1 | 2023-03-09T12:01:08.4677672+00:00 |
-| ServiceRequest.authoredOn | This MUST be populated with the date time the request transitioned to being actionable. In case it's 'blank' the date time SHOULD fall back to the submission time/system time of the SENDING system. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 |
-| 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 the requested HealthcareService resource | MUST | 0..1 | urn:uuid:8c63d621-2344-4f57-8699-e8e22d44235h |
-| ServiceRequest.reasonCode | This will ONLY be populated in a cancellation message with the reason for cancellation | SHOULD | 0..* | |
-| ServiceRequest.reasonCode.text | This SHOULD be populated. This will ONLY be populated in a cancellation message with the reason for cancellation and SHOULD only be used in conjunction with a corresponding status - revoked or entered-in-error | SHOULD | 0..1 | Revoked as patient has been dealt with. |
-
-
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|-------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|-----------------------------------------------------------------------------|
+| ServiceRequest | This Resource is the focus of the Referral interaction
https://simplifier.net/nhsbookingandreferrals/barsservicerequestrequestcasetransfer | | 1..1 | |
+| ServiceRequest.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
+| ServiceRequest.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 0..1 | |
+| ServiceRequest.meta.profile | This MUST be populated with the structure definition for BaRSServiceRequest-request-referral | MUST | 0..1 | https://fhir.nhs.uk/StructureDefinition/BARSServiceRequest-request-referral |
+| ServiceRequest.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| ServiceRequest.basedOn | | MUST | 0..* | |
+| ServiceRequest.basedOnreference | This MUST be populated with a reference to the CarePlan resource | MUST | 0..1 | urn:uuid:236bb75d-90ef-461f-b71e-fde7f899802c |
+| ServiceRequest.status | This MUST be populated with one of three values: 'active', 'revoked' or 'entered-in-error'. 'revoked' is used when a SR is cancelled while 'entered-in-error' is used when sent to the wrong endpoint and needs to be removed. | MUST | 1..1 | active |
+| ServiceRequest.intent | This MUST be populated with 'plan' - FIXED VALUE | MUST | 1..1 | plan |
+| ServiceRequest.category | BaRS Referral Type | MUST | 1..1 | |
+| ServiceRequest.category.coding | | MUST | 0..* | |
+| ServiceRequest.category.coding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/message-category-servicerequest' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/message-category-servicerequest |
+| ServiceRequest.category.coding.code | This MUST be populated with Code 'referral'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-category-servicerequest' - FIXED VALUE | MUST | 0..1 | referral |
+| ServiceRequest.category.coding.display | This MUST be populated with Display 'Transfer of Care'. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/message-category-servicerequest' | MUST | 0..1 | Transfer of Care |
+| 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.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 |
+| ServiceRequest.code.coding.value | This MUST be populated with the SNOMED Code Value | MUST | 0..1 | 792891000000102 |
+| ServiceRequest.code.coding.display | This MUST be populated with the SNOMED Code Display | MUST | 0..1 | Inbound referral |
+| ServiceRequest.orderDetail | "This COULD be populated where one of the shortlisted services being offered to the broker requires a referral letter (indicated by Referral Letter Required flag) Two optionsin the CodeSystem are NEED_TO_ADD_LATER
NOT_INTENDING_TO_ADD" | COULD | 0..1 | |
+| ServiceRequest.orderDetail.coding | This MUST be populated with a Coded Value | MUST | 0..1 | |
+| ServiceRequest.orderDetail.coding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/bars-broker-referral-letter-status' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/bars-broker-referral-letter-status |
+| ServiceRequest.orderDetail.coding.code | This MUST be populated with Code for the order detail. See CodeSystem: https://fhir.nhs.uk/CodeSystem/bars-broker-referral-letter-status | MUST | 0..1 | NOT_INTENDING_TO_ADD |
+| ServiceRequest.orderDetail.coding.display | This MUST be populated with Display for the order detail. See CodeSystem: https://fhir.nhs.uk/CodeSystem/bars-broker-referral-letter-status | MUST | 0..1 | Not intending to add |
+| ServiceRequest.subject | Follow BaRS profile guidance for populating this element | MUST | 1..1 | |
+| ServiceRequest.subject.reference | This MUST be populated. Follow BaRS profile guidance for populating this element | MUST | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
+| ServiceRequest.encounter | | MUST | 0..1 | |
+| ServiceRequest.encounter.reference | This MUST be populated with a Reference to the Encounter resource | MUST | 0..1 | urn:uuid:8c63d621-4d86-4f57-8699-e8e22d49935d |
+| ServiceRequest.occurencePeriod | Timeframe within which pharmacy must manage the referral (Urgency) | MAY | 0..1 | |
+| ServiceRequest.occurrencePeriod.start | This SHOULD be populated. The start of the period MUST be ‘now’. | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| ServiceRequest.occurrencePeriod.end | This SHOULD be populated with the time by which the next service provision SHOULD have started (this aligns with the disposition timeframe from Pathways) | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| ServiceRequest.authoredOn | This MUST be populated with the date time the request transitioned to being actionable. In case it's 'blank' the date time SHOULD fall back to the submission time/system time of the SENDING system. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| 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 |
+
> Encounter
-
-
+
In this interaction this resource represents the sender’s encounter. Each Organisation within the patient’s journey will create a new encounter (Case). These Encounters are linked through the Journey ID which is unchanged throughout the patient’s Journey.
For an incident with multiple patients, each patient would have its own encounter"
{{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter , hybrid}}
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Encounter | https://simplifier.net/hl7fhirukcorer4/ukcore-encounter | | 1..1 | |
-| Encounter.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
-| Encounter.meta | This MUST be populated with 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.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, 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 |
-| Encounter.Identifier | SHOULD be the human readable identifier of the encounter. | SHOULD | 0..* | |
-| 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 | 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 populated with 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 Journey ID 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 | | SHOULD | 0..1 | |
-| Encounter.period.start | This SHOULD be populated with the time the contact with the practitioner was established. This SHOULD be the contact immediately prior to the referral being sent. | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
-
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------|
+| Encounter | In this interaction this resource represents the sender’s encounter. Each Organisation within the patient’s journey will create a new encounter (Case). These Encounters are linked through the JourneyID which is unchanged throughout the patient’s Journey.
For an incident with multiple patients, each patient would have its own encounter"
https://simplifier.net/hl7fhirukcorer4/ukcore-encounter | | 1..1 | |
+| Encounter.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
+| Encounter.meta | This MUST be populated with 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.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under the meta section which MUST be the same timestamp for each resource when created from new, but MUST be a later timestamp on updates to resources, 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 |
+| Encounter.Identifier | SHOULD be the human readable identifier of the encounter. | SHOULD | 0..* | |
+| 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.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..* | |
+| 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 | | SHOULD | 0..1 | |
+| Encounter.period.start | This SHOULD be populated with the time the contact with the practitioner was established. This SHOULD be the contact immediately prior to the referral being sent. | SHOULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| | | | | |
+
> CarePlan
-
In this interaction the CarePlan resource is used to communicate triage outcome information and associated clinical information
+ In this interaction the CarePlan resource is used to communicate triage outcome information and associated clinical information. It will also contain the references to the shortlist of healthcare services.
{{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan , hybrid}}
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| CarePlan | https://simplifier.net/hl7fhirukcorer4/ukcore-careplan | | 1..1 | |
-| CarePlan.id | MUST only be generated by the Receiver as the id for the resource in the synchronous HTTP response. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
-| CarePlan.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
-| CarePlan.meta.profile | UKCore | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan |
-| CarePlan.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 |
-| CarePlan.status | This MUST be populated with the value ‘completed’ | MUST | 1..1 | completed |
-| CarePlan.intent | This MUST be populated with the value ‘plan’ | MUST | 1..1 | plan |
-| CarePlan.subject | | MUST | 1..1 | |
-| CarePlan.subject.reference | This MUST be populated with a reference to the Patient | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
-| CarePlan.encounter | | MUST | 0..1 | |
-| CarePlan.encounter.reference | This MUST be populated with a reference to the senders Encounter | MUST | 1..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4413 |
-| CarePlan.period | | MUST | 0..1 | |
-| CarePlan.period.start | Disposition date/Time. This MUST be populated with the dateTime of the identification of the dispatch/disposition code. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
-| CarePlan.addresses | | MUST | 0..* | |
-| CarePlan.addresses.reference | This MUST reference a Condition resource. This identifies which 'presenting complaint or issue' (as defined in the Information model) precipitated the generation of the CarePlan | MUST | 0..* | urn:uuid:8d12c664-0b6c-4e9b-8b70-10ccc81dbd89 |
-| CarePlan.activity | | MUST | 0..* | |
-| CarePlan.activity.outcomeCodeableConcept | | SHOULD | 0..* | |
-| CarePlan.activity.outcomeCodeableConcept.text | This SHOULD be populated with the clinical narrative.
If a triage assessment has been undertaken, using a CDSS, the Q&A output SHOULD be formatted and included as freetext in this element. | SHOULD | 0..1 | Who is this query about constipation about?: An adult or child over 10 years old\n Do you have constipation and any of the following apply to you?: None of the above\n\n Symptoms: 2/7 hx constipation\n\n Self-care / medication already tried: None\n\n Patient concerns: Unable to pass stool dor 2/7; straining.\n |
-| CarePlan.activity.reference | This MUST reference a Task resource which defines the requested instruction to the Receiver. The Sender may include multiple tasks, each under a new activity - see Task resource guidance for more detail. | MUST | 0..1 | |
-| CarePlan.activity.reference.reference | This MUST reference a Task resource indicating an instruction to the Receiver. | MUST | 0..1 | urn:uuid:6bd421cf-e43f-4470-b12d-b592f82c4bfe |
-
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| CarePlan | In this interaction the CarePlan resource is used to communicate triage outcome information and associated clinical information
https://simplifier.net/hl7fhirukcorer4/ukcore-careplan | | 1..1 | |
+| CarePlan.id | MUST only be generated by the Receiver as the id for the resource in the synchronous HTTP response. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
+| CarePlan.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| CarePlan.meta.profile | UKCore | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan |
+| CarePlan.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 |
+| CarePlan.status | This MUST be populated with the value ‘completed’ | MUST | 1..1 | completed |
+| CarePlan.intent | This MUST be populated with the value ‘plan’ | MUST | 1..1 | plan |
+| CarePlan.subject | | MUST | 1..1 | |
+| CarePlan.subject.reference | This MUST be populated with a reference to the Patient | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
+| CarePlan.encounter | | MUST | 0..1 | |
+| CarePlan.encounter.reference | This MUST be populated with a reference to the senders Encounter | MUST | 1..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4413 |
+| CarePlan.period | Aligns with priority of referral. 2WW=1 day, Urgent=8 days, Routine=21 days and, if not set, no reminder letter will be sent. | COULD | 0..1 | |
+| CarePlan.period.start | This MUST be populated with the dateTime when the first reminder letter needs to be sent and aligns with the 'priority' in the careplan.activity.outcomeCodeableConcept.coding section of this resource. | COULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| CarePlan.period.end | This MUST be populated with the dateTime when the first reminder letter needs to be sent and aligns with the 'priority' in the careplan.activity.outcomeCodeableConcept.coding section of this resource. | COULD | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| CarePlan.addresses | | MUST | 0..* | |
+| CarePlan.addresses.reference | This MUST reference a Condition resource. This identifies which 'presenting complaint or issue' (as defined in the Information model) precipitated the generation of the CarePlan | MUST | 0..* | urn:uuid:8d12c664-0b6c-4e9b-8b70-10ccc81dbd89 |
+| CarePlan.activity | | MUST | 0..* | |
+| CarePlan.activity.outcomeCodeableConcept | This will be populated with two key elements of the referral - the coded 'Priority' and 'Clinical narrative' | MUST | 0..* | |
+| CarePlan.activity.outcomeCodeableConcept.coding | This MUST be populated with the coded 'priority' of the referral - options - 2WW, Urgent, Routine | MUST | 0..1 | |
+| CarePlan.activity.outcomeCodeableConcept.coding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/bars-broker-priority-status' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/bars-broker-priority-status |
+| CarePlan.activity.outcomeCodeableConcept.coding.code | This MUST be populated with Code for the 'Priority'. See CodeSystem | MUST | 0..1 | 2WW |
+| CarePlan.activity.outcomeCodeableConcept.coding.display | This MUST be populated with Display for the 'Priority'. See CodeSystem | MUST | 0..1 | Two Week Wait |
+| CarePlan.activity.outcomeCodeableConcept.text | This SHOULD be populated with the clinical narrative.
If a triage assessment has been undertaken, using a CDSS, the Q&A output SHOULD be formatted and included as freetext in this element. | SHOULD | 0..1 | Assessed today through Advice and Guidance\n Need established for referral for suspected hernia but further assessment required\n\n Providing three healthcare options for next steps \n\n Self-care / medication already tried: None\n\n Patient concerns: mobility getting worse.\n |
+| CarePlan.activity.reference | This MUST reference a Task resource which defines the requested instruction to the Receiver. The Sender may include multiple tasks, each under a new activity - see Task resource guidance for more detail. | MUST | 0..1 | |
+| CarePlan.activity.reference.reference | This MUST reference a Task resource indicating an instruction to the Receiver. | MUST | 0..1 | urn:uuid:6bd421cf-e43f-4470-b12d-b592f82c4bfe |
+| CarePlan.activity.detail | This MUST be populated with the optional Healthcare Services being offered to the patient | MUST | 0..1 | |
+| CarePlan.activity.detail.status | This MUST be populated with a static value 'not-started' | MUST | 1..1 | not-started |
+| CarePlan.activity.detail.performer | This section can reference up to 20 Healthcare Services but MUST include 1 as a minimum | MUST | 0..* | |
+| CarePlan.activity.detail.performer.reference | This MUSt be populated with a reference to a HealthcareService contained within the bundle | MUST | 0..1 | urn:uuid:ddad9672-14ec-446d-87fa-68ac1fc4db01 |
+
> Patient
This resource is used to communicate details about the patient who is the subject of the referral.
It also includes contact information for third parties when required.
@@ -218,175 +229,200 @@ This payload is used to transmit all the necessary information that is required
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Patient | It also includes contact information for third parties when required.
https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | |
-| Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 |
-| Patient.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
-| Patient.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient |
-| Patient.meta.LastUpdate | This MUST be populated. 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 |
-| Patient.identifier | | SHOULD | 0..* | |
-| Patient.identifier.system | This SHOULD be populated with namespace for the Identifier | SHOULD | 1..1 | https://fhir.nhs.uk/Id/nhs-number |
-| Patient.identifier.value | This SHOULD be populated with a human readable patient identifier. When used this MUST be populated with the NHS number when available.If no NHS number is available this SHOULD be populated with the Local patient identifier. | SHOULD | 1..1 | 3478526985 |
-| Patient.identifier.extension | This extension is used to record the NHS number Verification status | SHOULD | 0..* | |
-| Patient.identifier.extension.url | This SHOULD be populated. Where used this MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus' - FIXED VALUE | SHOULD | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus |
-| Patient.identifier.extension.valueCodeableConcept | | SHOULD | 0..1 | |
-| Patient.identifier.extension.valueCodeableConcept.coding | | SHOULD | 0..1 | |
-| Patient.identifier.extension.valueCodeableConcept.coding.system | This SHOULD be populated. Where used this MUST be populated with CodeSystem - 'https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus' - FIXED VALUE | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus |
-| Patient.identifier.extension.valueCodeableConcept.coding.code |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.| SHOULD | 0..1 | number-present-and-verified |
-| Patient.identifier.extension.valueCodeableConcept.coding.display | 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| SHOULD | 0..1 | Number present and verified |
-| Patient.name | | SHOULD | 0..* | |
-| Patient.name.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | official |
-| Patient.name.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs Julie Jones |
-| Patient.name.family | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Jones |
-| Patient.name.given | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Julie |
-| Patient.name.prefix | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs |
-| Patient.gender | Follow UK Core guidance for populating this element | SHOULD | 0..1 | female |
-| Patient.birthDate | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 1959-05-04 |
-| Patient.address | | SHOULD | 0..* | |
-| Patient.address.use | This SHOULD be populated. Where used 'home' MUST only be used for the patient's official residing address. 'temp' is used for alternative current locations with an address format, otherwise, a Location resource can be used to pinpoint a location without a building address | SHOULD | 0..1 | home |
-| Patient.address.type | Follow UK Core guidance for populating this element | SHOULD | 0..1 | both |
-| Patient.address.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 22 Brightside Crescent, Overtown, West Yorkshire, LS10 4YU |
-| Patient.address.line | Follow UK Core guidance for populating this element | SHOULD | 0..* | 22 Brightside Crescent |
-| Patient.address.city | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Overtown |
-| Patient.address.district | Follow UK Core guidance for populating this element | SHOULD | 0..1 | West Yorkshire |
-| Patient.address.postalCode | Follow UK Core guidance for populating this element | SHOULD | 0..1 | LS10 4YU |
-| Patient.contact | This MUST be used to record telecom information for the patient and/or the patient's representative for the encounter | MUST | 0..* | |
-| Patient.contact.extension | | MUST | 0..* | |
-| Patient.contact.extension.url | This MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank' - FIXED VALUE | MUST | 0..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank |
-| Patient.contact.extension.urlvaluePositiveInt | This MUST be populated with the rank of the whole contact and MUST be populated with the value '1' for the primary person to contact for referral. There MUST be at least one contact for the referral. | MUST | 0..1 | 1 |
-| Patient.contact.relationship | | MUST | 0..* | |
-| Patient.contact.relationship.coding | | MUST | 0..* | |
-| Patient.contact.relationship.coding.system | This MUST be populated with the CodeSystem from the ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'.
Where the contact details relate to the patient this relationship MUST be populated with the value 'self'.
Where the contact details relate to a patient's representative this SHOULD be populated with their relationship to the patient.
If the relationship is not known this SHOULD be populated with the value 'Unknown' | MUST | 0..1 | http://terminology.hl7.org/CodeSystem/v2-0131 |
-| Patient.contact.relationship.coding.code | This MUST be populated with Code of CodeSystem value. See ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'. | MUST | 0..1 | EP |
-| Patient.contact.relationship.coding.display | This MUST be populated with Display of CodeSystem value. See ValueSet 'https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-personrelationshiptype'. | MUST | 0..1 | EP |
-| Patient.contact.name | | SHOULD | 0..1 | |
-| Patient.contact.name.family | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Grayson |
-| Patient.contact.name.given | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Jack |
-| Patient.contact.telecom | | MUST | 0..* | |
-| Patient.contact.telecom.system | This MUST be populated for the rank 1 contact. There MUST be at least one contact phone number for the referral | MUST | 0..1 | phone |
-| Patient.contact.telecom.value | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | 0789 1234567 |
-| Patient.contact.telecom.rank | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | 1 |
-| Patient.contact.gender | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | male |
-| Patient.Communication | | SHOULD | 0..* | |
-| Patient.Communication.Language | | MUST | 1..1 | |
-| Patient.Communication.Language.coding | | MUST | 1..1 | |
-| Patient.Communication.Language.coding.code | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | en |
-| Patient.Communication.Language.coding.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage |
-| Patient.Communication.Language.coding.display | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | English |
-| Patient.Communication.Language.preferred | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | TRUE |
-| Patient.extension | | SHOULD | 0..* | |
-| Patient.extension.url | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory |
-| Patient.extension.valueCodeableConcept | | SHOULD | 0..1 | |
-| Patient.extension.valueCodeableConcept.coding | | SHOULD | 0..* | |
-| Patient.extension.valueCodeableConcept.coding.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategory |
-| Patient.extension.valueCodeableConcept.coding.code | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | A |
-| Patient.extension.valueCodeableConcept.coding.display | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | British, Mixed British |
-| Patient.generalPractitioner | This SHOULD be populated with a reference to the GP Surgery ONLY rather than a specific practitioner | SHOULD | 0..* | |
-| Patient.generalPractitioner.reference | This SHOULD be populated. Where populated this MUST reference to an Organisation resource | SHOULD | 0..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4411 |
-
-
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|------------------------------------------------------------------------------------------|
+| Patient | This resource is used to communicate details about the patient who is the subject of the referral.
It also includes contact information for third parties when required.
https://simplifier.net/hl7fhirukcorer4/ukcore-patient | | 1..1 | |
+| Patient.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 9589fb37-87a2-48d8-968f-b371429208a8 |
+| Patient.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Patient.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient |
+| Patient.meta.LastUpdate | This MUST be populated. 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 |
+| Patient.identifier | | MUST | 0..* | |
+| Patient.identifier.system | This SHOULD be populated with namespace for the Identifier | MUST | 1..1 | https://fhir.nhs.uk/Id/nhs-number |
+| Patient.identifier.value | This SHOULD be populated with a human readable patient identifier. When used this MUST be populated with the NHS number when available.If no NHS number is available this SHOULD be populated with the Local patient identifier. | MUST | 1..1 | 3478526985 |
+| Patient.identifier.extension | This extension is used to record the NHS number Verification status | MUST | 0..* | |
+| Patient.identifier.extension.url | This SHOULD be populated. Where used this MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus' - FIXED VALUE | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus |
+| Patient.identifier.extension.valueCodeableConcept | | MUST | 0..1 | |
+| Patient.identifier.extension.valueCodeableConcept.coding | | MUST | 0..* | |
+| Patient.identifier.extension.valueCodeableConcept.coding.system | This SHOULD be populated. Where used this MUST be populated with CodeSystem - 'https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus' - FIXED VALUE | MUST | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus |
+| Patient.identifier.extension.valueCodeableConcept.coding.code | 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. | MUST | 0..1 | number-present-and-verified |
+| Patient.identifier.extension.valueCodeableConcept.coding.display | 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. | MUST | 0..1 | Number present and verified |
+| Patient.name | | SHOULD | 0..* | |
+| Patient.name.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | official |
+| Patient.name.text | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs Julie Jones |
+| Patient.name.family | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Jones |
+| Patient.name.given | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Julie |
+| Patient.name.prefix | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Mrs |
+| Patient.gender | Follow UK Core guidance for populating this element | SHOULD | 0..1 | female |
+| Patient.birthDate | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 1959-05-04 |
+| Patient.address | | MUST | 0..* | |
+| Patient.address.use | This SHOULD be populated. Where used 'home' MUST only be used for the patient's official residing address. 'temp' is used for alternative current locations with an address format, otherwise, a Location resource can be used to pinpoint a location without a building address | MUST | 0..1 | home |
+| Patient.address.type | Follow UK Core guidance for populating this element | MUST | 0..1 | both |
+| Patient.address.text | Follow UK Core guidance for populating this element | MUST | 0..1 | 22 Brightside Crescent, Overtown, West Yorkshire, LS10 4YU |
+| Patient.address.line | Follow UK Core guidance for populating this element | MUST | 0..* | 22 Brightside Crescent |
+| Patient.address.city | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Overtown |
+| Patient.address.district | Follow UK Core guidance for populating this element | SHOULD | 0..1 | West Yorkshire |
+| Patient.address.postalCode | Follow UK Core guidance for populating this element | MUST | 0..1 | LS10 4YU |
+| Patient.contact | This MUST be used to record telecom information for the patient and/or the patient's representative for the encounter | SHOULD | 0..* | |
+| Patient.contact.extension | | SHOULD | 0..* | |
+| Patient.contact.extension.url | This MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank' - FIXED VALUE | SHOULD | 0..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank |
+| Patient.contact.extension.urlvaluePositiveInt | This MUST be populated with the rank of the whole contact and MUST be populated with the value '1' for the primary person to contact for referral. There MUST be at least one contact for the referral. | SHOULD | 0..1 | 1 |
+| Patient.contact.relationship | | SHOULD | 0..* | |
+| Patient.contact.relationship.coding | | SHOULD | | |
+| Patient.contact.relationship.coding.system | This MUST be populated with the CodeSystem from the ValueSet 'https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType'.
Where the contact details relate to the patient this relationship MUST be populated with the value 'self'.
Where the contact details relate to a patient's representative this SHOULD be populated with their relationship to the patient.
If the relationship is not known this SHOULD be populated with the value 'Unknown' | SHOULD | 0..1 | https://simplifier.net/hl7fhirukcorer4/ukcore-personrelationshiptype-110 |
+| Patient.contact.relationship.coding.code | This MUST be populated with Code of CodeSystem value. See ValueSet 'https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType'. | SHOULD | 0..1 | EP |
+| Patient.contact.relationship.coding.display | This MUST be populated with Display of CodeSystem value. See ValueSet 'https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType'. | SHOULD | 0..1 | EP |
+| Patient.contact.name | | SHOULD | 0..1 | |
+| Patient.contact.name.family | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Grayson |
+| Patient.contact.name.given | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | Jack |
+| Patient.contact.telecom | | SHOULD | 0..* | |
+| Patient.contact.telecom.system | This MUST be populated for the rank 1 contact. There MUST be at least one contact phone number for the referral | SHOULD | 0..1 | phone |
+| Patient.contact.telecom.value | This MUST be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | 0789 1234567 |
+| Patient.contact.gender | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | male |
+| Patient.Communication | | SHOULD | 0..* | |
+| Patient.Communication.Language | | SHOULD | 1..1 | |
+| Patient.Communication.Language.coding | | SHOULD | 1..1 | |
+| Patient.Communication.Language.coding.code | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | en |
+| Patient.Communication.Language.coding.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage |
+| Patient.Communication.Language.coding.display | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | English |
+| Patient.Communication.Language.preferred | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | TRUE |
+| Patient.extension | | SHOULD | 0..1 | |
+| Patient.extension.url | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory |
+| Patient.extension.url.valueCodeableConcept | | SHOULD | 1..1 | |
+| Patient.extension.url.valueCodeableConcept.coding | | SHOULD | 1..1 | |
+| Patient.extension.url.valueCodeableConcept.coding.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategory |
+| Patient.extension.url.valueCodeableConcept.coding.code | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | A |
+| Patient.extension.url.valueCodeableConcept.coding.display | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | British, Mixed British |
+| Patient.generalPractitioner | This SHOULD be populated with a reference to the GP Surgery ONLY rather than a specific practitioner | SHOULD | 0..* | |
+| Patient.generalPractitioner.reference | This SHOULD be populated. Where populated this MUST reference to an Organisation resource | SHOULD | 1..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4411 |
-
+
> Condition
This resource is used to communicate details about the problem or issue of the referral.
{{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition , hybrid}}
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Condition | https://simplifier.net/HL7FHIRUKCoreR4/UKCore-Condition | | 1..* | |
-| Condition.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 7aa5814d-d71f-4c9a-a956-03d89f25aae4 |
-| Condition.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
-| Condition.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | |
-| Condition.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 |
-| Condition.clinicalStatus | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | active |
-| Condition.verificationStatus | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | unconfirmed |
-| Condition.category | The qualifier of the problem or issue necessitating the referral request | MUST | 0..1 | |
-| Condition.category.coding.system | This MUST be populated with CodeSystem - http://snomed.info/sct | MUST | 0..1 | http://snomed.info/sct |
-| Condition.category.coding.code | This MUST be populated with the Code (SNOMED) of the class of problem or issue | MUST | 0..1 | 33962009 |
-| Condition.category.coding.display | This MUST be populated with the human readable Display (SNOMED) of the class of problem or issue | MUST | 0..1 | Presenting complaint |
-| Condition.code | The 'presenting complaint or issue' (as defined in the Information model) that precipitated the generation of the associated CarePlan | MUST | 0..1 | |
-| Condition.code.text | This MUST be populated with the freetext description of the problem or issue | MUST | 0..1 | Vomiting |
-| Condition.subject | | MUST | 1..1 | |
-| Condition.subject.reference | This MUST be populated with a reference to the Patient | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
-| Condition.encounter | | MUST | 0..1 | |
-| Condition.encounter.reference | This MUST be populated with a reference to the senders Encounter | MUST | 0..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4413 |
-| Condition.note | Follow UK Core guidance for populating this element | SHOULD NOT | 0..1 | |
-
-
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|-----------------------------------------------|
+| Condition | This resource is used to communicate details about the problem or issue of the referral.
https://simplifier.net/HL7FHIRUKCoreR4/UKCore-Condition | | 1..* | |
+| Condition.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 7aa5814d-d71f-4c9a-a956-03d89f25aae4 |
+| Condition.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Condition.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | |
+| Condition.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 |
+| Condition.clinicalStatus | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | active |
+| Condition.verificationStatus | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | unconfirmed |
+| Condition.category | The qualifier of the problem or issue necessitating the referral request | MUST | 0..1 | |
+| Condition.category.coding.system | This MUST be populated with CodeSystem - http://snomed.info/sct | MUST | 0..1 | http://snomed.info/sct |
+| Condition.category.coding.code | This MUST be populated with the Code (SNOMED) of the class of problem or issue | MUST | 0..1 | 33962009 |
+| Condition.category.coding.display | This MUST be populated with the human readable Display (SNOMED) of the class of problem or issue | MUST | 0..1 | Presenting complaint |
+| Condition.code | The 'presenting complaint or issue' (as defined in the Information model) that precipitated the generation of the associated CarePlan | MUST | 0..1 | |
+| Condition.code.text | This MUST be populated with the freetext description of the problem or issue | MUST | 0..1 | Hernia |
+| Condition.subject | | MUST | 1..1 | |
+| Condition.subject.reference | This MUST be populated with a reference to the Patient | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
+| Condition.encounter | | MUST | 0..1 | |
+| Condition.encounter.reference | This MUST be populated with a reference to the senders Encounter | MUST | 0..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4413 |
+| Condition.note | Follow UK Core guidance for populating this element | SHOULD NOT | 0..1 | |
-
+
> Task
This resource is used to communicate details about Task/s that the Sender is requesting of the Receiver.
{{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task , hybrid}}
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Task | https://simplifier.net/HL7FHIRUKCoreR4/UKCore-Task | | 1..* | |
-| Task.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | a6450d17-cb7e-483b-8f71-b8201cfbcbd4 |
-| Task.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
-| Task.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | |
-| Task.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 |
-| Task.status | This MUST be populated with 'requested' - Fixed Value | MUST | 1..1 | requested |
-| Task.intent | This MUST be populated with 'order' - Fixed Value | MUST | 1..1 | order |
-| Task.code | This MUST be populated with the action (by the specific Pharmacy Service (Referral Type)) the Sender is requesting of the Receiver. If multiple actions (which are to occur within different timeframes) are to be requested these would be represented in independent Task resources. | MUST | 0..1 | |
-| Task.code.coding.system | This MUST be populated with CodeSystem - http://snomed.info/sct | MUST | 0..1 | http://snomed.info/sct |
-| Task.code.coding.code | This MUST be populated with the Code (SNOMED) of action by the Pharmacy Service | MUST | 0..1 | 2140231000000104 |
-| Task.code.coding.display | This MUST be populated with the human readable Display (SNOMED) of action by the Pharmacy Service | MUST | 0..1 | Referral to Community Pharmacy Pharmacy First Service (procedure) |
-| Task.description | This SHOULD be populated with a human readable summary of the intended instruction of the Task, combining the key elements e.g. Task.code and Task.restriction.period | SHOULD | 0..1 | 'Patient will contact pharmacy service. If, upon receipt, the pharmacist has concerns over the patient's condition they should contact the patient.' |
-| Task.focus | | | 0..1 | |
-| Task.focus.reference | Used for New Medicines Service to indicate the MedicationStatement to provide guidance on | MUST | 0..1 | urn:uuid:8c63d621-4d86-4f57-8699-e8e22d49935d |
-| Task.encounter | | SHOULD | 0..1 | |
-| Task.encounter.reference | This MUST be populated with a reference to the senders Encounter | SHOULD | 0..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4413 |
-| Task.authoredOn | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | 2023-03-08T12:15:08+00:00 |
-| Task.restriction.period | This SHOULD be populated to indicate when time sensitive requests to be undertaken | SHOULD | 0..1 | |
-| Task.restriction.period.start | This SHOULD be populated with the start of time sensitive requests for a task to be undertaken | SHOULD | 0..1 | 2023-03-08T12:45:08+00:00 |
-| Task.restriction.period.end | This SHOULD be populate with the latest time the task can be completed within | SHOULD | 0..1 | 2023-03-08T13:15:08+00:00 |
-
-
-
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|---------------------------------------------------------------------|
+| Task | This resource is used to communicate details about Task/s that the Sender is requesting of the Receiver.
https://simplifier.net/HL7FHIRUKCoreR4/UKCore-Task | | 1..* | |
+| Task.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | a6450d17-cb7e-483b-8f71-b8201cfbcbd4 |
+| Task.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Task.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | |
+| Task.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 |
+| Task.status | This MUST be populated with 'requested' - Fixed Value | MUST | 1..1 | requested |
+| Task.intent | This MUST be populated with 'order' - Fixed Value | MUST | 1..1 | order |
+| Task.code | This MUST be populated with the action (by the specific Pharmacy Service (Referral Type)) the Sender is requesting of the Receiver. If multiple actions (which are to occur within different timeframes) are to be requested these would be represented in independent Task resources. | MUST | 0..1 | |
+| Task.code.coding.system | This MUST be populated with CodeSystem - http://snomed.info/sct | MUST | 0..1 | http://snomed.info/sct |
+| Task.code.coding.code | This MUST be populated with the Code (SNOMED) of action by the Pharmacy Service | MUST | 0..1 | 792891000000102 |
+| Task.code.coding.display | This MUST be populated with the human readable Display (SNOMED) of action by the Pharmacy Service | MUST | 0..1 | Inbound referral |
+| Task.description | This SHOULD be populated with a human readable summary of the intended instruction of the Task, combining the key elements e.g. Task.code and Task.restriction.period | SHOULD | 0..1 | Provide healthcare service options to patient/client for selection' |
+| Task.encounter | | SHOULD | 0..1 | |
+| Task.encounter.reference | This MUST be populated with a reference to the senders Encounter | SHOULD | 0..1 | urn:uuid:b83d13e2-8c2e-422c-88ac-63b8e86a4413 |
+| Task.authoredOn | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | 2023-03-08T12:15:08+00:00 |
-
+
> Organization
- This resource is used to communicate details about the sender and receiver organisations.
+ This resource is used to communicate details about the sender and receiver organisations. It may also be used to convey information about the patient's registered GP Surgery
{{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization , hybrid}}
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Organisation | https://simplifier.net/hl7fhirukcorer4/ukcore-organization | | 2..* | |
-| Organization.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 5d897313-c62d-4e7e-92b7-b2199804fed3 |
-| Organization.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
-| Organization.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization |
-| Organization.meta.lastUpdated | This MUST be populated. 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 |
-| Organization.identifier | This SHOULD be populated with an organisation identifier e.g. ODS code | SHOULD | 0..* | |
-| Organization.identifier.system | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | https://fhir.nhs.uk/id/ods-organization-code |
-| Organization.identifier.value | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | ABD01 |
-| Organization.type | This is important to add type for the Sending organisation and has an explicit requirement to include. If it is available for the Receiving organisation is should be included. | SHOULD | 0..* | |
-| Organization.type.coding.system | This MUST be populated to indicate the system value, using SNOMED ReferenceSet 1127531000000102 | MUST | 0..1 | http://snomed.info/sct |
-| Organization.type.coding.value | This MUST be populated with the Value of the selected code of the organisation type. | MUST | 0..1 | 788007007 |
-| Organization.type.coding.display | This MUST be populated with the Display of the selected code of the organisation type. | MUST | 0..1 | General practice service (qualifier value) |
-| Organization.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | Organisation name |
-
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|-----------------------------------------------------------------|
+| Organisation | This resource is used to communicate details about the sender and receiver organisations.
https://simplifier.net/hl7fhirukcorer4/ukcore-organization | | 2..* | |
+| Organization.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 5d897313-c62d-4e7e-92b7-b2199804fed3 |
+| Organization.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Organization.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization |
+| Organization.meta.lastUpdated | This MUST be populated. 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 |
+| Organization.identifier | This MUST be populated with an organisation identifier e.g. ODS code | MUST | 0..* | |
+| Organization.identifier.system | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | https://fhir.nhs.uk/id/ods-organization-code |
+| Organization.identifier.value | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | ABD01 |
+| Organization.type | This is important to add type for the Sending organisation and has an explicit requirement to include. If it is available for the Receiving organisation is should be included. | SHOULD | 0..* | |
+| Organization.type.coding.system | This MUST be populated to indicate the system value, using SNOMED ReferenceSet 1127531000000102 | MUST | 0..1 | http://snomed.info/sct |
+| Organization.type.coding.value | This MUST be populated with the Value of the selected code of the organisation type. | MUST | 0..1 | 788007007 |
+| Organization.type.coding.display | This MUST be populated with the Display of the selected code of the organisation type. | MUST | 0..1 | General practice service (qualifier value) |
+| Organization.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | Organisation name |
+
+
+
+
+ > Device
+ The internal broker the referral request is being sent e.g. e-RS
+ {{tree:http://hl7.org/fhir/StructureDefinition/Device, hybrid}}
+
+
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|-----------------------------------------------|
+| Device | This resource is used to communicate where a Device is the destination/performer of a ServiceRequest, rather than a HealthcareService.
https://hl7.org/fhir/R4/device.html | | 1..* | |
+| Device.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | a6450d17-cb7e-483b-8f71-b8201cfbcbd4 |
+| Device.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Device.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | |
+| 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.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 |
+
+
+
+
+ > Healthcare Service
+ The HealthcareService(s) being offered as part of a shortlist of options for the broker to provide to the patient
+ {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService , hybrid}}
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|---------------------------------------------------------------------------------------|
+| HealthcareService | The HealthcareService the request is being made of - the Receiver
https://simplifier.net/hl7fhirukcorer4/ukcore-healthcareservice | | 1..* | |
+| HealthcareService.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 93d0ff33-ce84-42fd-b98c-f326e55283e0 |
+| HealthcareService.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| HealthcareService.meta.profile | | MUST | 1..1 | |
+| HealthcareService.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 |
+| HealthcareService.identifier | This MUST be populated, indicating the external identifier of the Receiving HealthcareService | MUST | 0..* | The Healthcare Service Identifier will be represented by a UEC DoS Service Identifier |
+| HealthcareService.identifier.system | This MUST be populated with the System of the Receiving HealthcareService identifier | MUST | 0..1 | https://fhir.nhs.uk/Id/dos-service-id |
+| HealthcareService.identifier.value | This MUST be populated with the Value of the Receiving HealthcareService identifier | MUST | 0..1 | ABD01 |
+| HealthcareService.active | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | TRUE |
+| HealthcareService.providedBy | | SHOULD | 0..1 | |
+| HealthcareService.providedBy.reference | Link to the Organisation the request is being made of . This will commonly link to the MH.destination | SHOULD | 0..1 | urn:uuid:d5ffd0cd-ec7e-48a1-84f1-91f4c0eb8fc5 |
+| HealthcareService.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | London Hospital - SDEC |
-
+
> Practitioner
- This is used to carry details of the healthcare professional making the referral
+ This is used to carry details of the healthcare professional making the referral. It can also used to provide information about the patient's registered GP.
{{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner , hybrid}}
@@ -407,11 +443,9 @@ This payload is used to transmit all the necessary information that is required
| Practitioner.telecom.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | phone |
| Practitioner.telecom.value | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 0205568263 |
| Practitioner.telecom.use | Follow UK Core guidance for populating this element | SHOULD | 0..1 | work |
-
-
-
+
> Practitioner Role
This is used to carry the role of the practitioner making the referral. Note this may be the call handler
@@ -436,44 +470,38 @@ This payload is used to transmit all the necessary information that is required
| PractitionerRole.code.coding.display | This MUST be populated with Display of CodeSystem value. See ValueSet 'https://fhir.hl7.org.uk/ValueSet/UKCore-PractitionerRoleCode'. | SHOULD | 0..1 | Administrative healthcare staff |
| PractitionerRole.healthcareService | | SHOULD | 0..* | |
| PractitionerRole.healthcareService.reference | This SHOULD be populated where the Organisation of the ServiceRequest.performer is not known. | SHOULD | 0..* | urn:uuid:6f3cc6930da34578812ca36de01268f9 |
-
-
-
-
-
+
> Flag
- The Flag resource is used to risks and special patient requirements e.g. transport requirements, accessibility requirements, and reasonable adjustments. It can also be used to carry information about safeguarding concerns.
+ The Flag resource is used to risks and special patient requirements e.g. transport requirements, accessibility requirements, and reasonable adjustments.
{{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Flag , hybrid}}
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Flag | https://simplifier.net/hl7fhirukcorer4/ukcore-flag | | 0..* | |
-| Flag.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 77be46e3-7f01-4afe-b37d-7a301db6df63 |
-| Flag.meta | https://www.hl7.org/fhir/resource.html#Meta | | 1..1 | |
-| Flag.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | http://hl7.org/fhir/StructureDefinition/Flag |
-| Flag.meta.lastUpdated | This MUST be populated. 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 |
-| Flag.status | A status of 'active' MUST be assigned | MUST | 1..1 | active |
-| Flag.category | This MUST be used to indicate the 'type' of Flag e.g. Safeguarding Concern etc. | MUST | 0..* | |
-| Flag.category.coding | This MUST be populated with the overarching Flag Category: e.g. Safeguarding or Reasonable Adjustment from CodeSystem 'https://fhir.nhs.uk/CodeSystem/flag-categories-bars' | MUST | 1..1 | |
-| Flag.category.coding.system | This MUST be populated with 'https://fhir.nhs.uk/CodeSystem/flag-categories-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/flag-categories-bars |
-| Flag.category.coding.code | This MUST be populated with the Code of the Flag Category. See CodeSystem https://fhir.nhs.uk/CodeSystem/flag-categories-bars | MUST | 0..1 | RA |
-| Flag.category.coding.display | This MUST be populated with the Display of the Flag Category. See CodeSystem https://fhir.nhs.uk/CodeSystem/flag-categories-bars | MUST | 0..1 | Reasonable Adjustment |
-| Flag.code | | MUST | 1..1 | |
-| Flag.code.coding | This MUST be populated with the detail of what is being flagged in Flag Category. e.g. for Reasonable Adjustment (Flag Category): 'adjustforneedlephobia'(Code) 'Adjust for needle phobia'(Display). It would not be appropriate to indicate a Category of 'Safeguarding' and a Code of 'Reasonable Adjustment'. The Category and Code MUST correlate. | MUST | 1..1 | |
-| Flag.code.coding.system | This MUST be populated with the Coding System for what is being flagged e.g. https://fhir.nhs.uk/CodeSystem/reasonable-adjustment-codes-bars | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/reasonable-adjustment-codes-bars |
-| Flag.code.coding.code | This MUST be populated with the relevant Code from the selected Flag code CodeSystem | MUST | 0..1 | adjustforneedlephobia |
-| Flag.code.coding.display | This MUST be populated with the Display text from the Flag code CodeSystem | MUST | 0..1 | Adjust for needle phobia |
-| Flag.subject | | MUST | 1..1 | |
-| 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 |
-
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|-----------------------------------------------------|
+| Flag | The Flag resource is used to risks and special patient requirements e.g. transport requirements, accessibility requirements, and reasonable adjustments. It can also be used to carry information about safeguarding concerns.
https://simplifier.net/hl7fhirukcorer4/ukcore-flag | | 0..* | |
+| Flag.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 77be46e3-7f01-4afe-b37d-7a301db6df63 |
+| Flag.meta | https://www.hl7.org/fhir/resource.html#Meta | | 1..1 | |
+| Flag.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | http://hl7.org/fhir/StructureDefinition/Flag |
+| Flag.meta.lastUpdated | This MUST be populated. 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 |
+| Flag.status | A status of 'active' MUST be assigned | MUST | 1..1 | active |
+| Flag.category | This MUST be used to indicate the 'type' of Flag e.g. Safeguarding Concern etc. | MUST | 0..* | |
+| Flag.category.coding | This MUST be populated with the overarching Flag Category: e.g. Safeguarding or Additonal Patient Information from CodeSystem 'https://fhir.nhs.uk/CodeSystem/flag-categories-bars' | MUST | 1..1 | |
+| Flag.category.coding.system | This MUST be populated with 'https://fhir.nhs.uk/CodeSystem/flag-categories-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/flag-categories-bars |
+| Flag.category.coding.code | This MUST be populated with the Code of the Flag Category. See CodeSystem https://fhir.nhs.uk/CodeSystem/flag-categories-bars | MUST | 0..1 | API |
+| Flag.category.coding.display | This MUST be populated with the Display of the Flag Category. See CodeSystem https://fhir.nhs.uk/CodeSystem/flag-categories-bars | MUST | 0..1 | Additional Patient Information |
+| Flag.code | | MUST | 1..1 | |
+| Flag.code.coding | This MUST be populated with the detail of what is being flagged in Flag Category. e.g. for Reasonable Adjustment (Flag Category): 'adjustforneedlephobia'(Code) 'Adjust for needle phobia'(Display). It would not be appropriate to indicate a Category of 'Safeguarding' and a Code of 'Reasonable Adjustment'. The Category and Code MUST correlate. | MUST | 1..1 | |
+| Flag.code.coding.system | This MUST be populated with the Coding System for what is being flagged e.g. https://fhir.nhs.uk/CodeSystem/reasonable-adjustment-codes-bars | MUST | 0..1 | http://snomed.info/sct |
+| Flag.code.coding.code | This MUST be populated with the relevant Code from the selected Flag code CodeSystem | MUST | 0..1 | 772132005 |
+| Flag.code.coding.display | This MUST be populated with the Display text from the Flag code CodeSystem | MUST | 0..1 | Moderate risk of harm to others |
+| Flag.subject | | MUST | 1..1 | |
+| 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 |
@@ -544,10 +572,9 @@ This payload is used to transmit all the necessary information that is required
| MedicationStatement.dosage.doseAndRate.doseQuantity.unit | Follow UK Core guidance for populating this element | SHOULD | 0..1 | milligram |
| MedicationStatement.dosage.doseAndRate.doseQuantity.system | Follow UK Core guidance for populating this element | SHOULD | 0..1 | http://unitsofmeasure.org |
| MedicationStatement.dosage.doseAndRate.doseQuantity.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | mg |
-
-
+
> Allergy Intolerance
This resource MAY be used to carry new Allergies confirmed at the senders encounter. This SHOULD NOT be used to carry Allergy History obtained from external sources.
@@ -595,60 +622,34 @@ This payload is used to transmit all the necessary information that is required
| AllergyIntolerance.reaction.manifestation.coding.code | Follow UK Core guidance for populating this element | SHOULD | 0..1 | 247472004 |
| AllergyIntolerance.reaction.manifestation.coding.display | Follow UK Core guidance for populating this element | SHOULD | 0..1 | Urticarial rash |
| AllergyIntolerance.reaction.severity | Follow UK Core guidance for populating this element | SHOULD | 0..1 | mild |
-
-
+
> Observation
- This resource can be used to communicate measurements and simple assertions made about a patient.
+ This resource can be used to communicate measurements and simple assertions made about a patient. These may be clinical or social.
{{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation , hybrid}}
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|----------------------------------------------------------------|
-| Observation | This resource can be used to communicate measurements and simple assertions made about a patient.
https://simplifier.net/hl7fhirukcorer4/ukcore-observation | | 0..* | |
-| Observation.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | e3dd3833-5622-4cdd-bddf-97942c58d190 |
-| Observation.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
-| Observation.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation |
-| Observation.meta.lastUpdated | This MUST be populated. 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 |
-| Observation.status | This MUST be populated and set to FINAL - FIXED VALUE | MUST | 1..1 | final |
-| Observation.category | This SHOULD be used to indicate the classification of Observation. | SHOULD | 0..* | |
-| Observation.category.coding | This SHOULD be populated with the overarching Observation from CodeSystem 'http://terminology.hl7.org/CodeSystem/observation-category' | SHOULD | 1..1 | |
-| Observation.category.coding.system | This SHOULD be populated with 'http://terminology.hl7.org/CodeSystem/observation-category' - FIXED VALUE | SHOULD | 0..1 | http://terminology.hl7.org/CodeSystem/observation-category |
-| Observation.category.coding.code | This SHOULD be populated with the Code of the Observation. See CodeSystem http://terminology.hl7.org/CodeSystem/observation-category | SHOULD | 0..1 | vital-signs |
-| Observation.code | This MUST be populated indicating the type of Observation, preferrably coded. | MUST | 1..1 | |
-| Observation.code.coding | This SHOULD be populated with the coded value of the type of Observation | SHOULD | 0..1 | |
-| Observation.code.coding.system | This SHOULD be populated with the code system of the type of Observation | SHOULD | 0..1 | http://snomed.info/sct |
-| Observation.code.coding.code | This SHOULD be populated with the code of the type of Observation | SHOULD | 0..1 | 75367002 |
-| Observation.code.coding.display | This SHOULD be populated with the code display of the type of Observation | SHOULD | 0..1 | Blood pressure (observable entity) |
-| Observation.performer | | SHOULD | 0..* | |
-| Observation.performer.reference | This SHOULD be populated. Where populated this MUST reference to a Practitioner resource | SHOULD | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
-| Observation.subject | | MUST | 0..1 | |
-| Observation.subject.reference | This MUST be populated with reference to a Patient resource | MUST | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
-| Observation.encounter | | SHOULD | 0..1 | |
-| Observation.encounter.reference | This SHOULD be populated. Follow UK Core guidance for populating this element | SHOULD | 0..1 | urn:uuid:8c63d621-4d86-4f57-8699-e8e22d49935d |
-| Observation.effectiveDateTime | Follow UK Core guidance for populating this element | MAY | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
-| Observation.valueQuantity | This MAY be populated to indicate the result of the Observation, such as BMI. NB - Blood pressure MUST be represented under Observation.component, as described below. | MAY | 0..1 | |
-| Observation.valueQuantity.value | This MAY be populated to indicate the result value of the Observation | MAY | 0..1 | 46 |
-| Observation.valueQuantity.unit | This MAY be populated to indicate the result unit of the Observation | MAY | 0..1 | kilogram / (meter ^ 2) |
-| Observation.valueQuantity.system | This MAY be populated to indicate the result system of the Observation | MAY | 0..1 | http://unitsofmeasure.org |
-| Observation.valueQuantity.code | This MAY be populated to indicate the result code of the Observation | MAY | 0..1 | kg/m2 |
-| Observation.note | Follow UK Core guidance for populating this element | SHOULD NOT | 0..* | |
-| Observation.component | The element details the results of an observation and is explicitly used for Blood Pressure in the current use-cases. | MAY | | |
-| Observation.component.code | This MAY be populated to indicate the type of result in coded form | MAY | 1..1 | |
-| Observation.component.code.coding | This MAY be populated to indicate the code of the type of result | MAY | 0..1 | |
-| Observation.component.code.coding.system | This MAY be populated to indicate the code system of the result | MAY | 0..1 | http://snomed.info/sct |
-| Observation.component.code.coding.code | This MAY be populated to indicate the code of the result | MAY | 0..1 | 271649006 |
-| Observation.component.code.coding.display | This MAY be populated to indicate the code display of the result | MAY | 0..1 | Systolic blood pressure |
-| Observation.component.text | This MAY be populated to indicate the text of the result | MAY | 0..1 | Systolic blood pressure |
-| Observation.component.valueQuantity | This MAY be populated to indicate the Blood pressure result of the Observation. For other observation results, such as BMI, use Observation.value[x], as described above. | MAY | 0..1 | |
-| Observation.component.valueQuantity.value | This MAY be populated to indicate the result value of the Observation | MAY | 0..1 | 120 |
-| Observation.component.valueQuantity.unit | This MAY be populated to indicate the result unit of the Observation | MAY | 0..1 | millimeter of mercury |
-| Observation.component.valueQuantity.system | This MAY be populated to indicate the result system of the Observation | MAY | 0..1 | http://unitsofmeasure.org |
-| Observation.component.valueQuantity.code | This MAY be populated to indicate the result code of the Observation | MAY | 0..1 | mm[Hg] |
-
-
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|----------------------------------------------------------------|
+| Observation | This resource can be used to communicate measurements and simple assertions made about a patient.
https://simplifier.net/hl7fhirukcorer4/ukcore-observation | | 0..* | |
+| Observation.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | e3dd3833-5622-4cdd-bddf-97942c58d190 |
+| Observation.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Observation.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation |
+| Observation.meta.lastUpdated | This MUST be populated. 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 |
+| Observation.status | This MUST be populated and set to FINAL - FIXED VALUE | MUST | 1..1 | final |
+| Observation.code | | MUST | 1..1 | |
+| Observation.code.text | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | Social Context - patient lives alone |
+| Observation.performer | | SHOULD | 0..* | |
+| Observation.performer.reference | This SHOULD be populated. Where populated this MUST reference to a Practitioner resource | SHOULD | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
+| Observation.subject | | MUST | 0..1 | |
+| Observation.subject.reference | This MUST be populated with reference to a Patient resource | MUST | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
+| Observation.encounter | | MUST | 0..1 | |
+| Observation.encounter.reference | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | urn:uuid:8c63d621-4d86-4f57-8699-e8e22d49935d |
+| Observation.effectiveDateTime | Follow UK Core guidance for populating this element | MAY | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| Observation.note | Follow UK Core guidance for populating this element | SHOULD NOT | 0..* | |
+| Observation.note.authorString | Follow UK Core guidance for populating this element | SHOULD NOT | 0..1 | |
+| Observation.note.text | Follow UK Core guidance for populating this element | SHOULD NOT | 1..1 | |
@@ -681,35 +682,9 @@ This payload is used to transmit all the necessary information that is required
| Consent.policyRule.coding.system | This MUST be populated with the namespace for the CodeSystem 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | http://terminology.hl7.org/CodeSystem/v3-ActCode |
| Consent.policyRule.coding.code | This MUST be populated with Code 'IMPLIED'. See CodeSystem 'http://terminology.hl7.org/CodeSystem/v3-ActCode'. This is the only supported option for this BaRS release - FIXED VALUE | MUST | 0..1 | IMPLIED |
| Consent.dateTime | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | 26/11/2021 |
-
-
-
-
- > Healthcare Service
- The HealthcareService the request is being made of - the Receiver
- {{tree:https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService , hybrid}}
-
-
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| HealthcareService | https://simplifier.net/hl7fhirukcorer4/ukcore-healthcareservice | | 1..1 | |
-| HealthcareService.id | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | MUST | 0..1 | 93d0ff33-ce84-42fd-b98c-f326e55283e0 |
-| HealthcareService.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
-| HealthcareService.meta.profile | | MUST | 1..1 | |
-| HealthcareService.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 |
-| HealthcareService.identifier | This MUST be populated, indicating the external identifier of the Receiving HealthcareService | MUST | 0..* | The Healthcare Service Identifier will be represented by a UEC DoS Service Identifier |
-| HealthcareService.identifier.system | This MUST be populated with the System of the Receiving HealthcareService identifier | MUST | 0..1 | https://fhir.nhs.uk/Id/dos-service-id |
-| HealthcareService.identifier.value | This MUST be populated with the Value of the Receiving HealthcareService identifier | MUST | 0..1 | ABD01 |
-| HealthcareService.active | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | TRUE |
-| HealthcareService.providedBy | | SHOULD | 0..1 | |
-| HealthcareService.providedBy.reference | Link to the Organisation the request is being made of . This will commonly link to the MH.destination | SHOULD | 0..1 | urn:uuid:d5ffd0cd-ec7e-48a1-84f1-91f4c0eb8fc5 |
-| HealthcareService.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 0..1 | Consulting psychologists and/or psychology services |
-
-
-
\ No newline at end of file
From d838fc28abf7ced03bf5bd73b66f0514c3bf6f52 Mon Sep 17 00:00:00 2001
From: luci-davies
Date: Fri, 20 Mar 2026 10:06:21 +0000
Subject: [PATCH 09/14] Update of Core version to master banner
---
guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html b/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html
index 072f69af..6ea7cdaf 100644
--- a/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html
+++ b/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html
@@ -162,7 +162,7 @@
data-uipath="document.title">
{{guide-title}}
- Guide v{{ guide-version }} | Core v1.3.1 | Package v1.38.0
+ Guide v{{ guide-version }} | Core v1.4.0 | Package v1.38.0
From e117f0c592219ab53fd446701a039a3532084ead Mon Sep 17 00:00:00 2001
From: Carl De'ath <74620667+cda69@users.noreply.github.com>
Date: Fri, 20 Mar 2026 10:07:04 +0000
Subject: [PATCH 10/14] RewordingAndTypos
---
.../Applications/BaRS-APP8/How-does-it-work.page.md | 10 ++++++----
.../Applications/BaRS-APP8/Payloads.page.md | 2 +-
2 files changed, 7 insertions(+), 5 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 dfaddf7c..9c38b1ce 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
@@ -16,13 +16,13 @@ To support the workflows for this Application of the Standard the operations tha
### Directing the Referral
-The referral request is directed to a broker in this Application, rather than directly to a healthcare service expected to engage with the patient. The broker negotiates the next step in patient’s care journey with them, offering options and allowing the decide how to proceed. Service discovery still occurs during the assessment the Sender performs but instead of selecting a service at this stage, it is pushed to the broker.
+The referral request is directed to a broker in this Application, rather than directly to the healthcare service expected to engage with the patient. The broker negotiates the next step in the patient’s care journey, offering optional healthcare services and allowing them to choose how to proceed. Service discovery still occurs during the assessment, undertaken by the Sender, but, instead of selecting a service at this stage, selection happens later in the workflow with the broker.
-The Sender will establish the patient need, prepare a shortlist of healthcare services to support them and package these in the referral request. The request is from the Sender to the broker Receiver and then onto the selected healthcare service.
+The Sender will establish the patient need, 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) ).
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.
+*NB - The definition of the broker NHSD-Target-Identifier has not yet been agreed.*
### Make a Referral
@@ -83,7 +83,7 @@ In addition to that the specific workflow parameters that are required are as fo
Additionally the HTTP request header would be:
```
-NHSD-Target-Identifier = {Receiver Service Identifier}
+NHSD-Target-Identifier = {Receiver (Broker) Service Identifier}
X-Request-Id =
X-Correlation-Id =
NHSD-End-User-Organisation = {FHIR Organisation (Base64 Encoded)}
@@ -325,6 +325,8 @@ Receive_Request
```
+*NB - Cancel and/or Update of the referral request are not yet supported in this Application*
+
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 9a2315ed..361414e5 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
@@ -35,7 +35,7 @@ The CarePlan resource is used in a referral request to communicate the next step
Careplan includes the shortlist of healthcare services, under CarePlan.activity.details.performer, for the broker to negotiate with the patient.
### Device Resource
-Device has been introduced in Application 8 because the Sender is not directing their request to a specific healthcare service but rather an internal broker. We are defining the broker (Receiver) as a FHIR Device. The broker is supporting the patient in their next step, choosing a healthcare service to undertake their care.
+Device has been introduced in Application 8 because the Sender is not directing their request to a specific healthcare service but rather an internal broker. We are defining the broker (Receiver) as a FHIR Device resource. The broker is supporting the patient in their next step, choosing a healthcare service to undertake their care.
In the BaRS payload, the Device is consider the performer of this next step and this is reflected in the FHIR bundle narrative by referencing Device under ServiceRequest.performer (see {{pagelink:APP8-EntityRelationshipDiagram}}).
### Condition Resource
From 29055d9affe73e26fa59921687fdc6acfbe19ae5 Mon Sep 17 00:00:00 2001
From: Carl De'ath <74620667+cda69@users.noreply.github.com>
Date: Fri, 20 Mar 2026 10:59:17 +0000
Subject: [PATCH 11/14] DiagramUpdates
---
.../EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg | 2 +-
...nternal-Broker-SelfReferral-To-e-RS-1.0.0-alpha.svg | 4 ++++
.../Applications/BaRS-APP8/How-does-it-work.page.md | 10 ++++++++--
3 files changed, 13 insertions(+), 3 deletions(-)
create mode 100644 BaRS-Images/WorkFlows/Internal-Broker-SelfReferral-To-e-RS-1.0.0-alpha.svg
diff --git a/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg b/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg
index 18a6a033..4247ad1b 100644
--- a/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg
+++ b/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg
@@ -1,4 +1,4 @@
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/BaRS-Images/WorkFlows/Internal-Broker-SelfReferral-To-e-RS-1.0.0-alpha.svg b/BaRS-Images/WorkFlows/Internal-Broker-SelfReferral-To-e-RS-1.0.0-alpha.svg
new file mode 100644
index 00000000..7c7dea03
--- /dev/null
+++ b/BaRS-Images/WorkFlows/Internal-Broker-SelfReferral-To-e-RS-1.0.0-alpha.svg
@@ -0,0 +1,4 @@
+
+
+
+
\ No newline at end of file
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 9c38b1ce..a92f0d7a 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
@@ -4,13 +4,19 @@ topic: APP8-HowDoesItWork
## {{page-title}}
-This section describes how the primary operations used in this application work. This diagram illustrates the workflow and interactions of a referral request:
+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:
+
+
+
-To support the workflows for this Application of the Standard the operations that need to be supported are:
+To aid the workflows for this Application of the Standard the operations that need to be supported are:
From b208fccfcefa58f7fa15b756b402158dbc46b674 Mon Sep 17 00:00:00 2001
From: Carl De'ath <74620667+cda69@users.noreply.github.com>
Date: Fri, 20 Mar 2026 11:37:35 +0000
Subject: [PATCH 12/14] Update
guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/How-does-it-work.page.md
accepted
Co-authored-by: luci-davies
---
.../Applications/BaRS-APP8/How-does-it-work.page.md | 2 +-
1 file changed, 1 insertion(+), 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 a92f0d7a..9b6b989b 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
@@ -24,7 +24,7 @@ To aid the workflows for this Application of the Standard the operations that ne
The referral request is directed to a broker in this Application, rather than directly to the healthcare service expected to engage with the patient. The broker negotiates the next step in the patient’s care journey, offering optional healthcare services and allowing them to choose how to proceed. Service discovery still occurs during the assessment, undertaken by the Sender, but, instead of selecting a service at this stage, selection happens later in the workflow with the broker.
-The Sender will establish the patient need, 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) ).
+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) ).
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.
From e408624e260bbca5fc26663882924a07463ce323 Mon Sep 17 00:00:00 2001
From: Carl De'ath <74620667+cda69@users.noreply.github.com>
Date: Fri, 20 Mar 2026 11:39:59 +0000
Subject: [PATCH 13/14] Update
guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md
Co-authored-by: luci-davies
---
.../BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
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 361414e5..b2511ba5 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
@@ -27,7 +27,7 @@ The Encounter is used to represent the interaction between a patient and healthc
In the initial referral request, the Sender will include an Encounter resource as the container for their assessment, which established the need for the referral. This encounter **should** include a reference to the Sender's assessment under *encounter.identifier*. Additionally, the *encounter.episodeOfCare* **must** be populated with a 'Journey ID' reference which can be used in subsequent referrals to allow the audit of the route a patient took through service providers to resolve their initial request for care.
-A second Encounter resource is used to transfer the human readable reference of the newly created referral, at the Receiver side. When a referral request is made, the Receiver **should** include a new, secondary, encounter resource with the status of 'planned' in their synchronous HTTP response (200) to the Sender's request. This new 'planned' encounter will have both an Id and an Identifier value, indicating the Receiver's local reference and human readable one, respectively. This secondary, 'planned', encounter is not mandatory (cardinality of 0..1), unlike the primary encounter resource (1..1) (See the {{pagelink:APP8-EntityRelationshipDiagram}} for reference). The human readable (Identifier) reference is intended to allow Senders to provide something to the patient which they can take between services to support consistent joined up care, although, it is also a useful link for the services themselves to use when discussing a patient's transition of care. The local (Id) reference is not intended to be human readable but rather machine readable.
+A second Encounter resource is used to transfer the human readable reference of the newly created referral, at the Receiver side. When a referral request is made, the Receiver **should** include a new, secondary, encounter resource with the status of 'planned' in their synchronous HTTP response (200) to the Sender's request. This new 'planned' encounter will have both an Id and an Identifier value, indicating the Receiver's local reference and human readable one, respectively. This secondary, 'planned', encounter is not mandatory (cardinality of 0..1), unlike the primary encounter resource (1..1) (See the {{pagelink:APP8-EntityRelationshipDiagram}} for reference). The human readable (Identifier) reference is intended to allow Senders to provide a reference to the patient which they can take between services to support consistent joined up care. It is also useful for the services to use when discussing a patient's transition of care. The local (Id) reference is not intended to be human readable but rather machine readable.
### CarePlan Resource
The CarePlan resource is used in a referral request to communicate the next steps in care, linking both the 'problem' identified (Condition resource, *careplan.addresses*), following the assessment performed by the Sender, and the required action to move the patient's issue to resolution (Task resource, *careplan.activity.reference*). The Receiver will utilise the detail in this resource to summarise what the previous assessment ascertained about the patient, to be used in any subsequent consultation with the patient. This overall clinical narrative and assessment output is included in this resource, under element *careplan.outcomeCodeableConcept.text*, as 'freetext'.
From 4597b969a90239d31af4c40cc759faad6b7b77e4 Mon Sep 17 00:00:00 2001
From: Carl De'ath <74620667+cda69@users.noreply.github.com>
Date: Fri, 20 Mar 2026 11:40:29 +0000
Subject: [PATCH 14/14] Update
guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md
Co-authored-by: luci-davies
---
.../BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
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 b2511ba5..bbab6e3a 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
@@ -44,7 +44,7 @@ The Condition resource is used to encapsulate the overall 'problem' the referral
The key information about the 'problem' is comprised of two components, *condition.category* and *condition.code*. The category is used to qualify the code value, providing additional context to interpret the issue identified. For example, the category will stipulate this is a 'presenting complaint', highlighting the provenance of the 'problem' to the Receiver.
### Task Resource
-The Task is used to direct the next action(s) required by the Sender making the referral. Task supports in fulfilling Careplan, which also references it. The narrative within the payload starts with the assessment performed by the Sender (*Encounter*), identifying a 'problem' (*Condition*) which a plan of care (*CarePlan*) is established to address. The Sender is unable to support the plan of care so transitions responsibility, via a referral (*ServiceRequest*) to the broker, while directing the next requested action (*Task*).
+The Task is used to direct the next action(s) required by the Sender making the referral. Task supports in fulfilling Careplan. The Careplan resource will reference the Task. The narrative within the payload starts with the assessment performed by the Sender (*Encounter*), identifying a 'problem' (*Condition*) which a plan of care (*CarePlan*) is established to address. The Sender is unable to support the plan of care so transitions responsibility, via a referral (*ServiceRequest*) to the broker, while directing the next requested action (*Task*).
### Flag Resource
The Flag resource is used to communicate prospective warnings of potential issues when providing care to the patient. The population of the Flag Resource is optional as not all subjects will have relevant issues.