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 @@ We recommend reading the following documentation as part of the discovery stage
* [BaRS FHIR API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0)

### Onboarding
{{pagelink:Home/Build/Testing-and-Environments/Onboarding.page.md, text:Onboarding}} with our platform is a self-service process. This step is required to make requests of the BaRS API and have requests forwarded to your endpoint, as a Receiver. This **must** occur on both Integration (INT) and Production environments. The {{pagelink:Home/Build/Testing-and-Environments/Onboarding.page.md, text: full step-by-step onboarding guide}} can be followed by any solution on either environment.
{{pagelink:Testing-and-Environments, text:Connecting to environments}} on our platform is a self-service process. This step is required to make requests of the BaRS API and have requests forwarded to your endpoint, as a Receiver. This **must** occur on both Integration (INT) and Production environments.

Full details of the security model adopted by the platform can be found under the [security](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication) section.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This page describes BaRS principles and prerequisites for suppliers. Elements of
3. Systems MUST support JSON formats for all API interactions
4. Systems SHOULD have a FHIR Server or FHIR functionality in place
5. Systems SHOULD implement RESTful behaviour patterns
6. System Suppliers MUST complete the {{pagelink:Home/Build/Testing-and-Environments/Onboarding.page.md, text:BaRS onboarding process}}
6. System Suppliers MUST complete the {{pagelink:Testing-and-Environments, text:BaRS connecting to environments process}}
7. Systems MUST support Service Discovery

<br>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
topic: infrastructure
---

# {{page-title}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
topic: infrastructure
---

# Infrastructure

The infrastructure components defined as parts of BaRS are offered for use as a set of centralised services that can support workflows and simplify integration between systems.

There are two elements to this infrastructure:

- **a routing proxy** that enables systems to connect to each other in a scalable way that does not require each side to have pre-configured direct connections
- a set of enabling **discovery services** that allow BaRS clients to "discover" events, tasks and requests that have been made using BaRS compliant systems from a number of contexts

The routing proxy is the main infrastructure component of BaRS and is hosted and maintained on the centralised NHS API Management platform. It is comprised of several components but, from a developer perspective, it can be thought of as a proxy. All requests are routed through it, it brokers the endpoint for a given service (on behalf of a Sender) and delivers the request to the Receiver. It can support both national and regional scale service service discovery tools. The BaRS Proxy supports scalable, dynamic interoperability and lowers the barrier of entry. This centralised infrastructure handles the burden of establishing endpoints and connectivity; a Sender need only communicate with the BaRS proxy and a Receiver only needs to accept requests from it.

Components of BaRS centralised infrastructure are as follows:

| Component | Description |
|-----------------------|--------------|
| BaRS Proxy API | Senders direct all requests to this Proxy API for all requests. |
| Endpoint catalogue | A component that holds service identifiers and their corresponding physical addresses. It is capable of supporting national and local directory of services or even standalone endpoints configured within a single system. Providers will be able to manag their endpoints via an API. |



|

<hr>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
- name: Index
filename: Index.page.md
- name: Principles and prerequisites
filename: Principles-and-prerequisites.page.md
- name: Principles for rendering BaRS payloads
filename: Principles-for-rendering-BaRS-payloads.page.md
- name: Principles for integration systems
filename: Principles-for-Integration-systems.page.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Implementation Guide | 1.10.0 | v1 | Live | Current Release | 12/11
{{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}}
{{pagelink:application8, text:BaRS-APP8}} | 1.0.0-alpha | alpha | | Current Release | 26/03/2026 | Pre-Release |{{pagelink:trn-app8,text:BaRS APP8 Change Log}}



Expand Down Expand Up @@ -188,6 +189,12 @@ Table detailing active versions of the latest Applications in Production (or cur
<td rowspan=1 style="text-align: center; vertical-align: middle;"><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/BaRS-Core?version=1.0.0" target="_blank">v1.0.0</a></td>
<td rowspan=1 style="text-align: center; vertical-align: middle;"><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" target="_blank">1.0.0</a></td>
</tr>
<tr>
<td>Application 8 v1.0.0-alpha</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.11.0" target="_blank">v1.11.0</a></td>
<td rowspan=1 style="text-align: center; vertical-align: middle;"><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.11.0" target="_blank">v1.11.0</a></td>
<td rowspan=1 style="text-align: center; vertical-align: middle;"><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0" target="_blank">1.3.0</a></td>
</tr>
<tr>
<td></td>
<td></td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,12 @@ Table detailing active versions of the latest Applications in Production (or cur
<td rowspan=1 style="text-align: center; vertical-align: middle;"><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Design/BaRS-Core?version=1.0.0" target="_blank">v1.0.0</a></td>
<td rowspan=1 style="text-align: center; vertical-align: middle;"><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" target="_blank">1.0.0</a></td>
</tr>
<tr>
<td>Application 8 v1.0.0-alpha</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.11.0" target="_blank">v1.11.0</a></td>
<td rowspan=1 style="text-align: center; vertical-align: middle;"><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.11.0" target="_blank">v1.11.0</a></td>
<td rowspan=1 style="text-align: center; vertical-align: middle;"><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0" target="_blank">1.3.0</a></td>
</tr>
<tr>
<td></td>
<td></td>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<div class="bars-blg-expander">

<div class="bars-blg-expander-entry" id="v1.10.0">
### 1.10.0

## Implementation Guide Changes
Expand All @@ -10,7 +13,11 @@
| Assure |Provided clarity on the expectations and limitation of the assurance process.|
| Testing and environments |Onboarding renamed to Connecting to environments. Specific sections created for Connecting as a sender and Connecting as a receiver to make navigation easier and give step by step guidance.

<p>
</div>
</div>

<br>
<hr>

### Previous Releases

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### 1.11.0

## Implementation Guide Changes

| Change | Description |
|---------------------------------------|---------------------------------------------------------------------------------------------------------|
| Bug fixes and corrections |There have been several bug fixes and corrections in the guide, these includes typos, broken links or corrections.|

<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
- name: Index
filename: Index.page.md
- name: 1.11.0
filename: 1.11.0.page.md
- name: 1.10.0
filename: 1.10.0.page.md
- name: 1.9.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- name: Index
filename: Index.page.md
- name: 1.0.21
filename: Index.page.md
filename: 1.0.21.page.md
- name: 1.0.19
filename: 1.0.19.page.md
- name: 1.0.12
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<div class="bars-blg-expander">
<div class="bars-blg-expander-entry" id="v1.0.0-beta.6">

## {{page-title}}
This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.0.0-beta.6

Expand All @@ -11,20 +14,16 @@ This is a minor "patch" with clarifications to limited areas of the Implementati
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|
|
| FHIR BaRS CodeSystem values added for Location Types | Values for Helimed From and Helimed To added | <mark style="background-color: LightGreen">non-breaking</mark> |
| FHIR BaRS CodeSystem value added for Flag Categories | Value for Call Warning added | <mark style="background-color: LightGreen">non-breaking</mark> |
| Updated FHIR Questionnaire and QuestionnaireResponse guidance | Guidance updated to reflect Nature of Call published Questionnaire being removed for beta | <mark style="background-color: LightGreen">non-breaking</mark> |

### Payload Change Log


| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| QuestionnaireResponse.extension.valueCodeableConcept.text | This SHOULD be populated with the name of the questionnaire responses contained within. | This SHOULD be populated with the name of the questionnaire responses contained within. For the Nature-of-call response this MUST be set to 'Nature of Call (NOC)' | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | <mark style="background-color: LightGreen">non-breaking</mark> |
| QuestionnaireResponse.questionnaire | Example updated - https://fhir.nhs.uk/Questionnaire/NOC | Example updated - https://fhir.nhs.uk/Questionnaire/PTS | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | <mark style="background-color: LightGreen">non-breaking</mark> |
| QuestionnaireResponse.questionnaire | Necessity Updated - MUST | Necessity Updated - MAY | Update | Referral Request |Changes to use of QuestionnaireResponse for Nature-of-call | <mark style="background-color: LightGreen">non-breaking</mark> |

</div>
</div>

<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## {{page-title}}
This is a minor "patch" with clarifications to limited areas of the Implementation Guidance and examples for v1.0.0-beta.7

### Application Change Log


<br>


| Change | Description | Impact |
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|
|
| Implementation guidance updated | patient.id implementation guidance corrected | <mark style="background-color: Yellow">correction</mark> |


### Payload Change Log


| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| patient.id | This SHOULD be populated with the name of the questionnaire responses contained within. | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | Update | Referral Request |Bug fix | <mark style="background-color: Yellow">correction</mark> |
| patient.id | This SHOULD be populated with the name of the questionnaire responses contained within. | This MUST only be populated with an id generated by the Receiver in the synchronous HTTP response. | Update | Referral Response |Bug fix | <mark style="background-color: Yellow">correction</mark> |



<br>
<hr>

### Previous Releases
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
- name: Index
filename: Index.page.md
- name: 1.0.0-beta.7
filename: 1.0.0-beta.7.page.md
- name: 1.0.0-beta.6
filename: 1.0.0-beta.6.page.md
- name: 1.0.0-beta.5
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

<div class="bars-blg-expander">
<div class="bars-blg-expander-entry" id="v1.0.0-alpha">

## {{page-title}}


This is a pre-release of v1.0.0-alpha - Referrals into a broker for Healthcare Service selection

<br>


### Application Change Log


| Change | Description | Impact |
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|
| Application 8 released | Referrals into a broker for Healthcare Service selection| |

### Payload Change Log


| FHIR Element | Previous | Current | Other | Referral/Booking | Rationale | Impact |
|------------------------------------------------------|----------|------------|---------|------------------|-------------------------------------------------------------------------------------------------|----------|
| | | | | | | |

</div>
</div>

<hr>
<br>
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
topic: trn-app8
---
<a href="#" onclick="history.back()">back</a>

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

<br>
This page will list all updates to BaRS Application 8
<br>
<br>
<div class="imgHandshake">{{render:handshake}}</div> &nbsp; - Indicates a change inspired by provider or supplier feedback.
<p>


|Key | Description |
|---------------------------------------------------------------|----------------------------------------|
|<mark style="background-color: LightGreen">non-breaking</mark> |Non-breaking changed introduced to the standard since the last release |
|<mark style="background-color: #ff8080">breaking</mark> |Breaking changed introduced to the standard since the last release |
|<mark style="background-color: Yellow">correction</mark> |Correction to the standard since the last release |
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- name: Index
filename: Index.page.md
- name: 1.0.0-alpha
filename: 1.0.0-alpha.page.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@
filename: TRN-APP6
- name: TRN-APP7
filename: TRN-APP7
- name: TRN-APP8
filename: TRN-APP8
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@
filename: About-BaRS
- name: BaRS Principles and Prerequisites
filename: BaRS-Principles-and-Prerequisites
- name: Content Negotiation
filename: Content-Negotiation
- name: Infrastructure
filename: Infrastructure
- name: Releases
filename: Releases
- name: Roles and responsibilities
filename: RolesAndResponsibilities.md
- name: Versioning
filename: Versioning.guide.md
- name: Content Negotiation
filename: Content-Negotiation

Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ When a BARS Receiver processes information in a Flag resource;

* they **should** populate a flag in their system, if their solution supports that flag
* they **must** display the information in the Flag resource in a way that supports the associated workflow (i.e. the relevant end users can see it and act upon it)
* rendering of Flag information must be in line with the {{pagelink:Home/About-BaRS/BaRS-Principles-and-Prerequisites/Principles-for-rendering-BaRS-payloads.page.md, text:Principles for rendering BaRS Payload }}.
* 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 }}.

### Observation
The Observation resource is used to carry assertions supporting the assessment performed by the Sender. In the BaRS UEC Applications, Senders **should** add clinical notes to the Careplan resource rather than Observation, especially where they expect a Receiver to act upon the information.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ When a BARS Receiver processes information in a Flag resource;

* they **should** populate a flag in their system, if their solution supports that flag
* they **must** display the information in the Flag resource in a way that supports the associated workflow (i.e. the relevant end users can see it an act upon it)
* rendering of Flag information must be in line with the {{pagelink:Home/About-BaRS/BaRS-Principles-and-Prerequisites/Principles-for-rendering-BaRS-payloads.page.md, text:Principles for rendering BaRS Payload }}.
* 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 }}.

### Observation
The Observation resource is used to carry assertions supporting the assessment performed by the Sender. In the BaRS UEC Applications, Senders **should** add clinical notes to the Careplan resource rather than Observation, especially where they expect a Receiver to act upon the information.
Expand Down
Loading
Loading