Skip to content

20260703 ld ig 1.12.0 dev 2 #608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
luci-davies wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

20260703 ld ig 1.12.0 dev 2 #608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a15a164
NBRS-4779
luci-davies Jul 3, 2026
eaa65db
NBRS-4758
luci-davies Jul 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions ...S/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,20 @@ 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.|<mark style="background-color: Yellow">correction</mark>
| Scope and Requirements | Minor text changes and link to Hazard Log added|<mark style="background-color: Yellow">correction</mark>

### 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 | <mark style="background-color: Yellow">correction</mark> |
| 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 | <mark style="background-color: Yellow">correction</mark> |
| 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 | <mark style="background-color: Yellow">correction</mark> |
| 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 | <mark style="background-color: Yellow">correction</mark> |
| 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 | <mark style="background-color: Yellow">correction</mark> |
| 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 | <mark style="background-color: Yellow">correction</mark> |

<hr>
<br>
12 changes: 6 additions & 6 deletions .../Applications/BaRS-Applications/Applications/BaRS-APP8/Referral-Payload.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
9 changes: 7 additions & 2 deletions ...cations/BaRS-Applications/Applications/BaRS-APP8/Scope-and-Requirements.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,21 +42,26 @@ 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.

**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 **<ins>have</ins>** 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
Expand Down
Loading