Skip to content

Merge to Main API links #505

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 5 commits into from
Jul 1, 2025
Merged

Merge to Main API links #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f2b0c81
API1.0.7-Update
cda69 Jul 1, 2025
ab69c6c
Merge pull request #503 from NHSDigital/CGD-Cancel-ReOrder
cda69 Jul 1, 2025
6e00e98
APILinksUpdate
cda69 Jul 1, 2025
23a028e
Merge pull request #504 from NHSDigital/API-Links
cda69 Jul 1, 2025
c323e8d
Merge branch 'main' into develop
cda69 Jul 1, 2025
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
2 changes: 1 addition & 1 deletion ...mentationGuide-BaRS/Home/About-BaRS/About-BaRS/Elements-of-the-Standard.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ BaRS documentation is as follows:
|----------------------------------|------------------------------------------------------------------------------------------------------------|
| [BaRS homepage]( https://digital.nhs.uk/services/booking-and-referral-standard) | An overview of the BaRS programme, the benefits of the standard and status of supplier development |
| Implementation guide (this site) | You will need to use both the BaRS Core page and the BaRS Applications page specific to your use case. |
| [API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0) | The specification for integrating with optional BaRS central infrastructure
| [API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) | The specification for integrating with optional BaRS central infrastructure



Expand Down
4 changes: 2 additions & 2 deletions ...e-ImplementationGuide-BaRS/Home/About-BaRS/About-BaRS/Quick-Start-Guide.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ We recommend reading the following documentation as part of the discovery stage
* {{pagelink:definitions_key_terms, text:Definition of key terms}}
* {{pagelink:design-core-1.0.7, text:BaRS Core}}
* {{pagelink:applications, text:BaRS Applications}}
* [BaRS FHIR API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0)
* [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.
Expand All @@ -25,7 +25,7 @@ BaRS includes several {{pagelink:applications, text:BaRS Application (use cases)


### API Spec
The BaRS [API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0) provides detail of the structure of endpoints. The specification allows you to 'Try this API', calling endpoints to view anticipated responses. This is a purely technical document and must be read in conjunction with implementation guidance to build a compliant solution.
The BaRS [API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0) provides detail of the structure of endpoints. The specification allows you to 'Try this API', calling endpoints to view anticipated responses. This is a purely technical document and must be read in conjunction with implementation guidance to build a compliant solution.

### Security
All {{pagelink:core-Security-1.0.7, text:security}} is provided through our platform. There are two methods for securing interactions via BaRS API:
Expand Down
2 changes: 1 addition & 1 deletion ...-ImplementationGuide-BaRS/Home/About-BaRS/Content-Negotiation/Mechanism.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The Use-Case-Category is a codeSystem that defines the use case for the message,

#### Service

The Service describes if the MessageDefinition is applicable for this service. This is something that should be implied by the query parameter for GET /MessageDefinition, which acts as a filter. This capability is already described on the <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0#get-/MessageDefinition" target="_blank">Get MessageDefinition</a> page.
The Service describes if the MessageDefinition is applicable for this service. This is something that should be implied by the query parameter for GET /MessageDefinition, which acts as a filter. This capability is already described on the <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#get-/MessageDefinition" target="_blank">Get MessageDefinition</a> page.

### Version
The same SemVer rules are applied to the MessageDefinition versions. It could be the case that multiple MessageDefinitions are returned and in this scenario a Sender should select the closest version to their own from a Minor Revision and Patch perspective. If a Major version difference is detected then the Sender cannot continue unless another option is available in the response.
Expand Down
9 changes: 9 additions & 0 deletions ...e/About-BaRS/Releases/Technical-Release-Notes/API-Spec-Change-Log/1.0.0.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@

### Change Log

### in BaRS 1.9.0

| Change | Description | Impact |
|----------------------------------------------|---------------------------------------------------------------------|--------|
| Fixed incorrect character display on GET /Slot description | Character display for a double quote was illegible. Version 1.0.7 | <mark style="background-color: Yellow">correction</mark> |

<br>
<hr>

### in BaRS 1.8.1

| Change | Description | Impact |
Expand Down
2 changes: 1 addition & 1 deletion .../Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ During a referral workflow where booking is required, there are two separate pro

The first part of this process involves the **sender** making a request to the **receiver** for slots that match the search criteria. This is a "searching" request that requires the response body to include a "searchset" bundle resource.

The search parameters are defined <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0#api-Slots-getSlots" target="_blank">on the BaRS API specification documentation</a>.
The search parameters are defined <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7#api-Slots-getSlots" target="_blank">on the BaRS API specification documentation</a>.



Expand Down
2 changes: 1 addition & 1 deletion ...e-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/Index.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ topic: Application1
<td>Application 1 v1.0.8</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.9.0</td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" target="_blank">v1.0.0</a></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>
</table>
Expand Down
2 changes: 1 addition & 1 deletion .../Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ During a referral workflow where booking is required, there are two separate pro

The first part of this process involves the **sender** making a request to the **receiver** for slots that match the search criteria. This is a "searching" request that requires the response body to include a "searchset" bundle resource.

The search parameters are defined <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0#api-Slots-getSlots" target="_blank">on the BaRS API specification documentation</a>.
The search parameters are defined <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7#api-Slots-getSlots" target="_blank">on the BaRS API specification documentation</a>.



Expand Down
2 changes: 1 addition & 1 deletion ...e-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/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: Application2
<td>Application 2 v1.0.8</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.9.0</td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" target="_blank">v1.0.0</a></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>
</table>
Expand Down
2 changes: 1 addition & 1 deletion ...e-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP3/Index.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ topic: Application3
<td>Application 3 v1.0.4</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.9.0</td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" target="_blank">v1.0.0</a></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>
</table>
Expand Down
2 changes: 1 addition & 1 deletion ...e-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP4/Index.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ topic: Application4
<td>Application 4 v1.2.3</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.9.0</td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" target="_blank">v1.0.0</a></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>
</table>
Expand Down
2 changes: 1 addition & 1 deletion .../Applications/BaRS-Applications/Applications/BaRS-APP7/How-does-it-work.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ During a referral workflow where booking is required, there are two separate pro

The first part of this process involves the **sender** making a request to the **receiver** for slots that match the search criteria. This is a "searching" request that requires the response body to include a "searchset" bundle resource.

The search parameters are defined <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0#api-Slots-getSlots" target="_blank">on the BaRS API specification documentation</a>.
The search parameters are defined <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0#api-Slots-getSlots" target="_blank">on the BaRS API specification documentation</a>.



Expand Down
6 changes: 3 additions & 3 deletions ...e-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP7/Index.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ topic: Application7
<tbody>
<tr>
<td>Application 7 v1.0.0-alpha.4</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.9.0</td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" target="_blank">v1.0.0</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core?version=1.9.0" target="_blank">v1.0.x</a></td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.9.0" target="_blank">v1.9.0</td>
<td><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0" target="_blank">v1.3.0</a></td>
</tr>
</tbody>
</table>
Expand Down
16 changes: 8 additions & 8 deletions ...tationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ These guides are designed to be used in conjunction with the documentation for {

| Application | Use Cases | Current Release | Minimum API Spec | Minimum Core Version |
| ----------------------------------------------------------------------------|--------------------------------------------------------------- | --------------- | --------------- | --------------- |
| {{pagelink:application1, text:Booking and Referrals into UEC (Application 1)}} | <p>111 - ED <br>111 - UTC <br>CAS - ED <br>CAS - UTC <br> 999 - ED <br> 999 - UTC <br> 111 - SDEC <br> CAS - SDEC <br> 999 - SDEC <br> </p> | 1.0.8 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" 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: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> | 1.0.8 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" 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> | 1.0.4 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" 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> | 1.2.3 | <a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_0_0" 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_1_0" target="_blank">v1.1.0</a> | {{pagelink:design-core-1.3.0, text:v1.1.0}} |
| {{pagelink:application1, text:Booking and Referrals into UEC (Application 1)}} | <p>111 - ED <br>111 - UTC <br>CAS - ED <br>CAS - UTC <br> 999 - ED <br> 999 - UTC <br> 111 - SDEC <br> CAS - SDEC <br> 999 - SDEC <br> </p> | 1.0.8 | <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: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> | 1.0.8 | <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> | 1.0.4 | <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> | 1.2.3 | <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.0, text:v1.3.0}} |


<hr>
Expand All @@ -46,7 +46,7 @@ Table detailing active versions of the latest Applications in Production (or cur
<td>Application 1 v1.0.1</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.1.0" target="_blank">v1.1.0</a></td>
<td rowspan=14 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=14 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>
<td rowspan=14 style="text-align: center; vertical-align: middle;"><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.0.7" target="_blank">1.0.0</a></td>
</tr>
<tr>
<td>Application 1 v1.0.3</td>
Expand Down Expand Up @@ -136,7 +136,7 @@ Table detailing active versions of the latest Applications in Production (or cur
<td>Application 5 v1.0.0-beta.4</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.4.0" target="_blank">v1.4.0</a></td>
<td rowspan=5 style="text-align: center; vertical-align: middle;"><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/Home/Core/End-to-end-workflow?version=1.4.0" target="_blank">v1.1.0</a></td>
<td rowspan=5 style="text-align: center; vertical-align: middle;"><a href="https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0" target="_blank">1.1.0</a></td>
<td rowspan=5 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>Application 5 v1.0.0</td>
Expand Down Expand Up @@ -166,7 +166,7 @@ Table detailing active versions of the latest Applications in Production (or cur
<td>Application 7 v1.0.0-alpha.4</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.2" target="_blank">v1.9.0</a></td>
<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>
<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.7" target="_blank">1.0.0</a></td>
</tr>
<tr>
<td></td>
Expand Down
Loading
Loading