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 @@ -63,7 +63,7 @@ A Receiver's MessageDefinitions will contain several identifiers that will allow

* Name or URL in MessageDefinition.url / MessageDefinition.name : <div style="display: inline">https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request
* Use case in MessageDefinition.useContext.code[]: <div style="display: inline">https://fhir.nhs.uk/CodeSystem/usecases-categories-bars
* Service in MessageDefinition.useContext.code[]: <div style="display: inline">https://fhir.nhs.uk/CodeSystem/dos-id
* Service in MessageDefinition.useContext.code[]: <div style="display: inline">https://fhir.nhs.uk/Id/dos-service-id
* Version in MessageDefinition.version

The Name or URL define the type of message being sent. The Service id is confirmation of the correct Service. The Use Case Category code(s) define the care setting context required to ensure the message is actionable by the service. The Version allows for Version negotiation. All of these items need to be checked. There may be variations of the same message definition for a given service based on these variables.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ MessageDefinition Content_Negotiation_Client_MessageDefinition()
{compatible = true;}
else{compatible = false; break;}

if(Identifier.system == "https://fhir.nhs.uk/CodeSystem/dos-id" && Identifier.code == Service)
if(Identifier.system == "https://fhir.nhs.uk/Id/dos-service-id" && Identifier.code == Service)
{compatible = true;}
else{compatible = false; break;}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,27 @@

Product Link | Version | Handle | Phase | State | Release Date | Stability | Change Log Link
-----------------------|---------|---------|----------|-----------------|--------------|------------|-----------------
Implementation Guide | 1.8.2 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-General}}
[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.35.0) | 1.35.0| v1 | Live | Current Release | 29/08/2024 | Stable |
{{pagelink:design-core-1.1.6, text:BaRS Core}} | 1.1.6 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}}
[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2023 | Stable |{{pagelink:trn-api}}
{{pagelink: build-testing, text: TKW}} | 1.0.18 | v1 | Live | Current Release | 27/11/2024 | Stable |{{pagelink:trn-tkw}}
{{pagelink:application1, text:BaRS-APP1}} | 1.0.7 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}}
{{pagelink:application2, text:BaRS-APP2}} | 1.0.7 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}}
{{pagelink:application3, text:BaRS-APP3}} | 1.0.3 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-app3,text:BaRS APP3 Change Log}}
{{pagelink:application4, text:BaRS-APP4}} | 1.2.2 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app4,text:BaRS APP4 Change Log}}
{{pagelink:application5, text:BaRS-APP5}} | 1.1.2 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app5,text:BaRS APP5 Change Log}}
{{pagelink:application6, text:BaRS-APP6}} | 1.0.0-beta.4 | beta | Live | Current Release | 26/11/2024 | Pre-Release |{{pagelink:trn-app6,text:BaRS APP6 Change Log}}
{{pagelink:application7, text:BaRS-APP7}} | 1.0.0-alpha.3 | alpha | | Current Release | 26/11/2024 | Pre-Release |{{pagelink:trn-app7,text:BaRS APP7 Change Log}}
Implementation Guide | 1.8.2 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-General}}
[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.35.0) | 1.35.0| v1 | Live | Current Release | 01/04/2025 | Stable |
{{pagelink:design-core-1.1.6, text:BaRS Core}} | 1.1.6 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-core, text: BaRS Core Change Log}}
[API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0) | 1.1.0 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-api}}
{{pagelink: build-testing, text: TKW}} | 1.0.18 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-tkw}}
{{pagelink:application1, text:BaRS-APP1}} | 1.0.7 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}}
{{pagelink:application2, text:BaRS-APP2}} | 1.0.7 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}}
{{pagelink:application3, text:BaRS-APP3}} | 1.0.3 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-app3,text:BaRS APP3 Change Log}}
{{pagelink:application4, text:BaRS-APP4}} | 1.2.2 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-app4,text:BaRS APP4 Change Log}}
{{pagelink:application5, text:BaRS-APP5}} | 1.1.2 | v1 | Live | Current Release | 01/04/2025 | Stable |{{pagelink:trn-app5,text:BaRS APP5 Change Log}}
{{pagelink:application6, text:BaRS-APP6}} | 1.0.0-beta.4 | beta | Live | Current Release | 01/04/2025 | Pre-Release |{{pagelink:trn-app6,text:BaRS APP6 Change Log}}
{{pagelink:application7, text:BaRS-APP7}} | 1.0.0-alpha.3 | alpha | | Current Release | 01/04/2025 | Pre-Release |{{pagelink:trn-app7,text:BaRS APP7 Change Log}}



### Overview of the release

Bug fixes and corrections.
Release 1.8.2 includes development of the {{pagelink:core-StandardPattern-appointment-1.1.6, text:Appointment Management Foundation}} guidance and supporting changes to the API specification.
There have been improvements to use-context HTTP header guidance and developer onboarding advice, alongside bug fixes and corrections throughout the guide. Application 5 TKW Receiver scenarios are now documented.

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 <a href= "https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/onboarding-support-information#hazard-log-and-clinical-safety-case-report-cscr-" target="_blank"> BaRS FHIR API onboarding support information page </a>.

<br>
<hr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ topic: TRN-API-global
| Change | BaRS Version | Description | Impact |
|------------------------------------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| Removal of use-context HTTP header | 1.8.2 |Restricted the use of the use-context header to non-write operations | <mark style="background-color: Yellow">correction</mark> |
| Improvments to header documentation | 1.8.2 |Added better explinations around most of the headers needed | <mark style="background-color: Green">Addition</mark> |
| Improvments to header documentation | 1.8.2 |Added better explanations for most of the headers needed | <mark style="background-color: Green">Addition</mark> |
| Addition of the use-context HTTP header | 1.8.1 | A new header to assist in {{pagelink:core-EndToEndWorkflow-Logging-1.0.5, text: audting and logging}} | <mark style="background-color: Green">Addition</mark> |
| <div class="imgHandshake">{{render:handshake}}</div> - The DoS ID examples updated to https| 1.8.0 | The https://fhir.nhs.uk/Id/dos-service-id examples now correcly show as https. | <mark style="background-color: Yellow">correction</mark> |
| <div class="imgHandshake">{{render:handshake}}</div> | 1.8.0 | The example deviceName element in NHSD-Requesting-Software now shows correctly as an Object as defined by the schema | <mark style="background-color: Yellow">correction</mark> |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
| Build>Test>TKW Scenarios updated |Updated TKW Scenarios to reflect Applications rather than use-cases.|
| Build>Test>TKW Scenarios updated |Added new test scenarios for Application 5 - TKW Receiver.|
| Home Page - Link to Standard Appointment Management |Added new link to Standard Appointment Management, on the Home page, to provide easier access to non use-case specific workflow functionality supported by BaRS.|
| Remove references to CPCS | Remove references to CPCS and replaced with Primary Care to Community Pharmacy (Pharmacy First). The terminology changed from the Pharmacy First progamme. |
| Updated DoS System references throughout | All reference to DoS System 'https://fhir.nhs.uk/CodeSystem/dos-id' in MessageDefinitions has been replaced with 'https://fhir.nhs.uk/Id/dos-service-id'. FHIR artefacts have also been updated. |

<br>
<hr>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div class="bars-blg-expander">
<div class="bars-blg-expander-entry" id="v1.0.11">
<div class="bars-blg-expander-entry" id="v1.0.12">

## {{page-title}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ This stable release (v1.1.2) of Application 5 sees minor corrections.

| Change | Description | Impact |
|-------------------------------------------|-------------------------------------------------|-------------------------------------------------------------------------|

| SNOMED Code Updated | The SNOMED Code used to define a minor illness referral has been updated from '1577041000000100-Community Pharmacist Consultation Service for minor illness (procedure)' to '2140231000000104-Referral to Community Pharmacy Pharmacy First Service (procedure)', as requested by Pharmacy First Programme Clinical Lead | <mark style="background-color: Yellow">correction</mark> |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ The search parameters to be used are as follows:
<tbody>
<tr>
<td>Community Pharmacy Consultation Service and Common Conditions Service</td>
<td><b>Use Service Type ID 131- Pharmacy Urgent Meds Supply</b><br>Note this is labelled 'Pharmacy Urgent Meds Supply', but it is deemed appropriate to return one profile per Pharmacy that will do Pharmacy Urgent Meds Supply, CPCS and CCS.</br></td>
<td><b>Use Service Type ID 131- Pharmacy Urgent Meds Supply</b><br>Note this is labelled 'Pharmacy Urgent Meds Supply', but it is deemed appropriate to return one profile per Pharmacy that will do Pharmacy Urgent Meds Supply, Primary Care to Community Pharmacy (Pharmacy First) and CCS.</br></td>
<td>These services are time critical and the patient must be seen within 24 hours, and so any pharmacies closed now (or closing in the next 30 mins) <b>AND</b> not open in the next 24 hours should not be displayed to the user.<br>Discretion is permitted if the nearest pharmacy is open now but due to close soon.</br><br>If no pharmacies in the local area are open in the next 24 hours then a message needs to be clearly displayed to the user so they can consider other alternatives. (Note this is a very unlikely scenario – but may happen in rural areas with only a few nearby Pharmacies or around bank holiday weekends).</br><br>Ensure the display clearly shows:</br><li>The opening times, to allow the user to provide opening times to the patient so that they can go to the pharmacy when it is open.</li><li>The phone number for the pharmacy; the user can give this to the patient so they can call and pre-arrange when to come in.</li>
</td>
</tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ There are two *coding* entries within *ServiceRequest.category* which are key to
1. Denotes the type of referral e.g. Transfer of care
2. Denotes the use case and must be populated with the relevant use case from [use-case CodeSystem](
https://simplifier.net/nhsbookingandreferrals/usecases-categories-bars
). e.g. GP to Pharmacy CPCS Minor Illness. Please refer to the guidance in {{pagelink:core-SPUseCaseCategories-1.1.6, text:use-case categories}}
). e.g. Primary Care to Community Pharmacy. Please refer to the guidance in {{pagelink:core-SPUseCaseCategories-1.1.6, text:use-case categories}}

*Please note that the use-case category 'referraltopharmacy' is now deprecated to allow for more granular use cases.*

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ This payload is used to transmit all the necessary information that is required
| ServiceRequest.category.coding | BaRS Use Case | MUST | 0..* | |
| ServiceRequest.category.coding.system | This MUST be populated with CodeSystem 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' - FIXED VALUE | MUST | 0..1 | https://fhir.nhs.uk/CodeSystem/usecases-categories-bars |
| ServiceRequest.category.coding.code | This MUST be populated with Code for the use-case. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' | MUST | 0..1 | A5T1 |
| ServiceRequest.category.coding.display | This MUST be populated with Display for the use-case. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' | MUST | 0..1 | GP to Pharmacy CPCS Minor Illness |
| ServiceRequest.category.coding.display | This MUST be populated with Display for the use-case. See CodeSystem: 'https://fhir.nhs.uk/CodeSystem/usecases-categories-bars' | MUST | 0..1 | Primary Care to Community Pharmacy |
| ServiceRequest.subject | Follow BaRS profile guidance for populating this element | MUST | 1..1 | |
| ServiceRequest.subject.reference | This MUST be populated. Follow BaRS profile guidance for populating this element | MUST | 0..1 | urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8 |
| ServiceRequest.encounter | | MUST | 0..1 | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,6 @@ 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 7 v1.0.0-alpha</td>
<td><a href="https://simplifier.net/guide/nhsbookingandreferralstandard/home?version=1.8.0" target="_blank">v1.8.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>
</tr>
<tr>
<td></td>
<td></td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This Message Definition is built with the following specific values:
| status | 1..1 | active | |
| date | 1..1 | Date last changed | |
| useContext | 1..1 | | We are expecting the UseContext to be a DOS ID |
| useContext.code.system | 1..1 | https://fhir.nhs.uk/CodeSystem/dos-id | |
| useContext.code.system | 1..1 | https://fhir.nhs.uk/Id/dos-service-id | |
| useContext.code.code | 1..1 | dos-id | |
| event.system | 1..1 | https://fhir.nhs.uk/CodeSystem/message-events-bars | |
| event.code | 1..1 | servicerequest-request | |
Expand Down
Loading
Loading