Skip to content

Copilot Review Corrections #592

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
d-dreyer merged 2 commits into from
May 8, 2026
Merged

Copilot Review Corrections #592

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
76b0ed4
Copilot Review Corrections
d-dreyer May 8, 2026
c62ad32
Update Message-Headers.page.md
d-dreyer May 8, 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
6 changes: 3 additions & 3 deletions ...ome/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.3.0.page.md
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion ...ome/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.0.page.md
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion ...ome/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.4.1.page.md
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion ...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 @@ -23,7 +23,7 @@ topic: Application8
<tr>
<td>Application 8 v1.0.0-alpha.2</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.11.1" target="_blank">v1.1.x</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.11.1" target="_blank">v1.11.1</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.11.1" target="_blank">v1.11.1</a></td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1" target="_blank">v1.4.x</a></td>
</tr>
</tbody>
Expand Down
6 changes: 3 additions & 3 deletions ...ore/1-4-1/DocumentReference-StandardPattern/DocumentReference-Interface.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ The BaRS API will facilitate the DocumentReference Endpoints for BaRS enabled sy

This table describes the two endpoints behaviours for the interaction From a BaRS enabled system through to NRLF.

All Endpoints will use the exsiting Access Control Headers and Transaction Integrity Headers.
All Endpoints will use the existing Access Control Headers and Transaction Integrity Headers.

| Behaviour | Initiator | VERB | API Path | Parameters | Payload | Reactor | Reactor Behaviour | Happy Response | Response Definition |
|-----------------|---------------|--------|-------------------------|---------------------------------------------------------------------------------------------|-------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------|
| Search Pointers | BaRS Sender | GET | /DocumentReference | Query: subject:identifier<br>Query: custodian:identifier<br>Query: next-page-token<br>Query:type | N/A | BaRS & NRLF | BaRS: Request forwarded verbatim to NRLF Consumer Endpoint<br>NRLF: NRLF returns Bundle of DocumentReferences matching search critieria. | 200 | Search Bundle Response containing DocumentReferences |
| Search Pointers | BaRS Sender | GET | /DocumentReference | Query: subject:identifier<br>Query: custodian:identifier<br>Query: next-page-token<br>Query:type | N/A | BaRS & NRLF | BaRS: Request forwarded verbatim to NRLF Consumer Endpoint<br>NRLF: NRLF returns Bundle of DocumentReferences matching search criteria. | 200 | Search Bundle Response containing DocumentReferences |
| Get Pointer | BaRS Receiver | GET | /DocumentReference/[id] | Path: id | N/A | BaRS & NRLF | BaRS: Request forwarded verbatim to NRLF Producer Endpoint<br>NRLF: NRLF returns Bundle of DocumentReference matching path param [id]. | 200 | DocumentReference |
| Add Pointer | BaRS Receiver | POST | /DocumentReference | N/A | DocumentReference | BaRS & NRLF | BaRS: Request forwarded verbatim to NRLF Producer Endpoint<br>NRLF: returns a DocumentReference | 201 | OperationOutcome/DocumentReference |
| Update Pointer | BaRS Receiver | PUT | /DocumentReference/[id] | Path: id | DocumentReference | BaRS & NRLF | BaRS: Request forwarded verbatim to NRLF Producer Endpoint<br>NRLF: NRLF updates the DocumentReference | 200 | OperationOutcome/DocumentReference |
Expand All @@ -39,7 +39,7 @@ All Endpoints will use the exsiting Access Control Headers and Transaction Integ
| /DocumentReference | query | subject:identifier | https://fhir.nhs.uk/Id/nhs-number|4409815415 | Filter by Patient | Y |
| /DocumentReference | query | custodian:identifier | https://fhir.nhs.uk/Id/ods-organization-code|Y05868 | Filter by custodian (ODS) | N |
| /DocumentReference | query | next-page-token | - | retrieve next set of 20 records | N |
| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequesr | N |
| /DocumentReference | query | type | http://snomed.info/sct|736253002 | Filter by Appointment or ServiceRequest | N |
| /DocumentReference/[id] | path | [ id ] | | Specific Document Reference Id. | Y |

## Payload
8 changes: 4 additions & 4 deletions ...ide-BaRS/Home/Core/1-4-1/EndpointCatalogue-StandardPattern/Introduction.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ topic: core-StandardPattern-Endpoint-Introduction-1.4.1
<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important: Versioning information - Preview</b>
<p>

This version of core is strictly a preview of what is currently in development for 1.2.0 and should <b>not be built against.</b>
This version of core is strictly a preview of what is currently in development for 1.4.x and should <b>not be built against.</b>

<table>
<thead>
Expand All @@ -17,9 +17,9 @@ This version of core is strictly a preview of what is currently in development f
</thead>
<tbody>
<tr>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/BaRS-Core?version=1.0.0" target="_blank">v1.2.0-alpha</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.1.0" target="_blank">v1.8.0</td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" target="_blank">v1.2.0</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/BaRS-Core?version=1.4.1" target="_blank">v1.4.x</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.11.1" target="_blank">v1.11.x</a></td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.4.1" target="_blank">v1.4.x</a></td>
</tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion .../1-4-1/Error-Handling/Failure-Scenarios-1-1-x/General-Failure-Scenarios.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This section will define errors that could be seen in any given step and shared
| 406 | SEND_NOT_ACCEPTABLE | processing | The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. Versions in Accept or content.<br><br>Version is not present in FOT and should be ignored in FOT if presented. Post FOT it MUST be evaluated. | API |
| 406 | REC_NOT_ACCEPTABLE | processing | The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. Versions in Accept or content.<br><br>Version is not present in FOT and should be ignored in FOT if presented. Post FOT it MUST be evaluated. | Receiver |
| 429 | SEND_TOO_MANY_REQUESTS | throttled | when rate limiting is applied. | API |
| 409 | REC_TIMEOUT | timeout | Injected when a 504 is generated in the proxy due to a receiver timing out on a response. | API Injected |
| 408 | REC_TIMEOUT | timeout | Injected when a 504 is generated in the proxy due to a receiver timing out on a response. | API Injected |
| 500 | REC_SERVER_ERROR | transient | An unexpected exception has occurred during processing at the receiver. | Receiver/ API Injected |
| 500 | PROXY_SERVER_ERROR / SERVER ERROR | transient | An unexpected exception has occurred during processing internally. | API |
| 501 | REC_NOT_IMPLEMENTED | not-supported | The receiver has not yet implemented that endpoint or functionality. | Receiver |
Expand Down
2 changes: 1 addition & 1 deletion ...aRS/Home/Core/1-4-1/Error-Handling/Failure-Scenarios-1-1-x/Introduction.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ This page defines the foreseen failure scenarios within the BaRS standard and it

The rationale, described in the {{pagelink:core-failure_scenarios-1.4.1, text:error handling}} section is that as much information on the nature of the failure as possible is provided in a standard way.

Each scenario has a Source to state whether it is the BaRS Proxy or the Receiver which is generating the error. In scenarios where a SEND prefix is used, the sender is not adhering to the API specification in one way or another. These codes are held within OperationOoutcome.issue.details.code and use the http-error-codes value set.
Each scenario has a Source to state whether it is the BaRS Proxy or the Receiver which is generating the error. In scenarios where a SEND prefix is used, the sender is not adhering to the API specification in one way or another. These codes are held within OperationOutcome.issue.details.code and use the http-error-codes value set.

Note: in future, the PROXY prefix will no longer be used, and all errors from the Proxy will use a code with no prefix.
8 changes: 4 additions & 4 deletions ...mentationGuide-BaRS/Home/Core/1-4-1/Security-and-Authorisation/Receiver.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ BaRS will utilise TLS-MA (Mutual Authentication) to communicate with receiving e

- The receiver will need to request a certificate under the NHS Root CA
- There are two different certificate chains for INT and Prod
- INT Certificate chains, which are superceded from 4/06/2024, can be found [here](https://digital.nhs.uk/services/path-to-live-environments/integration-environment#rootca-and-subca-certificates)
- Prod Certificate chains,which expire from 4/06/2024, can be found [here](https://digital.nhs.uk/services/path-to-live-environments/live-environment)
- **Current** INT Certificate chains can be found [here](https://pki.nhs.uk/G2Transition/)
- INT Certificate chains, which are superseded from 4/06/2024, can be found [here](https://digital.nhs.uk/services/path-to-live-environments/integration-environment#rootca-and-subca-certificates)
- Prod Certificate chains, which expire from 4/06/2024, can be found [here](https://digital.nhs.uk/services/path-to-live-environments/live-environment)
- **Current** INT Certificate chains can be found [here](https://pki.nhs.uk/G2Transition/)
- **Current** Prod Certificate chains can be found [here](https://pki.nhs.uk/G2Transition/)

- The receiving endpoint will present the certificate obtained for TLS-MA
Expand All @@ -25,7 +25,7 @@ In production there is a naming convention that must be adhered to. In INT the n

- ==BaRS-< ODSCode >.< OrganisationName >.nhs.uk== , BaRS is always the application name.

Once you have you have your domain registered you can then begin the process to obtain your certificate by generating a certificate request.
Once you have your domain registered you can then begin the process to obtain your certificate by generating a certificate request.

Certificate requests will need to be signed for your endpoint. Note that the FQDN is equal to the certificate name (CN) by convention.

Expand Down
Loading
Loading