Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Implementation Guide | 1.10.0 | v1 | Live | Current Release | 12/11
{{pagelink:application2, text:BaRS-APP2}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}}
{{pagelink:application3, text:BaRS-APP3}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app3,text:BaRS APP3 Change Log}}
{{pagelink:application4, text:BaRS-APP4}} | 2.0.0 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app4,text:BaRS APP4 Change Log}}
{{pagelink:application5, text:BaRS-APP5}} | 1.1.3 | v1 | Live | Current Release | 02/07/2025 | Stable |{{pagelink:trn-app5,text:BaRS APP5 Change Log}}
{{pagelink:application5, text:BaRS-APP5}} | 1.1.4 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-app5,text:BaRS APP5 Change Log}}
{{pagelink:application6, text:BaRS-APP6}} | 1.0.0-beta.6 | beta | | Current Release | 12/11/2025 | Pre-Release |{{pagelink:trn-app6,text:BaRS APP6 Change Log}}
{{pagelink:application7, text:BaRS-APP7}} | 1.0.0-alpha.4 | alpha | | Current Release | 02/07/2025 | Pre-Release |{{pagelink:trn-app7,text:BaRS APP7 Change Log}}

Expand Down Expand Up @@ -173,6 +173,10 @@ Table detailing active versions of the latest Applications in Production (or cur
<td>Application 5 v1.1.3</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.9.0</a></td>
</tr>
<tr>
<td>Application 5 v1.1.4</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td>
</tr>
<tr>
<td>Application 6 v1.0.0-beta.6</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ topic: Application1
<tbody>
<tr>
<td>Application 1 v2.0.0</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.0.x</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.10.0" target="_blank">v1.0.x</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://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a></td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ topic: Application2
<tbody>
<tr>
<td>Application 2 v2.0.0</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.0.x</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.10.0" target="_blank">v1.0.x</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://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a></td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ topic: Application3
<tbody>
<tr>
<td>Application 3 v2.0.0</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.0.x</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.10.0" target="_blank">v1.0.x</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://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a></td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ topic: Application4
<tbody>
<tr>
<td>Application 4 v2.0.0</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.0.x</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.10.0" target="_blank">v1.0.x</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://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a></td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,23 @@ topic: Application5
</thead>
<tbody>
<tr>
<td>Application 5 v1.1.3</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.1.x</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.9.0</td>
<td>Application 5 v1.1.4</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.10.0" target="_blank">v1.1.x</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://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0" target="_blank">v1.1.0</a></td>
</tr>
</tbody>
</table>

</div>

Any suppliers building to this application (Application 5) must engage with NHS England's Pharmacy First/Digital Services for Integrated Care teams prior to building Application 5.
<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important: Notice for suppliers</b>
<p>
Any suppliers building to this application (Application 5) must engage with NHS England's Pharmacy First/Digital Services for Integrated Care teams prior to building Application 5.
</p>

</div>


## Use Cases Supported

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ topic: Application6
<tr>
<td>Application 6 v1.0.0-beta.6</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.8.2" target="_blank">v1.1.x</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.10.0" target="_blank">v1.10.0</td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0" target="_blank">v1.1.0</a></td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This page provides a catalogue of implementation guides that have been developed



These guides are designed to be used in conjunction with the documentation for {{pagelink:design-core-1.0.7}}.
These guides are designed to be used in conjunction with the documentation for {{pagelink:design-core-1.3.1}}.



Expand All @@ -23,7 +23,7 @@ These guides are designed to be used in conjunction with the documentation for {
| {{pagelink:application2, text: Booking and Referrals into UEC (Application 2)}} | <p>111 Online - ED <br>111 Online - UTC <br> S&R - ED <br> S&R - UTC <br> <p> | 2.0.0 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a> | <a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/BaRS-Core?version=1.0.0" target="_blank">v1.0.0</a> |
| {{pagelink:application3, text: Referral into UEC (Application 3)}} | <p>999-CAS Referral<br> | 2.0.0 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a> | <a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/BaRS-Core?version=1.0.0" target="_blank">v1.0.0</a> |
| {{pagelink:application4, text: Referral into UEC for Validation (Application 4)}} | <p>999-CAS Validation<br> <p>999 AST to Falls Lifting Service<br> <p>999 AST to Community Services <br> | 2.0.0 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">v1.0.0</a> | <a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/BaRS-Core?version=1.0.0" target="_blank">v1.0.0</a> |
| {{pagelink:application5, text: Referrals into Pharmacy (Application 5)}} | <p>Primary Care to Community Pharmacy (Pharmacy First)<br> <p>Primary Care to Pharmacy Contraception (Oral Contraception) <br> <p>Primary Care to Pharmacy Blood Pressure Check Service<br> | 1.1.3 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0" target="_blank">v1.3.0</a> | {{pagelink:design-core-1.3.1, text:v1.3.0}} |
| {{pagelink:application5, text: Referrals into Pharmacy (Application 5)}} | <p>Primary Care to Community Pharmacy (Pharmacy First)<br> <p>Primary Care to Pharmacy Contraception (Oral Contraception) <br> <p>Primary Care to Pharmacy Blood Pressure Check Service<br> | 1.1.4 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0" target="_blank">v1.3.0</a> | {{pagelink:design-core-1.3.1, text:v1.3.0}} |


<hr>
Expand Down Expand Up @@ -174,6 +174,10 @@ Table detailing active versions of the latest Applications in Production (or cur
<td>Application 5 v1.1.3</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.9.0</a></td>
</tr>
<tr>
<td>Application 5 v1.1.4</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td>
</tr>
<tr>
<td>Application 6 v1.0.0-beta.6</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,10 @@ Table detailing active versions of the latest Applications in Production (or cur
<td>Application 5 v1.1.3</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.9.0</a></td>
</tr>
<tr>
<td>Application 5 v1.1.4</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td>
</tr>
<tr>
<td>Application 6 v1.0.0-beta.6</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.10.0</a></td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ topic: Connect-as-a-receiver

BaRS uses TLS-MA to communicate with Receiving endpoints. Receiving endpoints need a certificate under the NHS Root CA to facilitate TLS-MA. The receiver needs to follow these steps to access Integration (INT) and Production (PROD) environments.

<br>


### 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.
Expand All @@ -22,13 +25,15 @@ Step 3: Create a Certificate Signing Request (*.csr). This is the file you will
openssl genpkey -algorithm RSA -out private.key -aes256
```
Create the *.csr, use the following command:</br>
**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>

```
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>

#### Client certificate: Integration (INT)

Step 1: Contact ITOC to make a [Combined endpoint and service registration request](https://digital.nhs.uk/services/path-to-live-environments/path-to-live-forms/combined-endpoint-and-service-registration-request)
Expand All @@ -38,13 +43,16 @@ In the form:
* Select Create/renew a certificate only (No endpoint)
* Specify Integration environment
* FQDN must match your domain and CN on the cert e.g. '**BaRS-INT-\<ODS Code\>.\<Supplier name\>.thirdparty.nhs.uk**'
* In Additional comments/notes, state ‘BaRS’ certificate request
Add ‘N/A’ in the Party Key field because there is no relation to SDS endpoints
* In "Additional comments/notes" state ‘BaRS’ certificate request
*Add ‘N/A’ in the "Existing party key" field because there is no relation to SDS endpoints.

Step 2: Receive certificate from ITOC

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

<br>


#### Client certificate: Production (PROD)

**Production endpoints can only be requested when Solution Assurance issue the supplier with the Technical Conformance certificate**
Expand All @@ -62,6 +70,9 @@ Step 3: Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The BaRS Proxy uses the ServiceId in the HTTP Header to reference the BaRS Endpo

* Obtain the service's URL endpoint details from the Receiving supplier or provider. The endpoint will need to be certified and meet the criteria for connection to the BaRS Proxy. More details are available in [Connecting as a receiver](https://simplifier.net/guide/nhsbookingandreferralstandard/Home\Build\Testing-and-Environments\Connect-as-a-receiver.page.md)

* Email bookingandreferralstandard@nhs.net with the serviceid and endpoint details. State the environment to be configured, INT or PROD, and include planned dates for testing.
* Email: <england.bookingandreferralstandard@nhs.net> with the ServiceId and endpoint details. State the environment to be configured, INT or PROD, and include planned dates for testing.

**Note**: CareConnect configuration must be maintained alongside the BaRS configuration. This is so senders who are not yet BaRS compliant can still work with CareConnect and GP Connect.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## {{page-title}}

If the Receiving provider operates within Urgent and Emergency Care (UEC), they are likely to have a UEC Directory of Services (DoS) entry. DoS leads must configure Service Providers who wish to use BaRS in the standard way, as the service dictates, but their DoS ServiceId will also need to exist in the BaRS Endpoint Catalogue.
Each service delivered by an Urgent and Emergency Care (UEC) provider has an entry in the UEC Directory of Services (DoS). DoS Leads will continue to configure new UEC providers and services in the DoS, issuing each service with a DoS ServiceID. If the provider is going to use receive BaRS messages, the DoS ServiceId will also need to exist in the BaRS Endpoint Catalogue.

Find out more about the [Directory of Service](https://digital.nhs.uk/services/directory-of-services-dos#top)
<br>
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## {{page-title}}

BaRS receivers need to configure firewall exceptions for both Integration and Production environments.
BaRS receivers need to configure firewall exceptions for both Integration (INT) and Production (PROD) environments.

Requests from the BaRS API Proxy will originate from:

Expand Down
Loading