From a15a164901632a8a8bf27e6598f845ba1bffa2db Mon Sep 17 00:00:00 2001 From: luci-davies Date: Fri, 3 Jul 2026 14:18:14 +0100 Subject: [PATCH 1/2] NBRS-4779 Changes made to Referral Payload for App 8 Changes reflected in App 8 change log --- .../TRN-APP8/1.0.0-alpha.3.page.md | 9 +++++++-- .../Applications/BaRS-APP8/Referral-Payload.page.md | 12 ++++++------ 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md index f37caec2..0005d3d4 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md @@ -11,14 +11,19 @@ This is a pre-release of v1.0.0-alpha.3 - Referrals into a broker for Healthcare | Change | Description | Impact | |-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------| - +| Patient Identifier Resource | Updates to Referral Payload Implementation Guidance for multiple elements to improve clarity.|correction ### Payload Change Log | FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact | |------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------| - +| Patient.identifier.system | This SHOULD be populated with namespace for the Identifier. | This MUST be populated with namespace for the Identifier. | Update | Referral Response |Change | correction | +| 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. | This MUST be populated with a human readable patient identifier. When used this MUST be populated with the NHS number when available. | Update | Referral Response |Change | correction | +| 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 | This MUST be populated. Where used this MUST be populated with Structure Definition 'https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus' - FIXED VALUE | Update | Referral Response |Change | correction | +| 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 | This MUST be populated with CodeSystem - 'https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus' - FIXED VALUE | Update | Referral Response |Change | correction | +| 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. | This MUST be populated. This MUST be 'number-present-and-verified' only. No other statuses are permitted. | Update | Referral Response |Change | correction | +| 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. |This MUST be populated. This MUST be populated with 'Number present and verified'. No other statuses are permitted. | Update | Referral Response |Change | correction |

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 9788f2d2..4300418f 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 @@ -237,15 +237,15 @@ This payload is used to transmit all the necessary information that is required | 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.system | This MUST be populated with namespace for the Identifier | MUST | 1..1 | https://fhir.nhs.uk/Id/nhs-number | +| Patient.identifier.value | This MUST be populated with a human readable patient identifier. When used this MUST be populated with the NHS number when available. | 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.url | This MUST 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' 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'. No other statuses are permitted. | MUST | 0..1 | Number present and verified | +| Patient.identifier.extension.valueCodeableConcept.coding.system | 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 MUST be populated. This MUST be 'number-present-and-verified' only. No other statuses are permitted. | MUST | 0..1 | number-present-and-verified | +| Patient.identifier.extension.valueCodeableConcept.coding.display | This MUST be populated. This MUST be populated with 'Number present and verified'. 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 | From eaa65db921bc4d0ddd04aa75ef80fe23aa57585f Mon Sep 17 00:00:00 2001 From: luci-davies Date: Fri, 3 Jul 2026 14:26:52 +0100 Subject: [PATCH 2/2] NBRS-4758 Added link for Hazard Log Added definitions text Edited typo to improve readability --- .../TRN-APP8/1.0.0-alpha.3.page.md | 1 + .../BaRS-APP8/Scope-and-Requirements.page.md | 9 +++++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md index 0005d3d4..0344d6dd 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md @@ -12,6 +12,7 @@ This is a pre-release of v1.0.0-alpha.3 - Referrals into a broker for Healthcare | Change | Description | Impact | |-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------| | Patient Identifier Resource | Updates to Referral Payload Implementation Guidance for multiple elements to improve clarity.|correction +| Scope and Requirements | Minor text changes and link to Hazard Log added|correction ### Payload Change Log 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 375b829f..c9dcfaef 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 @@ -42,13 +42,18 @@ The payload and workflow have been designed to support these services. Other {{p - BaRS currently supports the communication of consent for direct care only - Certificates for Receiving messages to use nhs.uk domains only - Receiving endpoints are to be internet facing -- Clincial Constraints exist - See Hazard Log +- Clincial Constraints exist - See [Hazard Log](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/onboarding-support-information#downloads) - No element level 'updates' to requests are supported. A new request must be generated to change information in the referral request - No digital support to remove or cancel a referral are offered (this would need to be achieved manually) - The service discovery tool for establishing services for onward care must be the [e-RS Service Search API A010](https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir#post-/STU3/HealthcareService/$ers.searchHealthcareServicesForPatient) ### Requirements +Definitions used in these requirements: +- The referral Sender is the system/organisation making the referral request +- The referral Receiver is the system/organisation the referral is being sent to, in this specific case - the broker (e-RS) +- The end user is a person in an organisation using BaRS + **Service Discovery** - Where more than one service is shortlisted, the maximum number of services allowed on a given shortlist is 20. @@ -56,7 +61,7 @@ The payload and workflow have been designed to support these services. Other {{p - The referral Receiver **must** accept the referral request regardless of whether the patient is known to the service provider - The referral Receiver **must** only accept potential patients who **have** a national validated identifier e.g. NHS Number - The national identifier **must** have a [verification status](https://simplifier.net/hl7fhirukcorer4/valueset-ukcore-nhsnumberverificationstatus) of 'Number present and verified'. -- Any new or existing safeguarding concern, recorded as part of the assessment, **must** be included in the referral Sender's request +- Any new or existing safeguarding concern, recorded as part of the assessment, **must** be included in the referral request - The referral Receiver **must** clearly identify any included safeguarding concern to the end user - The referral Receiver **must** accurately represent information made by the Sender to the end user. - The referral Sender **must** make available the human readable identifier for the referral, included in the HTTP synchronous response, to the end user