From 49dc4e105e203d3c5f6eeb4d9739c7704cd50f87 Mon Sep 17 00:00:00 2001 From: Derek Dreyer <56388818+d-dreyer@users.noreply.github.com> Date: Mon, 11 May 2026 12:30:14 +0100 Subject: [PATCH 1/2] NBRS-4658 - Updates for DOS API Deprecation Added warnings to Apps 1, 2 and 5, which included links to the DOS API, to correct the broken links, and add a warning that the current API is undergoing a deprecation process. --- .../BaRS-APP1/How-does-it-work.page.md | 15 ++++++++++++++- .../BaRS-APP2/How-does-it-work.page.md | 15 ++++++++++++++- .../BaRS-APP5/How-does-it-work.page.md | 15 ++++++++++++++- 3 files changed, 42 insertions(+), 3 deletions(-) diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md index a4db5c9d..86409c05 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md @@ -720,7 +720,20 @@ This means that these services will only accept a referral if a booking has also If no appointment is available then a referral should not be made. -To achieve this, a "service attribute" is configurable against services. This will allow the service to be flagged as "booking only". Therefore if this attribute is present on the service all consumer systems should withhold referrals. The DoS API documentation for this can be found here. +To achieve this, a "service attribute" is configurable against services. This will allow the service to be flagged as "booking only". Therefore if this attribute is present on the service all consumer systems should withhold referrals. The DoS API documentation for this can be found here. + + ##### Workflow diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md index f9526996..7deccbd0 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md @@ -521,7 +521,20 @@ This means that these services will only accept a referral if a booking has also If no appointment is available then a referral should not be made. -To achieve this, a "service attribute" is configurable against services. This will allow the service to be flagged as "booking only". Therefore if this attribute is present on the service all consumer systems should withhold referrals. The DoS API documentation for this can be found here. +To achieve this, a "service attribute" is configurable against services. This will allow the service to be flagged as "booking only". Therefore if this attribute is present on the service all consumer systems should withhold referrals. The DoS API documentation for this can be found here. + + ##### Workflow 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 bee92c9d..3ceb6253 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 @@ -20,6 +20,19 @@ The BaRS referral process as shown above does not include guidance on how a user #### Directory of Services API + + Pharmacy services are profiled on the Directory of Services (DoS). For this application, systems should use the Directory of Services - Urgent and Emergency Care - REST API. @@ -27,7 +40,7 @@ For this application, systems should use the Search by Service Type | docs-dos-api (developer.nhs.uk). +Search by Service Type | docs-dos-api (developer.nhs.uk). #### Guidance on how to call the DoS API From e6688e726a75b658e9afc761adc401a464c1472b Mon Sep 17 00:00:00 2001 From: Derek Dreyer <56388818+d-dreyer@users.noreply.github.com> Date: Mon, 11 May 2026 12:47:06 +0100 Subject: [PATCH 2/2] Minor Spelling Corrections --- .gitignore | 1 + .../Applications/BaRS-APP1/How-does-it-work.page.md | 4 ++-- .../Applications/BaRS-APP2/How-does-it-work.page.md | 6 +++--- .../Applications/BaRS-APP5/How-does-it-work.page.md | 10 +++++----- .../BaRS-APP5/Scope-and-Requirements.page.md | 6 +++--- 5 files changed, 14 insertions(+), 13 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..598ae792 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/.vscode diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md index 86409c05..213893f8 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md @@ -581,7 +581,7 @@ Receive_Request if (Message == "update") { - if (currentLocalData.LastUpdated > originaRequest.ReceivedDate) + if (currentLocalData.LastUpdated > originalRequest.ReceivedDate) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' @@ -592,7 +592,7 @@ Receive_Request { if (currentLocalData.Item.exists) { - if (currentLocalData.LastUpdated > originaRequest.Received) + if (currentLocalData.LastUpdated > originalRequest.Received) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md index 7deccbd0..5606acf0 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md @@ -382,7 +382,7 @@ Receive_Request if (Message == "update") { - if (currentLocalData.LastUpdated > originaRequest.ReceivedDate) + if (currentLocalData.LastUpdated > originalRequest.ReceivedDate) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' @@ -393,7 +393,7 @@ Receive_Request { if (currentLocalData.Item.exists) { - if (currentLocalData.LastUpdated > originaRequest.Received) + if (currentLocalData.LastUpdated > originalRequest.Received) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' @@ -563,6 +563,6 @@ This attribute will have three possible states: * present and false * present and true -For the first two cases, it can be assumed that referrals can be made without a booking. Only if the attribute is *present* **and** *true* should a referral be witheld if there has been no booking. +For the first two cases, it can be assumed that referrals can be made without a booking. Only if the attribute is *present* **and** *true* should a referral be withheld if there has been no booking.
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 3ceb6253..ea604dd0 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 @@ -16,7 +16,7 @@ To support the workflows for this application of the standard the operations tha ### Find a Service -The BaRS referral process as shown above does not include guidance on how a user should determine if a referral to Pharmacy is appropriate for the patient. It is the responsibility of the referring organisaton to ensure patients are pre-screened by GP Practice staff (care navigators or clinicians) prior to beginning the referral process, using their own judgement or an appropriate triage tool. +The BaRS referral process as shown above does not include guidance on how a user should determine if a referral to Pharmacy is appropriate for the patient. It is the responsibility of the referring organisation to ensure patients are pre-screened by GP Practice staff (care navigators or clinicians) prior to beginning the referral process, using their own judgement or an appropriate triage tool. #### Directory of Services API @@ -40,7 +40,7 @@ For this application, systems should use the Search by Service Type | docs-dos-api (developer.nhs.uk). +Search by Service Type. #### Guidance on how to call the DoS API @@ -59,7 +59,7 @@ The search parameters to be used are as follows: Parameter Type Required? - GP to Pharamcy Guidance Notes + GP to Pharmacy Guidance Notes @@ -530,7 +530,7 @@ Receive_Request if (Message == "update") { - if (currentLocalData.LastUpdated > originaRequest.ReceivedDate) + if (currentLocalData.LastUpdated > originalRequest.ReceivedDate) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' @@ -541,7 +541,7 @@ Receive_Request { if (currentLocalData.Item.exists) { - if (currentLocalData.LastUpdated > originaRequest.Received) + if (currentLocalData.LastUpdated > lRequest.Received) { OperationOutcome.issue.code = "conflict" throw exception with 'REC_CONFLICT' diff --git a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Scope-and-Requirements.page.md b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Scope-and-Requirements.page.md index aa6334bd..b70faa78 100644 --- a/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Scope-and-Requirements.page.md +++ b/guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Scope-and-Requirements.page.md @@ -16,7 +16,7 @@ The payload and workflow have been designed to support this service. Other {{pag ### Functional Scope **Service Discovery** - Establishing a service to direct requests to is a mandatory step in the workflow -- There is no restriction on the service discovery tools used. Any are capable of being supported whether national or proprietary. However, the NHS England Directory of Services supports this application and futher details are provided in the 'Find a Service' section +- There is no restriction on the service discovery tools used. Any are capable of being supported whether national or proprietary. However, the NHS England Directory of Services supports this application and further details are provided in the 'Find a Service' section - The service **must** be configured within the BaRS infrastructure (Endpoint Catalogue) before requests can be made **Referral** @@ -32,7 +32,7 @@ The payload and workflow have been designed to support this service. Other {{pag - Consent within BaRS will be for Direct-Care only - Certificates for Receiving messages to use nhs.uk domains only - Receiving endpoints are to be internet facing -- Clincial Constraints exist - See Hazard Log +- Clinical Constraints exist - See Hazard Log - No element level 'updates' to requests are supported. A new request must be generated to change information in the referral request - Where an Online Consultation tool is used to refer, the referral must be verified by a human representative of the sending organisation before the request is made - Referrals to the Oral Contraception service must adhere to the [published policy specification](https://www.england.nhs.uk/long-read/nhs-pharmacy-contraception-service/) @@ -78,7 +78,7 @@ The payload and workflow have been designed to support this service. Other {{pag **Re-refer** - The referral Sender **must** be capable of re-referring within the current consultation or after the consultation event -- If the patient recontacts the sending service after the sender's consultation has been completed, the patient **should** be reassessed prior to attempting to re-refer +- If the patient re-contacts the sending service after the sender's consultation has been completed, the patient **should** be reassessed prior to attempting to re-refer - The referral Sender **should** revoke the original referral prior to making a re-referral, whether within the current consultation or after the consultation event - Where the re-referral was not successful, the Receiver **must** send an appropriate response. See {{pagelink:core-failure_scenarios-1.4.1, text:failure scenarios}} for more detail. - Where the re-referral was not successful, the Sender **must** present an appropriate message to the end user. See {{pagelink:core-failure_scenarios-1.4.1, text:failure scenarios}} for more detail.