diff --git a/Examples/REFREQ03 - Referral Service Request New Full - GP to CPCS - Minor Illness.xml b/Examples/REFREQ03 - Referral Service Request New Full - Primary Care to Community Pharmacy - Minor Illness.xml similarity index 100% rename from Examples/REFREQ03 - Referral Service Request New Full - GP to CPCS - Minor Illness.xml rename to Examples/REFREQ03 - Referral Service Request New Full - Primary Care to Community Pharmacy - Minor Illness.xml diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Content-Negotiation/Mechanism.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Content-Negotiation/Mechanism.page.md index 0ea2275a..d1aae8c3 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Content-Negotiation/Mechanism.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Content-Negotiation/Mechanism.page.md @@ -63,7 +63,7 @@ A Receiver's MessageDefinitions will contain several identifiers that will allow * Name or URL in MessageDefinition.url / MessageDefinition.name :
https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request * Use case in MessageDefinition.useContext.code[]:
https://fhir.nhs.uk/CodeSystem/usecases-categories-bars -* Service in MessageDefinition.useContext.code[]:
https://fhir.nhs.uk/CodeSystem/dos-id +* Service in MessageDefinition.useContext.code[]:
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. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Content-Negotiation/Sender-MessageDefiniton.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Content-Negotiation/Sender-MessageDefiniton.page.md index 1dd1c60e..b65348ad 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Content-Negotiation/Sender-MessageDefiniton.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Content-Negotiation/Sender-MessageDefiniton.page.md @@ -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;} } diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Current-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Current-Releases.page.md index fd71dcda..8b3cfb1c 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Current-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Current-Releases.page.md @@ -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  BaRS FHIR API onboarding support information page .
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/API-Spec-Change-Log/Global.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/API-Spec-Change-Log/Global.page.md index aaa83c77..e43b9a05 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/API-Spec-Change-Log/Global.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/API-Spec-Change-Log/Global.page.md @@ -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 | correction | -| Improvments to header documentation | 1.8.2 |Added better explinations around most of the headers needed | Addition | +| Improvments to header documentation | 1.8.2 |Added better explanations for most of the headers needed | Addition | | 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}} | Addition | |
{{render:handshake}}
- 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. | correction | |
{{render:handshake}}
| 1.8.0 | The example deviceName element in NHSD-Requesting-Software now shows correctly as an Object as defined by the schema | correction | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.8.2.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.8.2.page.md index e4e31426..b8d60191 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.8.2.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/Implementation-Guide-Change-Log/1.8.2.page.md @@ -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. |
diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TKW-Change-Log/1.0.12.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TKW-Change-Log/1.0.12.page.md index f114d51e..26203730 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TKW-Change-Log/1.0.12.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TKW-Change-Log/1.0.12.page.md @@ -1,5 +1,5 @@
-
+
## {{page-title}} diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP5/1.1.2.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP5/1.1.2.page.md index 9df06a4f..d33649e7 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP5/1.1.2.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Technical-Release-Notes/TRN-APP5/1.1.2.page.md @@ -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 | correction | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/How-does-it-work.page.md index 71059da9..225459f8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/How-does-it-work.page.md @@ -129,7 +129,7 @@ The search parameters to be used are as follows: Community Pharmacy Consultation Service and Common Conditions Service - Use Service Type ID 131- Pharmacy Urgent Meds Supply
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.
+ Use Service Type ID 131- Pharmacy Urgent Meds Supply
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.
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) AND not open in the next 24 hours should not be displayed to the user.
Discretion is permitted if the nearest pharmacy is open now but due to close soon.

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

Ensure the display clearly shows:
  • 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.
  • 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.
    • diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Payloads.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Payloads.page.md index b57fa41b..f56c9135 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Payloads.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Payloads.page.md @@ -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.* diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Referral-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Referral-Payload.page.md index 0594c6b5..8e1badc5 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Referral-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Referral-Payload.page.md @@ -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 | | 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 15195b55..d8cb6f71 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 @@ -148,12 +148,6 @@ Table detailing active versions of the latest Applications in Production (or cur v1.0.0 1.0.0 - - Application 7 v1.0.0-alpha - v1.8.0 - v1.0.0 - 1.0.0 - diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Build/Payload-Library/Payload-Library/ServiceRequest---Request/Payload-Message-Definition.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Build/Payload-Library/Payload-Library/ServiceRequest---Request/Payload-Message-Definition.page.md index 02712f44..c3dc8e30 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Build/Payload-Library/Payload-Library/ServiceRequest---Request/Payload-Message-Definition.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Build/Payload-Library/Payload-Library/ServiceRequest---Request/Payload-Message-Definition.page.md @@ -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 | | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/TKW.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/TKW.page.md index 212e6e3d..03685d22 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/TKW.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/TKW.page.md @@ -146,7 +146,7 @@ The follow is a list of headers needed for the requests, these follow the patter |Get Referral|1, 2, 3, 5 & 6|/ServiceRequest/79120f41-a431-4f08-bcc5-1e67006fcae0||The returned Service Request Id = 79120f41-a431-4f08-bcc5-1e67006fcae0| |Cancel Referral|1, 2, 3, 5 & 6|use body from [SERVREQ01](https://simplifier.net/nhsbookingandreferrals/09b53c07-2a21-4ba5-ac8b-f33e486d794d) ||The returned Service Request Id = 09b53c07-2a21-4ba5-ac8b-f33e486d794d (assumed revoke is for this Service Request)| |New referral for a patient with no NHS No.|1, 2, 3, 5 & 6|use body from [REFREQ01 New Full 111 to ED](https://simplifier.net/nhsbookingandreferrals/79120f41-a431-4f08-bcc5-1e67006fcae0) remove whole `Extension-UKCore-NHSNumberVerificationStatus` section||The returned Service Request Id = 79120f41-a431-4f08-bcc5-1e67006fcae0| -|New referral for Application 5|5|use body from [REFREQ03 - Referral Service Request New Full - GP to CPCS - Minor Illness](https://simplifier.net/nhsbookingandreferrals/9ae77bb4-db12-42f3-a90c-733fe232f26c). NHSD Target Identifier (HTTP Header)|2000070513|Validates referral for Application 5 and returns Service Request Id = 79120f41-a431-4f08-bcc5-1e67006fcae0| +|New referral for Application 5|5|use body from [REFREQ03 - Referral Service Request New Full - Primary Care to Community Pharmacy - Minor Illness](https://simplifier.net/nhsbookingandreferrals/9ae77bb4-db12-42f3-a90c-733fe232f26c). NHSD Target Identifier (HTTP Header)|2000070513|Validates referral for Application 5 and returns Service Request Id = 79120f41-a431-4f08-bcc5-1e67006fcae0| |New referral failed request - HTTP 400|1, 2, 3, 5 & 6|use body from [REFREQ01 New Full 111 to ED](https://simplifier.net/nhsbookingandreferrals/79120f41-a431-4f08-bcc5-1e67006fcae0) replace `` with 9658499066|9658499066|Request must be for a patient with NHS No - 9658499066 and returns 400| |New referral failed request - HTTP 500|1, 2, 3, 5 & 6|use body from [REFREQ01 New Full 111 to ED](https://simplifier.net/nhsbookingandreferrals/79120f41-a431-4f08-bcc5-1e67006fcae0) replace `` with 9658499074|9658499074|Request must be for a patient with NHS No - 9658499074 and returns 500| |New referral for Out-of-Area CAD referral|6|NHSD Target Identifier (HTTP Header)|2000159910|Request will be validated against the Application6 Out-of-Area CAD-CAD use-case| diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Appointment-StandardPattern/Introduction.page.md index f26f24a5..3a9a5ac7 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Appointment-StandardPattern/Introduction.page.md @@ -10,10 +10,16 @@ topic: core-StandardPattern-appointment-Introduction-1.1.6 ## Introduction -The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0). +The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows, referred to as Appointment Management Foundation. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_1_0). This includes using {{pagelink:core-StandardPattern-document-reference-1.1.6, text: DocumentReference Standard Pattern}} to write pointers for Appointments to a central respository, commonly referred to as the Registry. +The Appointment Management Foundation is based on {{pagelink:design-core-1.1.6, text:BaRS Core}} and an understanding of the central tenets is essential before beginning. This includes: - +* {{pagelink:core-EndToEndWorkflow-1.1.6, text:End to end workflow }} - how Senders and Receivers, interacting through the central Proxy, negotiate compatibility and engage +* {{pagelink:core-EndToEndWorkflow-ServiceDiscovery-1.1.6, text:Service Discovery }} - every workflow must include the resolution of a receiving Service Identifier +* {{pagelink:core-Security-1.1.6, text:Authentication and Authorisation }} - the central Proxy will handle Authentication but Authorisation is handled by Receivers +* {{pagelink:onboarding, text:Onboarding to environments }} - getting access to the central Proxy. This differs for Senders (OAuth) and Receivers (mTLS) + There are four functions that are required surrounding appointments. This section will provide information on how to meet them using the Appointment Resource. * The ability to book an appointment. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Appointment-StandardPattern/Introduction.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Appointment-StandardPattern/Introduction.page.md index 806c54de..60691a6b 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Appointment-StandardPattern/Introduction.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Appointment-StandardPattern/Introduction.page.md @@ -10,9 +10,15 @@ topic: core-StandardPattern-appointment-Introduction-1.2.2 ## Introduction -The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_2_0). +The [BaRS API](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir) suite can be used where there is no specific use-case supported by the {{pagelink:Home/Applications/BaRS-Applications, text:Applications}} to fulfil generic Appointment workflows, referred to as Appointment Management Foundation. This section outlines the functionality supported, workflows involved and how these correspond with the [API Specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1_2_0). -This includes using {{pagelink:core-StandardPattern-document-reference-1.1.6, text: DocumentReference Standard Pattern}} to write pointers for Appointments to a central respository, commonly referred to as the Registry. +This includes using {{pagelink:core-StandardPattern-document-reference-1.2.2, text: DocumentReference Standard Pattern}} to write pointers for Appointments to a central respository, commonly referred to as the Registry. + +The Appointment Management Foundation is based on {{pagelink:design-core-1.2.2, text:BaRS Core}} and an understanding of the central tenets is essential before beginning. This includes: - +* {{pagelink:core-EndToEndWorkflow-1.2.2, text:End to end workflow }} - how Senders and Receivers, interacting through the central Proxy, negotiate compatibility and engage +* {{pagelink:core-EndToEndWorkflow-ServiceDiscovery-1.2.2, text:Service Discovery }} - every workflow must include the resolution of a receiving Service Identifier +* {{pagelink:core-Security-1.2.2, text:Authentication and Authorisation }} - the central Proxy will handle Authentication but Authorisation is handled by Receivers +* {{pagelink:onboarding, text:Onboarding to environments }} - getting access to the central Proxy. This differs for Senders (OAuth) and Receivers (mTLS) There are four functions that are required surrounding appointments. This section will provide information on how to meet them using the Appointment Resource. diff --git a/guides/Live-ImplementationGuide-BaRS/Home/TEMP-HOLDING-AREA/All-Payloads/Referral-Request-Payload.page.md b/guides/Live-ImplementationGuide-BaRS/Home/TEMP-HOLDING-AREA/All-Payloads/Referral-Request-Payload.page.md index 188dd3d1..44cd2c11 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/TEMP-HOLDING-AREA/All-Payloads/Referral-Request-Payload.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/TEMP-HOLDING-AREA/All-Payloads/Referral-Request-Payload.page.md @@ -41,7 +41,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 | | diff --git a/guides/Live-ImplementationGuide-BaRS/guide.yaml b/guides/Live-ImplementationGuide-BaRS/guide.yaml index 549aaa60..eff97ae8 100644 --- a/guides/Live-ImplementationGuide-BaRS/guide.yaml +++ b/guides/Live-ImplementationGuide-BaRS/guide.yaml @@ -1,5 +1,5 @@ title: NHS Booking and Referral Standard description: FHIR Implementation Guide for the NHS Booking and Referral Standard -version: 1.8.1 +version: 1.8.2 style-root: project style-name: NHSD diff --git a/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html b/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html index f7651715..9bbbbbf3 100644 --- a/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html +++ b/guides/Live-ImplementationGuide-BaRS/styles/NHSD/master.html @@ -147,7 +147,7 @@ data-uipath="document.title"> {{guide-title}} -
    Guide v{{ guide-version }} | Core v1.1.5 | Package v1.34.0
    +
    Guide v{{ guide-version }} | Core v1.1.6 | Package v1.35.0
    diff --git a/guides/Training-guide-BARS/Home/About-BaRS/Content-Negotiation/Mechanism.page.md b/guides/Training-guide-BARS/Home/About-BaRS/Content-Negotiation/Mechanism.page.md index 92d4e643..edaba2ca 100644 --- a/guides/Training-guide-BARS/Home/About-BaRS/Content-Negotiation/Mechanism.page.md +++ b/guides/Training-guide-BARS/Home/About-BaRS/Content-Negotiation/Mechanism.page.md @@ -63,7 +63,7 @@ A Receiver's MessageDefinitions will contain several identifiers that will allow * Name or URL in MessageDefinition.url / MessageDefinition.name : https://fhir.nhs.uk/MessageDefinition/bars-message-servicerequest-request * Use case in MessageDefinition.useContext.code[]: https://fhir.nhs.uk/CodeSystem/usecases-categories-bars. -* Service in MessageDefinition.useContext.code[]: https://fhir.nhs.uk/CodeSystem/dos-id +* Service in MessageDefinition.useContext.code[]: 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. diff --git a/guides/Training-guide-BARS/Home/About-BaRS/Content-Negotiation/Sender-MessageDefiniton.page.md b/guides/Training-guide-BARS/Home/About-BaRS/Content-Negotiation/Sender-MessageDefiniton.page.md index 1dd1c60e..b65348ad 100644 --- a/guides/Training-guide-BARS/Home/About-BaRS/Content-Negotiation/Sender-MessageDefiniton.page.md +++ b/guides/Training-guide-BARS/Home/About-BaRS/Content-Negotiation/Sender-MessageDefiniton.page.md @@ -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;} } diff --git a/guides/Training-guide-BARS/Home/Build/Payload-Library/Payload-Library/ServiceRequest---Request/Payload-Message-Definition.page.md b/guides/Training-guide-BARS/Home/Build/Payload-Library/Payload-Library/ServiceRequest---Request/Payload-Message-Definition.page.md index 02712f44..c3dc8e30 100644 --- a/guides/Training-guide-BARS/Home/Build/Payload-Library/Payload-Library/ServiceRequest---Request/Payload-Message-Definition.page.md +++ b/guides/Training-guide-BARS/Home/Build/Payload-Library/Payload-Library/ServiceRequest---Request/Payload-Message-Definition.page.md @@ -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 | | diff --git a/guides/Training-guide-BARS/Home/TEMP-HOLDING-AREA/All-Payloads/Referral-Request-Payload.page.md b/guides/Training-guide-BARS/Home/TEMP-HOLDING-AREA/All-Payloads/Referral-Request-Payload.page.md index 188dd3d1..44cd2c11 100644 --- a/guides/Training-guide-BARS/Home/TEMP-HOLDING-AREA/All-Payloads/Referral-Request-Payload.page.md +++ b/guides/Training-guide-BARS/Home/TEMP-HOLDING-AREA/All-Payloads/Referral-Request-Payload.page.md @@ -41,7 +41,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 | |