Skip to content

NBRS-4658 - Updates for DOS API Deprecation #596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
d-dreyer merged 2 commits into from
May 11, 2026
Merged

NBRS-4658 - Updates for DOS API Deprecation #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49dc4e1
NBRS-4658 - Updates for DOS API Deprecation
d-dreyer May 11, 2026
e6688e7
Minor Spelling Corrections
d-dreyer May 11, 2026
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.vscode
19 changes: 16 additions & 3 deletions .../Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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'
Expand Down Expand Up @@ -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. <a href="https://developer.nhs.uk/apis/dos-api/ccs_fields_v1.5_service_attribute.html" target="_blank">The DoS API documentation for this can be found here</a>.
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. <a href="https://digital.nhs.uk/developer/api-catalogue/directory-of-services-urgent-and-emergency-care-rest" target="_blank">The DoS API documentation for this can be found here</a>.

<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> DOS API Deprecation <hr>
<p> The current version of the DOS API is being deprecated, with a new API currently in Beta. <a href="https://digital.nhs.uk/developer/api-catalogue/directory-of-services-search-api">Documentation for the new API can be found here</a>, which includes the estimated roadmap.
<p> Whilst suppliers can continue to develop towards the current API, this would then require future rework to utilize the new API as the deprecation process continues.
<p> For more information on the deprecation, as well as guidance on onboarding and implementing towards the new API, please contact the DOS team directly.
<p> You can contact the DOS team via one of the contact options below, stating <b>“For the attention of Find the Right Service Team – Integrated Search.”</b>
<p><b>Contact Options:</b><br/>
<ul>
<li><a href="https://nhsdigitallive.service-now.com/csm?id=csm_index">ServiceNow Portal (preferred option)</a> </li>
<li>Email - <a href="ssd.nationalservicedesk@nhs.net">ssd.nationalservicedesk@nhs.net</a> </li>
<li>Telephone - 0300 3035035 - Please call if your query is urgent </li>
</ul>
</div>

##### Workflow

Expand Down
21 changes: 17 additions & 4 deletions .../Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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'
Expand Down Expand Up @@ -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. <a href="https://developer.nhs.uk/apis/dos-api/ccs_fields_v1.5_service_attribute.html" target="_blank">The DoS API documentation for this can be found here</a>.
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. <a href="https://digital.nhs.uk/developer/api-catalogue/directory-of-services-urgent-and-emergency-care-rest" target="_blank">The DoS API documentation for this can be found here</a>.

<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> DOS API Deprecation <hr>
<p> The current version of the DOS API is being deprecated, with a new API currently in Beta. <a href="https://digital.nhs.uk/developer/api-catalogue/directory-of-services-search-api">Documentation for the new API can be found here</a>, which includes the estimated roadmap.
<p> Whilst suppliers can continue to develop towards the current API, this would then require future rework to utilize the new API as the deprecation process continues.
<p> For more information on the deprecation, as well as guidance on onboarding and implementing towards the new API, please contact the DOS team directly.
<p> You can contact the DOS team via one of the contact options below, stating <b>“For the attention of Find the Right Service Team – Integrated Search.”</b>
<p><b>Contact Options:</b><br/>
<ul>
<li><a href="https://nhsdigitallive.service-now.com/csm?id=csm_index">ServiceNow Portal (preferred option)</a> </li>
<li>Email - <a href="ssd.nationalservicedesk@nhs.net">ssd.nationalservicedesk@nhs.net</a> </li>
<li>Telephone - 0300 3035035 - Please call if your query is urgent </li>
</ul>
</div>

##### Workflow

Expand Down Expand Up @@ -550,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.

<hr>
23 changes: 18 additions & 5 deletions .../Applications/BaRS-Applications/Applications/BaRS-APP5/How-does-it-work.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,31 @@ 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

<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> DOS API Deprecation <hr>
<p> The current version of the DOS API, as described below, is being deprecated, with a new API currently in Beta. <a href="https://digital.nhs.uk/developer/api-catalogue/directory-of-services-search-api">Documentation for the new API can be found here</a>, which includes the estimated roadmap.
<p> Whilst suppliers can continue to develop towards the current API, this would then require future rework to utilize the new API as the deprecation process continues.
<p> For more information on the deprecation, as well as guidance on onboarding and implementing towards the new API, please contact the DOS team directly.
<p> You can contact the DOS team via one of the contact options below, stating <b>“For the attention of Find the Right Service Team – Integrated Search.”</b>
<p><b>Contact Options:</b><br/>
<ul>
<li><a href="https://nhsdigitallive.service-now.com/csm?id=csm_index">ServiceNow Portal (preferred option)</a> </li>
<li>Email - <a href="ssd.nationalservicedesk@nhs.net">ssd.nationalservicedesk@nhs.net</a> </li>
<li>Telephone - 0300 3035035 - Please call if your query is urgent </li>
</ul>
</div>

Pharmacy services are profiled on the <a href="https://digital.nhs.uk/services/directory-of-services-dos" target="_blank">Directory of Services (DoS).</a>

For this application, systems should use the <a href="https://digital.nhs.uk/developer/api-catalogue/directory-of-services-urgent-and-emergency-care-rest" target="_blank">Directory of Services - Urgent and Emergency Care - REST API.</a>

Details on how to develop to use this API and onboard to use it in production, are provided in the links above.

For this application the Service Type search will be used:
<a href="https://developer.nhs.uk/apis/dos-api/byServiceType.html" target="_blank">Search by Service Type | docs-dos-api (developer.nhs.uk).</a>
<a href="https://digital.nhs.uk/developer/api-catalogue/directory-of-services-urgent-and-emergency-care-rest#get-/services/byServiceType/-caseId-/-postcode-/-searchDistance-/-gppracticeId-/-age-/-gender-/-disposition-/-serviceTypeIds-/-numberPerType-" target="_blank">Search by Service Type.</a>


#### Guidance on how to call the DoS API
Expand All @@ -46,7 +59,7 @@ The search parameters to be used are as follows:
<th>Parameter</th>
<th>Type</th>
<th>Required?</th>
<th>GP to Pharamcy Guidance Notes</th>
<th>GP to Pharmacy Guidance Notes</th>
</tr>
</thead>
<tbody>
Expand Down Expand Up @@ -517,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'
Expand All @@ -528,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'
Expand Down
6 changes: 3 additions & 3 deletions ...cations/BaRS-Applications/Applications/BaRS-APP5/Scope-and-Requirements.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand All @@ -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/)
Expand Down Expand Up @@ -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 <ins>not</ins> 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 <ins>not</ins> 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.
Expand Down
Loading