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 33ff2053..5a406e9e 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 @@ -1,25 +1,25 @@ -## Current Release 1.8.1 +## Current Release 1.8.2 Product Link | Version | Handle | Phase | State | Release Date | Stability | Change Log Link -----------------------|---------|---------|----------|-----------------|--------------|------------|----------------- -Implementation Guide | 1.8.1 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-General}} -[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.33.0) | uk.nhsdigital.bars.r4 1.33.0| v1 | Live | Current Release | 29/08/2024 | Stable | -{{pagelink:design-core-1.1.5, text:BaRS Core}} | 1.1.5 | 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.12 | v1 | Live | Current Release | 27/11/2024 | Stable |{{pagelink:trn-tkw}} -{{pagelink:application1, text:BaRS-APP1}} | 1.0.6 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} -{{pagelink:application2, text:BaRS-APP2}} | 1.0.6 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} -{{pagelink:application3, text:BaRS-APP3}} | 1.0.2 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-app3,text:BaRS APP3 Change Log}} -{{pagelink:application4, text:BaRS-APP4}} | 1.2.1 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app4,text:BaRS APP4 Change Log}} -{{pagelink:application5, text:BaRS-APP5}} | 1.1.1 | 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.3 | 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.2 | 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 | 26/11/2024 | Stable |{{pagelink:trn-General}} +[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.35.0) | uk.nhsdigital.bars.r4 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.6 | 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}} ### Overview of the release -Addition of use case categories to all BaRS Applications. +Bug fixes and corrections.

@@ -56,6 +56,10 @@ Table detailing active versions of the latest Applications in Production (or cur Application 1 v1.0.6 v1.8.1 + + Application 1 v1.0.7 + v1.8.2 + Application 2 v1.0.1 v1.1.0 @@ -72,6 +76,10 @@ Table detailing active versions of the latest Applications in Production (or cur Application 2 v1.0.6 v1.8.1 + + Application 2 v1.0.7 + v1.8.2 + Application 3 v1.0.0 v1.4.0 @@ -84,6 +92,10 @@ Table detailing active versions of the latest Applications in Production (or cur Application 3 v1.0.2 v1.8.1 + + Application 3 v1.0.3 + v1.8.2 + Application 4 v1.0.0 v1.4.0 @@ -96,6 +108,10 @@ Table detailing active versions of the latest Applications in Production (or cur Application 4 v1.2.1 v1.8.1 + + Application 4 v1.2.2 + v1.8.2 + Application 5 v1.0.0-beta.4 v1.4.0 @@ -115,12 +131,16 @@ Table detailing active versions of the latest Applications in Production (or cur v1.8.1 - Application 6 v1.0.0-beta.3 - v1.8.1 + Application 5 v1.1.2 + v1.8.2 - Application 7 v1.0.0-alpha.2 - v1.8.1 + Application 6 v1.0.0-beta.4 + v1.8.2 + + + Application 7 v1.0.0-alpha.3 + v1.8.2 v1.0.0 1.0.0 diff --git a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Previous-Releases.page.md b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Previous-Releases.page.md index 0a42c8f4..93288ce8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Previous-Releases.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/About-BaRS/Releases/Previous-Releases.page.md @@ -1,5 +1,35 @@ ## {{page-title}} +
+
+ +Product Link | Version | Handle | Phase | State | Release Date | Stability | Change Log Link +-----------------------|---------|---------|----------|-----------------|--------------|------------|----------------- +Implementation Guide | 1.8.1 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-General}} +[FHIR Package](https://simplifier.net/packages/uk.nhsdigital.bars.r4/1.33.0) | uk.nhsdigital.bars.r4 1.33.0| v1 | Live | Current Release | 29/08/2024 | Stable | +{{pagelink:design-core-1.1.5, text:BaRS Core}} | 1.1.5 | 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.12 | v1 | Live | Current Release | 27/11/2024 | Stable |{{pagelink:trn-tkw}} +{{pagelink:application1, text:BaRS-APP1}} | 1.0.6 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app1,text:BaRS APP1 Change Log}} +{{pagelink:application2, text:BaRS-APP2}} | 1.0.6 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app2,text:BaRS APP2 Change Log}} +{{pagelink:application3, text:BaRS-APP3}} | 1.0.2 | v1 | Live | Current Release | 21/05/2024 | Stable |{{pagelink:trn-app3,text:BaRS APP3 Change Log}} +{{pagelink:application4, text:BaRS-APP4}} | 1.2.1 | v1 | Live | Current Release | 26/11/2024 | Stable |{{pagelink:trn-app4,text:BaRS APP4 Change Log}} +{{pagelink:application5, text:BaRS-APP5}} | 1.1.1 | 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.3 | 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.2 | alpha | | Current Release | 26/11/2024 | Pre-Release |{{pagelink:trn-app7,text:BaRS APP7 Change Log}} + + + +### Overview of the release + +Addition of use case categories to all BaRS Applications. +
+
+ +
+ +
+
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 acce53a8..1683f389 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 @@ -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)}} |

111 - ED
111 - UTC
CAS - ED
CAS - UTC
999 - ED
999 - UTC
111 - SDEC
CAS - SDEC
999 - SDEC

| 1.0.5 | v1.0.0 | v1.0.0 | -| {{pagelink:application2, text: Booking and Referrals into UEC (Application 2)}} |

111 Online - ED
111 Online - UTC
S&R - ED
S&R - UTC

| 1.0.5 | v1.0.0 | v1.0.0 | -| {{pagelink:application3, text: Referral into UEC (Application 3)}} |

999-CAS Referral
| 1.0.1 | v1.0.0 | v1.0.0 | -| {{pagelink:application4, text: Referral into UEC for Validation (Application 4)}} |

999-CAS Validation

999 AST to Falls Lifting Service

999 AST to Community Services
| 1.2.0 | v1.0.0 | v1.0.0 | -| {{pagelink:application5, text: Referrals into Pharmacy (Application 5)}} |

Primary Care to Community Pharmacy (Pharmacy First)

Primary Care to Pharmacy Contraception (Oral Contraception)

Primary Care to Pharmacy Blood Pressure Check Service
| 1.1.0 | v1.1.0 | {{pagelink:design-core-1.1.6, text:v1.1.0}} | +| {{pagelink:application1, text:Booking and Referrals into UEC (Application 1)}} |

111 - ED
111 - UTC
CAS - ED
CAS - UTC
999 - ED
999 - UTC
111 - SDEC
CAS - SDEC
999 - SDEC

| 1.0.6 | v1.0.0 | v1.0.0 | +| {{pagelink:application2, text: Booking and Referrals into UEC (Application 2)}} |

111 Online - ED
111 Online - UTC
S&R - ED
S&R - UTC

| 1.0.6 | v1.0.0 | v1.0.0 | +| {{pagelink:application3, text: Referral into UEC (Application 3)}} |

999-CAS Referral
| 1.0.3 | v1.0.0 | v1.0.0 | +| {{pagelink:application4, text: Referral into UEC for Validation (Application 4)}} |

999-CAS Validation

999 AST to Falls Lifting Service

999 AST to Community Services
| 1.2.2 | v1.0.0 | v1.0.0 | +| {{pagelink:application5, text: Referrals into Pharmacy (Application 5)}} |

Primary Care to Community Pharmacy (Pharmacy First)

Primary Care to Pharmacy Contraception (Oral Contraception)

Primary Care to Pharmacy Blood Pressure Check Service
| 1.1.2 | v1.1.0 | {{pagelink:design-core-1.1.6, text:v1.1.0}} |


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 7f4a774a..63987f61 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,8 +14,8 @@ 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.2 | API Spec v1.1.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.1.0 and above}} | -| {{pagelink:application7, text: Bookings into GP Practice (Application 7)}} |

Appointments for Patient facing services into GP Practice | 1.0.0-alpha | API Spec v1.1.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.1.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.4 | API Spec v1.1.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.1.0 and above}} | +| {{pagelink:application7, text: Bookings into GP Practice (Application 7)}} |

Appointments for Patient facing services into GP Practice | 1.0.0-alpha.3 | API Spec v1.1.0 and above | {{pagelink:design-core-1.1.4, text:Core v1.1.0 and above}} | diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.6/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.6/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md index da21b540..20d72d19 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.6/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.0.6/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md @@ -4,22 +4,29 @@ topic: core-SPUseCaseCategories-1.0.6 # {{page-title}} -One important factor, when making a request of another service, is ensuring the type (or category) of referral being requested is discrete, and sufficiently granular enough, to avoid overlap with other services. For example, a Pharmacy, may support numerous services such as Blood Pressure, New Medicine Service, Oral Contraception, etc.. The Receiver, during the processing of the referral request, will depend upon referral type (among other key information in the request payload) to direct to an appropriate clinical professional or queue etc., dictating the next workflow steps. - -The 'type' of referral is categorised at the service level, rather than organisation or system. This service provider level is where BaRS works to define the use-case, to digitise workflow. For example, within the AST (Ambulance Service Trust) referring to AST Service (CAD to CAD), {{pagelink:Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md, text:Application6}}, there are three use-cases defined; Out of Area, Mutual Aid and Call Assist. All of these referral request 'types' will end up within the same AST system but the workflows for them differ. These differences could include whether a request is accepted automatically or not, the timeframes an action must be dealt within and the skillset required to undertake the request. A use-case will only ever fit into one BaRS Application, but a BaRS Application may encompass several use-cases, as is the case with Application6. A list of [use-case categories](https://simplifier.net/nhsbookingandreferrals/usecases-categories-bars) have been defined in a specific BaRS CodeSystem which indicate the supported use-cases, and all BaRS compliant solutions must adopt. - -The use-case category is referenced in the initial negotation phase, when a Sender makes a request for MessageDefinitions, and in the subsequent referral request made to the Receiver. The MessageDefinition(s) returned by the Receiver will contain a use-case category code (from the 'use-case-categories' CodeSystem above) under *MessageDefintion.useContext.code*. The Sender **must** read this field to verify the Receiver supports the use-case workflow they intend to engage with. For example, in Application6, certain AST may not support Mutual Aid or Call Assist, therefore, it would be inappropriate to send a referral request to them for either of these use-cases. The Receiver will be able to make this distinction because the Sender's request will include the use-case category code value, under *ServiceRequest.category* and, if it is something they do not support, they will respond with an error (Operation Outcome). - -The sequence of events occurs as follows: -* the Sender requests the MessageDefintions (which indicate the use-case categories supported) +## What are use case categories? + +Use case categories define the specific type of referral being requested. The type is categorised at the service level. A BaRS Application can support multiple use cases; a use case can only ever belong to one BaRS Application. For instance, in Application 6 there are three defined use cases: Out of Area, Mutual Aid and Call Assist. All of these use cases relate to referrals between Ambulance Service Trusts but the workflow, timeframes and responses are not universal across all three scenarios. +The BaRS use case categories are defined in the BARS CodeSystem (https://simplifier.net/nhsbookingandreferrals/usecases-categories-bars). All BaRS compliant solutions must adopt use case categories. + +## How to use BaRS use case categories + +The use case category is used in the initial content negotiation phase: +* when a Sender makes a request for MessageDefinitions and the Receiver responds +* when the Sender makes a referral request to the Receiver + + +When a Sender makes a request for MessageDefinitions, the MessageDefinitions returned by the Receiver will contain a use case category code (from the use case categories code system) under Message.Definition.useContext.code. The Sender **must** read this field to verify the Receiver supports the use case workflow they require. The use case category code will also be included in: +* the Sender's service request under ServiceRequest.category +* the Sender’s booking request under Appointment.ServiceCategory + If this is not a use case supported by the Receiver, they will respond with an error (Operation Outcome). + +The sequence of events occurs as follows: +* the Sender requests the MessageDefinitions +* the Receiver indicates the use-case categories they support * the Sender reads and only engages in the use-case workflows supported -* the Sender's request includes the use-case category code (the same code they read from the MessageDefinition), under ServiceRequest.category +* the Sender's request includes the use-case category code (the same code they read from the MessageDefinition), under ServiceRequest.category (referral) or Appointment.ServiceCategory (booking) * the Receiver processes accordingly - - - - - diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md index ddb80e24..a532f895 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.1.6/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md @@ -4,16 +4,28 @@ topic: core-SPUseCaseCategories-1.1.6 # {{page-title}} -One important factor, when making a request of another service, is ensuring the type (or category) of referral being requested is discrete, and sufficiently granular enough, to avoid overlap with other services. For example, a Pharmacy, may support numerous services such as Blood Pressure, New Medicine Service, Oral Contraception, etc.. The Receiver, during the processing of the referral request, will depend upon referral type (among other key information in the request payload) to direct to an appropriate clinical professional or queue etc., dictating the next workflow steps. - -The 'type' of referral is categorised at the service level, rather than organisation or system. This service provider level is where BaRS works to define the use-case, to digitise workflow. For example, within the AST (Ambulance Service Trust) referring to AST Service (CAD to CAD), {{pagelink:Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md, text:Application6}}, there are three use-cases defined; Out of Area, Mutual Aid and Call Assist. All of these referral request 'types' will end up within the same AST system but the workflows for them differ. These differences could include whether a request is accepted automatically or not, the timeframes an action must be dealt within and the skillset required to undertake the request. A use-case will only ever fit into one BaRS Application, but a BaRS Application may encompass several use-cases, as is the case with Application6. A list of [use-case categories](https://simplifier.net/nhsbookingandreferrals/usecases-categories-bars) have been defined in a specific BaRS CodeSystem which indicate the supported use-cases, and all BaRS compliant solutions must adopt. - -The use-case category is referenced in the initial negotation phase, when a Sender makes a request for MessageDefinitions, and in the subsequent referral request made to the Receiver. The MessageDefinition(s) returned by the Receiver will contain a use-case category code (from the 'use-case-categories' CodeSystem above) under *MessageDefintion.useContext.code*. The Sender **must** read this field to verify the Receiver supports the use-case workflow they intend to engage with. For example, in Application6, certain AST may not support Mutual Aid or Call Assist, therefore, it would be inappropriate to send a referral request to them for either of these use-cases. The Receiver will be able to make this distinction because the Sender's request will include the use-case category code value, under *ServiceRequest.category* and, if it is something they do not support, they will respond with an error (Operation Outcome). - -The sequence of events occurs as follows: -* the Sender requests the MessageDefintions (which indicate the use-case categories supported) +## What are use case categories? + +Use case categories define the specific type of referral being requested. The type is categorised at the service level. A BaRS Application can support multiple use cases; a use case can only ever belong to one BaRS Application. For instance, in Application 6 there are three defined use cases: Out of Area, Mutual Aid and Call Assist. All of these use cases relate to referrals between Ambulance Service Trusts but the workflow, timeframes and responses are not universal across all three scenarios. +The BaRS use case categories are defined in the BARS CodeSystem (https://simplifier.net/nhsbookingandreferrals/usecases-categories-bars). All BaRS compliant solutions must adopt use case categories. + +## How to use BaRS use case categories + +The use case category is used in the initial content negotiation phase: +* when a Sender makes a request for MessageDefinitions and the Receiver responds +* when the Sender makes a referral request to the Receiver + + +When a Sender makes a request for MessageDefinitions, the MessageDefinitions returned by the Receiver will contain a use case category code (from the use case categories code system) under Message.Definition.useContext.code. The Sender **must** read this field to verify the Receiver supports the use case workflow they require. The use case category code will also be included in: +* the Sender's service request under ServiceRequest.category +* the Sender’s booking request under Appointment.ServiceCategory + If this is not a use case supported by the Receiver, they will respond with an error (Operation Outcome). + +The sequence of events occurs as follows: +* the Sender requests the MessageDefinitions +* the Receiver indicates the use-case categories they support * the Sender reads and only engages in the use-case workflows supported -* the Sender's request includes the use-case category code (the same code they read from the MessageDefinition), under ServiceRequest.category +* the Sender's request includes the use-case category code (the same code they read from the MessageDefinition), under ServiceRequest.category (referral) or Appointment.ServiceCategory (booking) * the Receiver processes accordingly diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md index 3d2495fa..8ec0251d 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Core/1.2.2/Standard-Pattern-Composite-Messages/Use-Case-Categories.page.md @@ -4,16 +4,28 @@ topic: core-SPUseCaseCategories-1.2.2 # {{page-title}} -One important factor, when making a request of another service, is ensuring the type (or category) of referral being requested is discrete, and sufficiently granular enough, to avoid overlap with other services. For example, a Pharmacy, may support numerous services such as Blood Pressure, New Medicine Service, Oral Contraception, etc.. The Receiver, during the processing of the referral request, will depend upon referral type (among other key information in the request payload) to direct to an appropriate clinical professional or queue etc., dictating the next workflow steps. - -The 'type' of referral is categorised at the service level, rather than organisation or system. This service provider level is where BaRS works to define the use-case, to digitise workflow. For example, within the AST (Ambulance Service Trust) referring to AST Service (CAD to CAD), {{pagelink:Home/Applications/BaRS-Applications/Applications/BaRS-APP6/Index.page.md, text:Application6}}, there are three use-cases defined; Out of Area, Mutual Aid and Call Assist. All of these referral request 'types' will end up within the same AST system but the workflows for them differ. These differences could include whether a request is accepted automatically or not, the timeframes an action must be dealt within and the skillset required to undertake the request. A use-case will only ever fit into one BaRS Application, but a BaRS Application may encompass several use-cases, as is the case with Application6. A list of [use-case categories](https://simplifier.net/nhsbookingandreferrals/usecases-categories-bars) have been defined in a specific BaRS CodeSystem which indicate the supported use-cases, and all BaRS compliant solutions must adopt. - -The use-case category is referenced in the initial negotation phase, when a Sender makes a request for MessageDefinitions, and in the subsequent referral request made to the Receiver. The MessageDefinition(s) returned by the Receiver will contain a use-case category code (from the 'use-case-categories' CodeSystem above) under *MessageDefintion.useContext.code*. The Sender **must** read this field to verify the Receiver supports the use-case workflow they intend to engage with. For example, in Application6, certain AST may not support Mutual Aid or Call Assist, therefore, it would be inappropriate to send a referral request to them for either of these use-cases. The Receiver will be able to make this distinction because the Sender's request will include the use-case category code value, under *ServiceRequest.category* and, if it is something they do not support, they will respond with an error (Operation Outcome). - -The sequence of events occurs as follows: -* the Sender requests the MessageDefintions (which indicate the use-case categories supported) +## What are use case categories? + +Use case categories define the specific type of referral being requested. The type is categorised at the service level. A BaRS Application can support multiple use cases; a use case can only ever belong to one BaRS Application. For instance, in Application 6 there are three defined use cases: Out of Area, Mutual Aid and Call Assist. All of these use cases relate to referrals between Ambulance Service Trusts but the workflow, timeframes and responses are not universal across all three scenarios. +The BaRS use case categories are defined in the BARS CodeSystem (https://simplifier.net/nhsbookingandreferrals/usecases-categories-bars). All BaRS compliant solutions must adopt use case categories. + +## How to use BaRS use case categories + +The use case category is used in the initial content negotiation phase: +* when a Sender makes a request for MessageDefinitions and the Receiver responds +* when the Sender makes a referral request to the Receiver + + +When a Sender makes a request for MessageDefinitions, the MessageDefinitions returned by the Receiver will contain a use case category code (from the use case categories code system) under Message.Definition.useContext.code. The Sender **must** read this field to verify the Receiver supports the use case workflow they require. The use case category code will also be included in: +* the Sender's service request under ServiceRequest.category +* the Sender’s booking request under Appointment.ServiceCategory + If this is not a use case supported by the Receiver, they will respond with an error (Operation Outcome). + +The sequence of events occurs as follows: +* the Sender requests the MessageDefinitions +* the Receiver indicates the use-case categories they support * the Sender reads and only engages in the use-case workflows supported -* the Sender's request includes the use-case category code (the same code they read from the MessageDefinition), under ServiceRequest.category +* the Sender's request includes the use-case category code (the same code they read from the MessageDefinition), under ServiceRequest.category (referral) or Appointment.ServiceCategory (booking) * the Receiver processes accordingly