diff --git a/BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg b/BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg
new file mode 100644
index 00000000..849f3ac9
--- /dev/null
+++ b/BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg
@@ -0,0 +1,4 @@
+
+
+
+
\ No newline at end of file
diff --git a/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg b/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg
deleted file mode 100644
index 4247ad1b..00000000
--- a/BaRS-Images/EntityMaps/EntityMapIAGtoeRSReferralRequest-1.0.0-alpha.svg
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-
\ No newline at end of file
diff --git a/BaRS-Images/WorkFlows/Internal-Broker-AG-To-e-RS-1.0.0-alpha.svg b/BaRS-Images/WorkFlows/Internal-Broker-AG-To-e-RS-1.0.0-alpha.svg
new file mode 100644
index 00000000..ffeb683f
--- /dev/null
+++ b/BaRS-Images/WorkFlows/Internal-Broker-AG-To-e-RS-1.0.0-alpha.svg
@@ -0,0 +1,4 @@
+
+
+
+
\ No newline at end of file
diff --git a/BaRS-Images/WorkFlows/Internal-Broker-IAG-To-e-RS-1.0.0-alpha.svg b/BaRS-Images/WorkFlows/Internal-Broker-IAG-To-e-RS-1.0.0-alpha.svg
deleted file mode 100644
index f23dad51..00000000
--- a/BaRS-Images/WorkFlows/Internal-Broker-IAG-To-e-RS-1.0.0-alpha.svg
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-
\ No newline at end of file
diff --git a/Examples/Questionnaire for PTS.xml b/Examples/Questionnaire for PTS.xml
index 1320f8aa..d5d85199 100644
--- a/Examples/Questionnaire for PTS.xml
+++ b/Examples/Questionnaire for PTS.xml
@@ -24,14 +24,14 @@
-
-
-
-
-
-
@@ -29,8 +29,8 @@
-
-
+
+
Any suppliers building to this application (Application 5) must engage with NHS England's Pharmacy First/Digital Services for Integrated Care teams prior to building Application 5. + + The only use case suppliers can develop to in Application 5 is Primary Care to Community Pharmacy (Pharmacy First).
-| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
-|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------|--------------------------------------------------------------------------------------------------------------------------|
-| Encounter | https://simplifier.net/hl7fhirukcorer4/ukcore-encounter | | 1..1 | |
-| Encounter.id | MUST only be generated by the originating system of the encounter as the id for the resource in the original HTTP request. It MUST be echoed back when returning an encounter. Subsequent new Encounters will be generated by the originating system of that encounter. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
-| Encounter.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
-| Encounter.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter |
-| Encounter.status | The status must be set to the current Encounter status:
- When the case is waiting for a resource to be allocated OR a resource has been cancelled, this MUST be populated with 'planned'
- When the case has had a resource allocated this MUST be populated with 'in-progress'
- For a case where the resource has cleared the scene this MUST be populated with 'finished'
- Where a Mutual Aid or Call Assist request is being rejected, this MUST be populated with 'cancelled' | MUST | 1..1 | in-progress |
-| Encounter.statusHistory | List of past and current encounter statuses | MUST | 0..* | |
-| Encounter.statusHistory.status |
The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them | MUST | 1..1 | planned |
-| Encounter.statusHistory.period |
The time that the encounter was in the specified status. | | | |
-| Encounter.statusHistory.period.start |
The time that the encounter started in the specified status. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 |
-| Encounter.class | | MUST | 1..1 | |
-| Encounter.class.system | This MUST be populated with CodeSystem 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | http://terminology.hl7.org/CodeSystem/v3-ActCode |
-| Encounter.class.code | This MUST be populated with Code 'EMER'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | EMER |
-| Encounter.class.display | This MUST be populated with Display 'emergency'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | emergency |
-| Encounter.subject | | MUST | 0..1 | |
-| Encounter.subject.reference | This MUST be a reference to the Patient resource. | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
-| Encounter.episodeOfCare | | MUST | 0..* | |
-| Encounter.episodeOfCare.reference | This MUST be populated with the JourneyID which links all encounters within the patient’s journey. This MUST be created at the patient’s first contact and passed in all subsequent referrals. | MUST | 1..1 | 9589fb37-87a2-48d8-968f-b371429208a8 |
-| Encounter.period | | MUST | 0..1 | |
-| Encounter.period.start | This MUST be populated with the Encounter start time. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
-| Encounter.reasonCode | Reason for Rejection -This MUST be populated if the response it a rejection. | MUST | 0..1 | |
-| Encounter.reasonCode.system | This MUST be populated with the following system - https://fhir.nhs.uk/CodeSystem/rejection-reason-bars | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/rejected-reasons-bars |
-| Encounter.reasonCode.code | This MUST be populated with a value from https://fhir.nhs.uk/CodeSystem/rejection-reason-bars | MUST | 0..1 | RRNA |
-| Encounter.reasonCode.display | This MUST be populated with the code description | MUST | 0..1 | Requested resource not available within timescale |
-| Encounter.reasonCode.text | This SHOULD be populated with a free text reason for cancellation. This MUST be populated if the Encounter.reasonCode.code is populated with 'OTH' | SHOULD | 0..1 | We have a paramedic but not available for 30 mins |
-
+| Data Item | Implementation Guidance | Necessity | Profile Cardinality | Example Value(s) |
+|--------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---------------------|--------------------------------------------------------------|
+| Encounter | In this interaction this resource represents the Receiver's encounter. This is the focus resource for this response.
https://simplifier.net/hl7fhirukcorer4/ukcore-encounter | | 1..1 | |
+| Encounter.id | MUST only be generated by the originating system of the encounter as the id for the resource in the original HTTP request. It MUST be echoed back when returning an encounter. Subsequent new Encounters will be generated by the originating system of that encounter. | MUST | 0..1 | 236bb75d-90ef-461f-b71e-fde7f899802c |
+| Encounter.meta | https://www.hl7.org/fhir/resource.html#Meta | MUST | 1..1 | |
+| Encounter.meta.profile | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter |
+| Encounter.status | The status must be set to the current Encounter status:
- When the case is waiting for a resource to be allocated OR a resource has been cancelled, this MUST be populated with 'planned'
- When the case has had a resource allocated this MUST be populated with 'in-progress'
- For a case where the resource has cleared the scene this MUST be populated with 'finished'
- Where a Mutual Aid or Call Assist request is being rejected, this MUST be populated with 'cancelled' | MUST | 1..1 | in-progress |
+| Encounter.statusHistory | List of past and current encounter statuses. These SHOULD NOT be populated in the Receiver's Encounter and asynchronous responses. | SHOULD NOT | 0..* | |
+| Encounter.statusHistory.status |
This SHOULD NOT be populated in the Receiver's response Encounter. | SHOULD NOT | 1..1 | |
+| Encounter.statusHistory.period |
This SHOULD NOT be populated in the Receiver's response Encounter. | SHOULD NOT | | |
+| Encounter.statusHistory.period.start |
This SHOULD NOT be populated in the Receiver's response Encounter. | SHOULD NOT | 1..1 | |
+| Encounter.class | | MUST | 1..1 | |
+| Encounter.class.system | This MUST be populated with CodeSystem 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | http://terminology.hl7.org/CodeSystem/v3-ActCode |
+| Encounter.class.code | This MUST be populated with Code 'EMER'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | EMER |
+| Encounter.class.display | This MUST be populated with Display 'Emergency'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | Emergency |
+| Encounter.subject | | MUST | 0..1 | |
+| Encounter.subject.reference | This MUST be a reference to the Patient resource. | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
+| Encounter.episodeOfCare | | MUST | 0..* | |
+| Encounter.episodeOfCare.reference | This MUST be populated with the JourneyID which links all encounters within the patient’s journey. This MUST be created at the patient’s first contact and passed in all subsequent referrals. | MUST | 1..1 | 9589fb37-87a2-48d8-968f-b371429208a8 |
+| Encounter.period | | MUST | 0..1 | |
+| Encounter.period.start | This MUST be populated with the Encounter start time. | MUST | 0..1 | 2023-03-08T12:01:08.4677672+00:00 |
+| Encounter.reasonCode | Reason for Rejection -This MUST be populated if the response it a rejection. | MUST | 0..1 | |
+| Encounter.reasonCode.system | This MUST be populated with the following system - https://fhir.nhs.uk/CodeSystem/rejection-reason-bars | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/rejected-reasons-bars |
+| Encounter.reasonCode.code | This MUST be populated with a value from https://fhir.nhs.uk/CodeSystem/rejection-reason-bars | MUST | 0..1 | RRNA |
+| Encounter.reasonCode.display | This MUST be populated with the code description | MUST | 0..1 | Requested resource not available within timescale |
+| Encounter.reasonCode.text | This SHOULD be populated with a free text reason for cancellation. This MUST be populated if the Encounter.reasonCode.code is populated with 'OTH' | SHOULD | 0..1 | We have a paramedic but not available for 30 mins |
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Entity-Relationship-Diagrams.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Entity-Relationship-Diagrams.page.md
index 960815bb..0768b282 100644
--- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Entity-Relationship-Diagrams.page.md
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Entity-Relationship-Diagrams.page.md
@@ -8,10 +8,10 @@ topic: APP8-EntityRelationshipDiagram
Entity maps detail the relationship of the resources and elements within resources in the payloads.
-The below diagram details the ServiceRequest - Referral Request - Improved Advice and Guidance to e-RS (a8t1|IAG to e-RS)
+The below diagram details the ServiceRequest - Referral Request - Improved Advice and Guidance to e-RS (a8t1|AG to e-RS)
-
+
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/How-does-it-work.page.md
index 041a94a7..e6504b6f 100644
--- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/How-does-it-work.page.md
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/How-does-it-work.page.md
@@ -9,7 +9,7 @@ This section describes how the primary operations used in this Application work.
This diagram illustrates the workflow and interactions of a referral request where healthcare options are offered to a patient by a clinician:
-
+
The Application also supports a self-referral workflow:
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md
index 83de00cc..952b91ae 100644
--- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md
+++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md
@@ -18,9 +18,9 @@ topic: Application8
@@ -390,7 +390,7 @@ This payload is used to transmit all the necessary information that is required | Device.meta.lastUpdated | All resources MUST include 'lastUpdated' value, under meta section which must be the same timestamp for each resource when created from new, but must be a later timestamp on updates, if the content of a particular resource contains updated info for subsequent updates. Otherwise, maintain the timestamp originally sent. | MUST | 1..1 | 2023-03-08T12:01:08.4677672+00:00 | | Device.status | This MUST be populated with 'active' - Fixed Value | MUST | 1..1 | active | | Device.deviceName | | | | | -| Device.deviceName.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | eRS | +| Device.deviceName.name | This MUST be populated. Follow UK Core guidance for populating this element | MUST | 1..1 | e-RS | | Device.deviceName.type | This MUST be populated with 'user-friendly-name' - Fixed Value | MUST | 1..1 | user-friendly-name | | Device.owner | | MUST | 1..1 | | | Device.owner.reference | This MUST be populated with a reference to the Patient | MUST | 1..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md index 909ee480..4afd8ddb 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md @@ -5,13 +5,12 @@ TOPIC: APP8-ScopeAndRequirements ## {{page-title}} ### Scope Overview -This BaRS Application (Referrals from Advice and Guidance to eRS broker, Application 8) supports the following use case(s) ONLY: -* Improved Advice and Guidance to electronic-Referral Service (e-RS) + +This BaRS Application (Referrals from Advice and Guidance to e-RS broker, Application 8) supports the following use case(s) ONLY: +* Advice and Guidance to electronic-Referral Service (e-RS) * 111Online to electronic-Referral Service (e-RS) * NHS.UK to electronic-Referral Service (e-RS) - - The payload and workflow have been designed to support these services. Other {{pagelink:applications, text:BaRS Applications}} offer scope for alternative use cases. ### Functional Scope @@ -55,7 +54,7 @@ The payload and workflow have been designed to support these services. Other {{p **Referral** - The referral Receiver **must** accept the referral request regardless of whether the patient is known to the service provider -- The referral Receiver **must** only accept potential patients who do **have** a national validated identifier e.g. NHS Number +- The referral Receiver **must** only accept potential patients who **have** a national validated identifier e.g. NHS Number - The national identifier **must** have a [verification status](https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-nhsnumberverificationstatus) of 'Number present and verified' otherwise, the referral Sender **must not** include it in the request - Any new or existing safeguarding concern, recorded as part of the assessment, **must** be included in the referral Sender's request - The referral Receiver **must** clearly identify any included safeguarding concern to the end user @@ -64,7 +63,7 @@ The payload and workflow have been designed to support these services. Other {{p - Where the referral was not successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.4.0, text:failure scenarios}} for more detail - Where the referral was not successful, the Sender **must** present an appropriate message to the end user. See {{pagelink:core-failure_scenarios-1.4.0, text:failure scenarios}} for more detail - The referral Sender **must** indicate consent to share (for Direct Care) to the Receiver -- The referral Sender **must** indicate the urgency (using the agreed codeset) of the request to the Receiver +- The referral Sender **must** indicate the urgency (using the [agreed codesystem](https://simplifier.net/nhsbookingandreferrals/bars-broker-priority-status)) of the request to the Receiver ### Audit diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md index 99631cd6..d3002f3b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md @@ -178,6 +178,10 @@ Table detailing active versions of the latest Applications in Production (or cur
-This version of core is strictly a preview of what is currently in development for 1.3.1 and should not be built against. +This version of core is strictly a preview of what is currently in development for 1.4.0 and should not be built against.