diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md new file mode 100644 index 00000000..696524d8 --- /dev/null +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Index.page.md @@ -0,0 +1,5 @@ +--- +topic: Analysis +--- + +# {{page-title}} \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Index.page.md index a3def039..3047bb26 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Index.page.md @@ -2,4 +2,26 @@ topic: infrastructure --- -# {{page-title}} \ No newline at end of file +# {{page-title}} + +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. | + + + + | + +
\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Infrastructure.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Infrastructure.page.md deleted file mode 100644 index d97536eb..00000000 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/Infrastructure.page.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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. | - - - - | - -
\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/toc.yaml index 348ee56c..0815f2e4 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Infrastructure/toc.yaml @@ -1,8 +1,2 @@ - 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 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md index 2f5eeee6..b9b2200a 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Current-Releases.page.md @@ -1,9 +1,9 @@ -## Current Release 1.10.0 +## Current Release 1.11.0 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.37.0) | 1.37.0| v1 | Live | Current Release | 12/11/2025 | Stable | +Implementation Guide | 1.11.0 | v1 | Live | Current Release | 26/03/2026 | Stable |{{pagelink:trn-General}} +[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.38.0) | 1.38.0| v1 | Live | Current Release | 26/03/2026 | 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}} {{pagelink: build-testing, text: TKW}} | 1.0.21 | v1 | Live | Current Release | 12/11/2025 | Stable |{{pagelink:trn-tkw}} @@ -12,7 +12,7 @@ Implementation Guide | 1.10.0 | v1 | Live | Current Release | 12/11 {{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.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:application6, text:BaRS-APP6}} | 1.0.0-beta.7 | beta | | Current Release | 26/03/2026 | 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}} @@ -20,9 +20,7 @@ Implementation Guide | 1.10.0 | v1 | Live | Current Release | 12/11 ### Overview of the release -Release 1.10.0 includes a change to the accepted multiple NHS number verification statuses across BaRS, seeing a major version increment for Applications 1, 2, 3 & 4. The Appointment Management Foundation Standard has been revised and simplified, including extending the use Document Reference Standard Pattern to update the Registry (National Record Locator), alongside bug fixes and corrections throughout the guide. -There have been further minor changes to the current beta, Application 6, following discussion with the BaRS Community involved, and the scope and responsibilities during Assurance have been described. -Finally, following user feedback, the content in About BaRS, steps for technical deployment and instructions for connecting to our environments are restructured and simplified. +Release 1.11.0 of the BaRS Implementation Guide introduces BaRS Application 8 "Referrals to a broker for Healthcare Service selection" as an alpha release. BaRS Application 8 is designed to create interoperability for referrals between NHS England products. The next phase of content and navigation changes in the Implementation Guide are delivered. They are focussed on: the Home page, the Analysis section (formerly About BaRS) and relocation of content from this area. These changes are based on user feedback. Also included in this release are minor changes to BaRS Application 6 and bug fixes and corrections throughout the guide. A clinical safety assessment of the scope of this release has determined that it has not significantly changed the clinical safety profile of the BaRS. No new hazards have been identified in this release. The latest version of the BaRS clinical safety case and hazard log can be downloaded from the  BaRS FHIR API onboarding support information page . @@ -180,8 +178,8 @@ Table detailing active versions of the latest Applications in Production (or cur v1.10.0 - Application 6 v1.0.0-beta.6 - v1.10.0 + Application 6 v1.0.0-beta.7 + v1.11.0 Application 7 v1.0.0-alpha.4 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Previous-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Previous-Releases.page.md index 02854b10..9d708ab1 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Previous-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/Releases/Previous-Releases.page.md @@ -1,5 +1,38 @@ ## {{page-title}} +
+
+ +## Current Release 1.10.0 + +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.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}} +{{pagelink: build-testing, text: TKW}} | 1.0.21 | v1 | Live | Current Release | 12/11/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}} +{{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.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}} + + +### Overview of the release + +Release 1.10.0 includes a change to the accepted multiple NHS number verification statuses across BaRS, seeing a major version increment for Applications 1, 2, 3 & 4. The Appointment Management Foundation Standard has been revised and simplified, including extending the use Document Reference Standard Pattern to update the Registry (National Record Locator), alongside bug fixes and corrections throughout the guide. +There have been further minor changes to the current beta, Application 6, following discussion with the BaRS Community involved, and the scope and responsibilities during Assurance have been described. +Finally, following user feedback, the content in About BaRS, steps for technical deployment and instructions for connecting to our environments are restructured and simplified. + +A clinical safety assessment of the scope of this release has determined that it has not significantly changed the clinical safety profile of the BaRS. No new hazards have been identified in this release. The latest version of the BaRS clinical safety case and hazard log can be downloaded from the  BaRS FHIR API onboarding support information page . + +
+
+
+
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/toc.yaml index d223c3a1..bde58151 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Analysis/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/Analysis/toc.yaml @@ -1,15 +1,14 @@ -- name: About BaRS - filename: About-BaRS +- name: Analysis + filename: Analysis - 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: Releases + filename: Releases - name: Versioning filename: Versioning.guide.md - +- name: Content Negotiation + filename: Content-Negotiation diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md index f770bb01..5cb44f22 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md @@ -22,9 +22,9 @@ topic: Application6 - Application 6 v1.0.0-beta.6 + Application 6 v1.0.0-beta.7 v1.1.x - v1.10.0 + v1.11.0 v1.1.0 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md index 02525404..6a4d38dc 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/Index.page.md @@ -179,8 +179,8 @@ Table detailing active versions of the latest Applications in Production (or cur v1.10.0 - Application 6 v1.0.0-beta.6 - v1.10.0 + Application 6 v1.0.0-beta.7 + v1.11.0 Application 7 v1.0.0-alpha.4 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md index 0d2313e9..f52be8af 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Pre-releases/Index.page.md @@ -14,7 +14,7 @@ These guides are designed to be used in conjunction with the documentation for { | Application | Use Cases | Current Release | API Specification | Core Version | | ----------------------------------------------------------------------------|--------------------------------------------------------------- | --------------- | --------------- | --------------- | -| {{pagelink:application6, text: Referrals into an Ambulance Service Trust (Application 6)}} |

CAD to CAD Out of Area Referral
CAD to CAD Call Assist Request
CAD to CAD Mutual Aid Request | 1.0.0-beta.6 | API Spec v1.3.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.3.0 and above}} | +| {{pagelink:application6, text: Referrals into an Ambulance Service Trust (Application 6)}} |

CAD to CAD Out of Area Referral
CAD to CAD Call Assist Request
CAD to CAD Mutual Aid Request | 1.0.0-beta.7 | API Spec v1.3.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.3.0 and above}} | | {{pagelink:application7, text: Bookings into GP Practice (Application 7)}} |

Appointments for Patient facing services into GP Practice | 1.0.0-alpha.4 | API Spec v1.3.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.3.0 and above}} | | {{pagelink:application8, text: Referrals into a broker for Healthcare Service selection (Application 8)}} |

Advice and guidance referring into electronic Referral Service (eRS) | 1.0.0-alpha | API Spec v1.3.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.3.0 and above}} | @@ -176,8 +176,8 @@ Table detailing active versions of the latest Applications in Production (or cur v1.10.0 - Application 6 v1.0.0-beta.6 - v1.10.0 + Application 6 v1.0.0-beta.7 + v1.11.0 Application 7 v1.0.0-alpha.4 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Deploy/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Deploy/toc.yaml index f62a5c9e..07a1fb9e 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Deploy/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/Deploy/Deploy/toc.yaml @@ -4,5 +4,4 @@ filename: Deploy.page.md - name: Key Deployment Activities filename: KeyDeploymentActivities.page.md -- name: Roles & Responsibilities - filename: RolesAndResponsibilities.md + diff --git a/guides/Live-ImplementationGuide-BaRS/Home/FHIR-Assets/Index.page.md b/guides/Live-ImplementationGuide-BaRS/Home/FHIR-Assets/Index.page.md index 21c2e9e1..12186e0f 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/FHIR-Assets/Index.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/FHIR-Assets/Index.page.md @@ -1,8 +1,5 @@ ---- -topic: fhir_assets ---- -## {{page-title}} +## FHIR Assets
@@ -38,4 +35,6 @@ Message definitions are a key aspect of BaRS. They define the content of payload BaRS Applications define workflows and payloads. They can support any number of use-cases with the same requirements. Suppliers build and are assured for specific Applications. As BaRS grows Applications are expected to include more use-cases, supporting re-use of both the BaRS Application and supplier development. +For further information and resouces regarding the FHIR standard see the [FHIR website](http://hl7.org/fhir/overview-dev.html). +

\ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Index.guide.md b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Index.guide.md index 8cbd4c6f..93c8614b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Index.guide.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/Index.guide.md @@ -1,9 +1,18 @@ ---- -topic: help ---- -## Help and support +## Contact us -For any queries or feedback about any aspect of BaRS including support requests contact the BaRS team [here](https://digital.nhs.uk/services/booking-and-referral-standard/enquiry-form). +To ensure your enquiry is received and answered promptly please review the options below. + +### BaRS enquiries + +Use our booking and referral standard [enquiry form](https://digital.nhs.uk/services/booking-and-referral-standard/enquiry-form) to ask a question about the project, the standard, or simply to leave your feedback. + +### Test and assurance enquiries + +[Create an account](https://onboarding.prod.api.platform.nhs.uk) for the Digital Onboarding Service to start assurance. For queries relating to your account or the service email () + +For any queries relating to toolkit workbench (TKW) email () + +### Amending appointments +If you're a patient looking to book, change or cancel appointments please contact the service directly. -For further information and resouces regarding the FHIR standard see the [FHIR website](http://hl7.org/fhir/overview-dev.html). \ No newline at end of file diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml index 73f721a5..8a48ba14 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml +++ b/guides/Live-ImplementationGuide-BaRS/Home/Helpandsupport/toc.yaml @@ -1,5 +1,5 @@ - name: Index - filename: Index.guide.md + filename: Index.guide.md - name: How to use this implementation guide filename: Howtousethisimplementationguide.guide.md - name: Glossary @@ -7,4 +7,4 @@ - name: Downloads filename: Downloads.guide.md - name: Report an Incident - filename: ReportanIncident.guide.md + filename: ReportanIncident.guide.md \ No newline at end of file