Skip to content

Fixes from testing #530

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
cda69 merged 1 commit into from
Nov 3, 2025
Merged

Fixes from testing #530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions ...Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Current-Releases.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Product Link | Version | Handle | Phase | State | Release Date | Stability | Change Log Link
-----------------------|---------|---------|----------|-----------------|--------------|------------|-----------------
Implementation Guide | 1.10.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-General}}
[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.35.0) | 1.37.0| v1 | Live | Current Release | 12/11/2025 | Stable |
[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.37.0) | 1.37.0| v1 | Live | Current Release | 12/11/2025 | Stable |
{{pagelink:design-core-1.3.1, text:BaRS Core}} | 1.3.1 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}}
[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_3_0) | 1.3.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-api}}
[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) | 1.3.0 | v1 | Live | Current Release | 02/07/2025 | Stable |{{pagelink:trn-api}}
{{pagelink: build-testing, text: TKW}} | 1.0.19 | v1 | Live | Current Release | 28/03/2025 | Stable |{{pagelink:trn-tkw}}
{{pagelink:application1, text:BaRS-APP1}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}}
{{pagelink:application2, text:BaRS-APP2}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}}
Expand Down
4 changes: 2 additions & 2 deletions guides/Live-ImplementationGuide-BaRS/Home/Assure/Assure/Assure.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ The assurance process ensures solutions adhere to the Standard and are compatibl

The purpose of assurance is to:
* Validate conformance to the requirements and specifications of the Standard
* Assess higher-risk and/or complex workflow scenarios, to ensure technical and clinical readiness
* Assess higher-risk and/or complex workflow scenarios, ensuring patient safety and technical and clinical readiness
* Serve as a final quality assurance checkpoint prior to deployment to Production

There are limitations to this (self) assurance process, which does **not** extend to:
* Validation of every individual workflow scenario or minor message variation within an assured solution
* Review of all message content against the Standard, either visually or through tooling. This **must** be included in supplier's functional testing
* Review of all message content against the Standard, either visually or through tooling. This **must** be included in the supplier's functional testing
* Regression testing of supplier solution to ensure that existing functionality has not been adversely affected
12 changes: 7 additions & 5 deletions ...ionGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ BaRS uses TLS-MA to communicate with Receiving endpoints. Receiving endpoints ne

### How to connect to the BaRS proxy as a Receiver:

Step 1: Apply for your domain [apply for a new nhs.uk domain](https://digital.nhs.uk/services/networking-addressing/apply-for-an-nhs.uk-domain-for-websites-and-web-applications). You must complete Section 5: For website or application records visible on the public internet.
Step 1: Apply for your domain [apply for a new nhs.uk domain](https://digital.nhs.uk/services/networking-addressing/apply-for-an-nhs.uk-domain-for-websites-and-web-applications). You must complete Section 5: For domain names visible only on the public internet

Step 2: Request a certificate under the NHS Root CA. The FQDN must be an nhs.uk address.
There are different certificate chains for INT and PROD:
Expand All @@ -30,6 +30,7 @@ Create the *.csr, use the following command:</br>
openssl req -new -key private.key -out request.csr
```
**Note:** <small>_Generate the CSR with only the common name field populated, which must match the FQDN. All other fields can remain blank. The email field MUST be blank. Please note FQDNs MUST be in the .nhs.uk domain as we can only issue certificates in this domain._</small>

Step 4: Send the .csr file to be signed by NHS England and get the client certificate. To do this, follow these environment specific steps:

<br>
Expand Down Expand Up @@ -60,21 +61,22 @@ Step 3: Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for
Step 1: Send the .csr to <dir@nhs.net>, indicating this is for a BaRS Receiver endpoint

Formats for FQDN on PROD:

* Supplier hosted (multi-tenanted) solutions ‘**BaRS-PROD-\<ODS Code\>.\<Supplier name\>.thirdparty.nhs.uk**’

* Service Provider hosted (on-premise) solutions‘**BaRS-PROD-\<ODS Code\>.\<Provider name\>.nhs.uk**’
* Service Provider hosted (on-premise) solutions ‘**BaRS-PROD-\<ODS Code\>.\<Provider name\>.nhs.uk**’

Step 2: Receive certificate from DIR Team

Step 3: Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for BaRS/API-M to add to the Endpoint Catalogue

Step 4: Make changes to your [firewall exceptions](https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Deploy/Technical-deployment\Firewallexceptions) to receive messages from the BaRS proxy.
Step 4: Make changes to your [firewall exceptions](https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Deploy/Technical-deployment/Firewallexceptions) to receive messages from the BaRS proxy.

<br>


#### Installing and configuring your application to use the certificate
Step 1: INT and PROD copy the cert text inlcuding `-----BEGIN CERTIFICATE` as the first line and `END CERTIFICATE-----` as the last. Save this text locally as a file called barsinreceiver.cer (change the name to suit).
Step 1: INT and PROD copy the cert text including `-----BEGIN CERTIFICATE` as the first line and `END CERTIFICATE-----` as the last. Save this text locally as a file called barsinreceiver.cer (change the name to suit).

Step 2: Create a .pfx file so you can serve HTTPS (TLS) endpoints. You can use the command below to export a *.pfx file from the *.key file you made earlier (when you made the *.csr file) along with the *.cer file you were emailed.

Expand All @@ -86,7 +88,7 @@ Step 3: Create a password for your .pfx file.

Step 4: Make configuration changes to reference the *.pfx file and password

(C# example, Other launguages will vary but be similar)
(C# example, Other languages will vary but be similar)

``` c#

Expand Down
4 changes: 2 additions & 2 deletions ...ationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-sender.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ topic: connect-as-a-sender

## {{page-title}}

API-M provides the [security model](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) for BaRS.
APIM provides the [security model](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) for BaRS.

To connect to the BaRS proxy as a sender follow these steps:

Step 1: follow the NHS Developer authenitication and authorisation process [NHS Developer authentication and authorisation](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-login-separate-authentication-and-authorisation#step-1-register-your-application-with-nhs-login)
Step 1: follow the NHS Developer authentication and authorisation process [NHS Developer authentication and authorisation](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/user-restricted-restful-apis-nhs-login-separate-authentication-and-authorisation#step-1-register-your-application-with-nhs-login)

Step 2: trust the Certificate Authorities (CA) mentioned below. For INT this will be downloadable from http://pki.nhs.uk/int/G2/auth/NHSINTAuthG2.crt
( you can examine the .cer file if you have one )
Expand Down
Loading