Skip to content

V11 minor updates CGD #566

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

Merged
luci-davies merged 8 commits into from
Mar 25, 2026
Merged

V11 minor updates CGD #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
68ef789
UCC-Update
cda69 Mar 25, 2026
21f78d9
CoreGuideVersionUpdated
cda69 Mar 25, 2026
a45940f
AddedAPISpecLinkToApp8Index
cda69 Mar 25, 2026
ade4dba
UpdatedNHSNoReq
cda69 Mar 25, 2026
19b3db1
MinorHowItWorksUpdates
cda69 Mar 25, 2026
1d3d065
PayloadConsentChange
cda69 Mar 25, 2026
1512902
PayloadAndERDUpdates
cda69 Mar 25, 2026
67c7325
Banners
cda69 Mar 25, 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
2 changes: 1 addition & 1 deletion BaRS-Images/EntityMaps/EntityMapAGtoeRSReferralRequest-1.0.0-alpha.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion CodeSystem/usecases-categories-bars.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
</concept>
<concept>
<code value="a8t1" />
<display value="IAG to e-RS" />
<display value="AG to e-RS" />
</concept>
<concept>
<code value="a8t2" />
Expand Down
2 changes: 1 addition & 1 deletion ...e-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ topic: Application6
# Referrals into an Ambulance Service Trust (Application 6)


<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> This guide is currently under development <hr><p> This is a preview of a developing guide for information only. With the exception of those involved in developing solutions for the first of type (private beta), It is not intended to be used until the completed v1.0.0 documentation for this application is released <p> If you are interested in developing a BaRS compliant solution right now for the use cases covered by this application, please use the contact form <a href="https://digital.nhs.uk/services/booking-and-referral-standard/enquiry-form" target="_blank">here</a> and the team will be in touch
<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> This guide is currently under development <hr><p> This is a preview of a developing guide for information only. With the exception of those involved in developing solutions for the first of type (private beta), it is not intended to be used until the completed v1.0.0 documentation for this Application is released <p> If you are interested in developing a BaRS compliant solution right now for the use cases covered by this Application, please use the contact form <a href="https://digital.nhs.uk/services/booking-and-referral-standard/enquiry-form" target="_blank">here</a> and the team will be in touch

<p>

Expand Down
2 changes: 1 addition & 1 deletion ...e-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Index.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ topic: Application7

# Bookings and Referrals into GP (Application 7)

<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> This guide is currently under development <hr><p> This is a preview of a developing guide for information only. With the exception of those involved in developing solutions for the first of type (private beta), It is not intended to be used until the completed v1.0.0 documentation for this application is released <p> If you are interested in developing a BaRS compliant solution right now for the use cases covered by this application, please use the contact form <a href="https://digital.nhs.uk/services/booking-and-referral-standard/enquiry-form" target="_blank">here</a> and the team will be in touch
<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> This guide is currently under development <hr><p> This is a preview of a developing guide for information only. With the exception of those involved in developing solutions for the first of type (private beta), it is not intended to be used until the completed v1.0.0 documentation for this Application is released <p> If you are interested in developing a BaRS compliant solution right now for the use cases covered by this Application, please use the contact form <a href="https://digital.nhs.uk/services/booking-and-referral-standard/enquiry-form" target="_blank">here</a> and the team will be in touch

<p>

Expand Down
6 changes: 4 additions & 2 deletions .../Applications/BaRS-Applications/Applications/BaRS-APP8/How-does-it-work.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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 where healthcare options are offered to a patient by a clinician:
This diagram illustrates the workflow and interactions of a referral request where a shortlist of healthcare service options are offered to a patient by a clinician:
<br>

<img src="https://raw.githubusercontent.com/NHSDigital/NHSDigital-FHIR-BookingAndReferrals/main/BaRS-Images/WorkFlows/Internal-Broker-AG-To-e-RS-1.0.0-alpha.svg" width="1500"></img></a>
Expand All @@ -26,6 +26,8 @@ The referral request is directed to a broker in this Application, rather than di

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) ).

Alternatively, where a self-referral workflow is undertaken, the steps are the same but only one healthcare service option is included in the referral request.

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.*
Expand All @@ -39,7 +41,7 @@ The Message Definition that defines this payload for this application is: {{link

<hr>

In addition to that the specific workflow parameters that are required are as follows:
In addition, the specific workflow parameters that are required are as follows:

<div class="nhsd-m-emphasis-box">
<div class="nhsd-a-box nhsd-a-box--border-grey">
Expand Down
12 changes: 8 additions & 4 deletions ...e-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Index.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@ topic: Application8

# Referrals into a broker for Healthcare Service selection (Application 8)

<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important: Versioning information</b>
<p>
<table>
<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> This guide is currently under development <hr><p> This is a preview of a developing guide for information only. With the exception of those involved in developing solutions for the first of type (private beta), it is not intended to be used until the completed v1.0.0 documentation for this Application is released <p> If you are interested in developing a BaRS compliant solution right now for the use cases covered by this Application, please use the contact form <a href="https://digital.nhs.uk/services/booking-and-referral-standard/enquiry-form" target="_blank">here</a> and the team will be in touch

<p>

<b> Important: Versioning information</b>
<p>
<table>
<thead>
<tr>
<th data-no-sort="">Application Version</th>
Expand Down Expand Up @@ -42,7 +46,7 @@ This application supports the use of the following use cases:

### Overview

This page provides guidance for implementing the Referral Standard (BaRS) specifically for the use cases listed above. It should be used alongside the {{pagelink:design-core-1.4.0, text:BaRS Core implementation guide}} and API Specification when developing to the standard.
This page provides guidance for implementing the Referral Standard (BaRS) specifically for the use cases listed above. It should be used alongside the {{pagelink:design-core-1.4.0, text:BaRS Core implementation guide}} and [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.0) when developing to the standard.

### Data model endorsements

Expand Down
2 changes: 1 addition & 1 deletion ...aRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP8/Payloads.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ When a BARS Receiver processes information in a Flag resource;
* rendering of Flag information must be in line with the {{pagelink:Home/Analysis/BaRS-Principles-and-Prerequisites/Principles-for-rendering-BaRS-payloads.page.md, text:Principles for rendering BaRS Payload }}.

### Consent
In the BaRS UEC Applications the level of consent is stipulated to be for 'Direct Care' only. A referral **must** contain a Consent resource and it **must** adhere to the [example](https://simplifier.net/NHSBookingandReferrals/8fc39b95-89a6-45fb-914f-1458a10e9e14/~json) provided under the BaRS FHIR assets.
In BaRS Applications the level of consent is stipulated to be for 'Direct Care' only. A referral **must** contain a Consent resource and it **must** adhere to the [example](https://simplifier.net/NHSBookingandReferrals/8fc39b95-89a6-45fb-914f-1458a10e9e14/~json) provided under the BaRS FHIR assets.
<br>

<hr>
Expand Down
6 changes: 3 additions & 3 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 @@ -165,8 +165,8 @@ This payload is used to transmit all the necessary information that is required
| 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.class.code | This MUST be populated with Code 'VR'. See CodeSystem: 'http://terminology.hl7.org/CodeSystem/v3-ActCode' - FIXED VALUE | MUST | 0..1 | VR |
| Encounter.class.display | This MUST be populated with Display 'virtual'. 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..* | |
Expand Down Expand Up @@ -501,7 +501,7 @@ This payload is used to transmit all the necessary information that is required
| 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 |
| Flag.period.end | Follow UK Core guidance for populating this element | MAY | 0..1 | 2024-03-08T12:01:08.4677672+00:00 |
</details>
<p>
<details>
Expand Down
2 changes: 1 addition & 1 deletion ...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 @@ -55,7 +55,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 **<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' otherwise, the referral Sender **must <ins>not</ins>** include it in the request
- 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
- 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.
Expand Down
2 changes: 1 addition & 1 deletion guides/Live-ImplementationGuide-BaRS/Home/Core/1.4.0/Index.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ topic: design-core-1.4.0
<tbody>
<tr>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core/1.4.0" target="_blank">v1.4.0</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.10.0" target="_blank">v1.10.0</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.11.0" target="_blank">v1.11.0</td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.0" target="_blank">v1.4.0</a></td>
</tr>
</tbody>
Expand Down
Loading