Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
85f0353
Update broken link and refine content
luci-davies May 8, 2026
b142b31
Fix typo
luci-davies May 8, 2026
223fc8f
Remove surplus page appearing in error
luci-davies May 8, 2026
76b0ed4
Copilot Review Corrections
d-dreyer May 8, 2026
c62ad32
Update Message-Headers.page.md
d-dreyer May 8, 2026
b395da5
Data item guidance updated for encounter.status
luci-davies May 8, 2026
0a96719
Content update to include arrived status
luci-davies May 8, 2026
7f7dd46
Merge pull request #592 from NHSDigital/20260508-DD-IG1.11.1-CopilotR…
d-dreyer May 8, 2026
2ad4b2a
NBRS-4661 - Updated App 8 Flag Links
d-dreyer May 8, 2026
fba6af3
NBRS-4663 - Update Patient Identifier Coding Guidance
d-dreyer May 8, 2026
9396063
NBRS-4647 - Remove App8 Pharmacy References
d-dreyer May 8, 2026
c95686c
Updated image
luci-davies May 11, 2026
2cdde5e
Merge pull request #593 from NHSDigital/20260508-DD-IG1.11.1-App8Updates
d-dreyer May 11, 2026
00faeb0
Added new file for CAD-CAD workflows
luci-davies May 11, 2026
ba5fda6
Updates to reference updated/new images
luci-davies May 11, 2026
66f3d6a
Change log and release note updates
luci-davies May 11, 2026
04e020c
Merge pull request #594 from NHSDigital/20260508-LD-IG1.11.1-dev-2
luci-davies May 11, 2026
44dc51f
Merge pull request #595 from NHSDigital/20260511-LD-IG1.11.1-dev-3
luci-davies May 11, 2026
49dc4e1
NBRS-4658 - Updates for DOS API Deprecation
d-dreyer May 11, 2026
e6688e7
Minor Spelling Corrections
d-dreyer May 11, 2026
64cdb58
Merge pull request #596 from NHSDigital/20260511-DD-IG1.11.1-DOSUpdates
d-dreyer May 11, 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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.vscode
4 changes: 4 additions & 0 deletions BaRS-Images/WorkFlows/CADOutOfArea-1.0.3.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions BaRS-Images/WorkFlows/CADOutOfAreaAsncResponses-1.0.0.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ Implementation Guide | 1.11.1 | v1 | Live | Current Release | 19/05

### Overview of the release

TBC
Release 1.11.1 of the BaRS Implementation Guide is a patch release including an additional encounter.status value for Application 6 CAD-CAD Out of Area Referral, published with supporting documentation. BaRS Core version is uplifted to 1.4.1 in line with an update to the BaRS FHIR API OAS file.

Also included in this release are minor changes to BaRS Application 8 and bug fixes and corrections throughout the guide.

A clinical safety assessment of the scope of this release has determined that it has not significantly changed the clinical safety profile of the BaRS. No new hazards have been identified in this release. The latest version of the BaRS clinical safety case and hazard log can be downloaded from the <a href= "https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/onboarding-support-information#hazard-log-and-clinical-safety-case-report-cscr-" target="_blank"> BaRS FHIR API onboarding support information page </a>.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ topic: TRN-API-1.3.0

| Change | Description | Impact |
|----------------------------------------------|---------------------------------------------------------------------|--------|
| <div class="imgHandshake">{{render:handshake}}</div> - Additional patient demographic parameters added to GET /Appointment | 1.9.0 | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | <mark style="background-color: Green">Addition</mark> |
| <div class="imgHandshake">{{render:handshake}}</div> - Additional patient demographic parameters added to GET /ServiceRequest | 1.9.0 | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | <mark style="background-color: Green">Addition</mark> |
| Fixed incorrect character display on GET /Slot description | 1.9.0 | Character display for a double quote was illegible. | <mark style="background-color: Yellow">correction</mark> |
| <div class="imgHandshake">{{render:handshake}}</div> - Additional patient demographic parameters added to GET /Appointment | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | <mark style="background-color: Green">Addition</mark> |
| <div class="imgHandshake">{{render:handshake}}</div> - Additional patient demographic parameters added to GET /ServiceRequest | Patient demographic parameters (Name, Date of Birth and Address) added to support patient lookup for cancellation and update workflows. | <mark style="background-color: Green">Addition</mark> |
| Fixed incorrect character display on GET /Slot description | Character display for a double quote was illegible. | <mark style="background-color: Yellow">correction</mark> |


<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ topic: TRN-API-1.4.0

| Change | Description | Impact |
|----------------------------------------------|---------------------------------------------------------------------|--------|
| <div class="imgHandshake">{{render:handshake}}</div> - Describe change | 1.11.0 | Describe impact | <mark style="background-color: Green">Addition</mark> |
| <div class="imgHandshake">{{render:handshake}}</div> - Added Endpoint Catalogue related endpoints | Added preview operations for use in the Endpoint Catalogue, related to entities like Endpoints and Endpoint Templates | <mark style="background-color: Green">Addition</mark> |



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ topic: TRN-API-1.4.1

| Change | Description | Impact |
|----------------------------------------------|---------------------------------------------------------------------|--------|
| <div class="imgHandshake">{{render:handshake}}</div> - Describe change | 1.11.1 | Describe impact | <mark style="background-color: Green">Addition</mark> |
| <div class="imgHandshake">{{render:handshake}}</div> - Corrections on EPC preview endpoints | Minor fixes to the preview version of the Endpoint Catalogue related endpoints | <mark style="background-color: Yellow">correction</mark> |



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,18 @@ This is a minor "patch" with clarifications to limited areas of the Implementati


| Change | Description | Impact |
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|
|
| Implementation guidance updated | patient.id implementation guidance corrected | <mark style="background-color: Yellow">correction</mark> |
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------
|Implementation guidance updated | encounter.status implementation guidance updated to include "arrived" | <mark style="background-color: LightGreen">non-breaking</mark> |
| Out of Area Worflow diagram updated | Workflow diagram updated to reference additional workflow explanation of status updates (action triggered business acknowledgement) | <mark style="background-color: LightGreen">non-breaking</mark> |
| BaRS Application 6 - Asynchronous Response flows diagram added | Workflow diagram added for status updates (action triggered business acknowledgement) | <mark style="background-color: LightGreen">non-breaking</mark> |


### Payload Change Log


| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| tbc | tbc | tbc | Update | Referral Request |Bug fix | <mark style="background-color: Yellow">correction</mark> |
| encounter.status | | ...For a case where a resource has arrived on scene this MUST be populated with ‘arrived’... | Update | Referral Response |Change | <mark style="background-color: LightGreen">non-breaking</mark> |


<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ Receive_Request

if (Message == "update")
{
if (currentLocalData.LastUpdated > originaRequest.ReceivedDate)
if (currentLocalData.LastUpdated > originalRequest.ReceivedDate)
{
OperationOutcome.issue.code = "conflict"
throw exception with 'REC_CONFLICT'
Expand All @@ -592,7 +592,7 @@ Receive_Request
{
if (currentLocalData.Item.exists)
{
if (currentLocalData.LastUpdated > originaRequest.Received)
if (currentLocalData.LastUpdated > originalRequest.Received)
{
OperationOutcome.issue.code = "conflict"
throw exception with 'REC_CONFLICT'
Expand Down Expand Up @@ -720,7 +720,20 @@ This means that these services will only accept a referral if a booking has also

If no appointment is available then a referral should not be made.

To achieve this, a "service attribute" is configurable against services. This will allow the service to be flagged as "booking only". Therefore if this attribute is present on the service all consumer systems should withhold referrals. <a href="https://developer.nhs.uk/apis/dos-api/ccs_fields_v1.5_service_attribute.html" target="_blank">The DoS API documentation for this can be found here</a>.
To achieve this, a "service attribute" is configurable against services. This will allow the service to be flagged as "booking only". Therefore if this attribute is present on the service all consumer systems should withhold referrals. <a href="https://digital.nhs.uk/developer/api-catalogue/directory-of-services-urgent-and-emergency-care-rest" target="_blank">The DoS API documentation for this can be found here</a>.

<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> DOS API Deprecation <hr>
<p> The current version of the DOS API is being deprecated, with a new API currently in Beta. <a href="https://digital.nhs.uk/developer/api-catalogue/directory-of-services-search-api">Documentation for the new API can be found here</a>, which includes the estimated roadmap.
<p> Whilst suppliers can continue to develop towards the current API, this would then require future rework to utilize the new API as the deprecation process continues.
<p> For more information on the deprecation, as well as guidance on onboarding and implementing towards the new API, please contact the DOS team directly.
<p> You can contact the DOS team via one of the contact options below, stating <b>“For the attention of Find the Right Service Team – Integrated Search.”</b>
<p><b>Contact Options:</b><br/>
<ul>
<li><a href="https://nhsdigitallive.service-now.com/csm?id=csm_index">ServiceNow Portal (preferred option)</a> </li>
<li>Email - <a href="ssd.nationalservicedesk@nhs.net">ssd.nationalservicedesk@nhs.net</a> </li>
<li>Telephone - 0300 3035035 - Please call if your query is urgent </li>
</ul>
</div>

##### Workflow

Expand Down
Loading
Loading