Skip to content

Commit 64cdb58

Browse files
d-dreyerd-dreyer
authored
Merge pull request #596 from NHSDigital/20260511-DD-IG1.11.1-DOSUpdates
NBRS-4658 - Updates for DOS API Deprecation
2 parents 44dc51f + e6688e7 commit 64cdb58

5 files changed

Lines changed: 55 additions & 15 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/.vscode

‎guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP1/How-does-it-work.page.md‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ Receive_Request
581581

582582
if (Message == "update")
583583
{
584-
if (currentLocalData.LastUpdated > originaRequest.ReceivedDate)
584+
if (currentLocalData.LastUpdated > originalRequest.ReceivedDate)
585585
{
586586
OperationOutcome.issue.code = "conflict"
587587
throw exception with 'REC_CONFLICT'
@@ -592,7 +592,7 @@ Receive_Request
592592
{
593593
if (currentLocalData.Item.exists)
594594
{
595-
if (currentLocalData.LastUpdated > originaRequest.Received)
595+
if (currentLocalData.LastUpdated > originalRequest.Received)
596596
{
597597
OperationOutcome.issue.code = "conflict"
598598
throw exception with 'REC_CONFLICT'
@@ -720,7 +720,20 @@ This means that these services will only accept a referral if a booking has also
720720

721721
If no appointment is available then a referral should not be made.
722722

723-
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>.
723+
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>.
724+
725+
<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> DOS API Deprecation <hr>
726+
<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.
727+
<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.
728+
<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.
729+
<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>
730+
<p><b>Contact Options:</b><br/>
731+
<ul>
732+
<li><a href="https://nhsdigitallive.service-now.com/csm?id=csm_index">ServiceNow Portal (preferred option)</a> </li>
733+
<li>Email - <a href="ssd.nationalservicedesk@nhs.net">ssd.nationalservicedesk@nhs.net</a> </li>
734+
<li>Telephone - 0300 3035035 - Please call if your query is urgent </li>
735+
</ul>
736+
</div>
724737

725738
##### Workflow
726739

‎guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP2/How-does-it-work.page.md‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ Receive_Request
382382

383383
if (Message == "update")
384384
{
385-
if (currentLocalData.LastUpdated > originaRequest.ReceivedDate)
385+
if (currentLocalData.LastUpdated > originalRequest.ReceivedDate)
386386
{
387387
OperationOutcome.issue.code = "conflict"
388388
throw exception with 'REC_CONFLICT'
@@ -393,7 +393,7 @@ Receive_Request
393393
{
394394
if (currentLocalData.Item.exists)
395395
{
396-
if (currentLocalData.LastUpdated > originaRequest.Received)
396+
if (currentLocalData.LastUpdated > originalRequest.Received)
397397
{
398398
OperationOutcome.issue.code = "conflict"
399399
throw exception with 'REC_CONFLICT'
@@ -521,7 +521,20 @@ This means that these services will only accept a referral if a booking has also
521521

522522
If no appointment is available then a referral should not be made.
523523

524-
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>.
524+
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>.
525+
526+
<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> DOS API Deprecation <hr>
527+
<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.
528+
<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.
529+
<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.
530+
<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>
531+
<p><b>Contact Options:</b><br/>
532+
<ul>
533+
<li><a href="https://nhsdigitallive.service-now.com/csm?id=csm_index">ServiceNow Portal (preferred option)</a> </li>
534+
<li>Email - <a href="ssd.nationalservicedesk@nhs.net">ssd.nationalservicedesk@nhs.net</a> </li>
535+
<li>Telephone - 0300 3035035 - Please call if your query is urgent </li>
536+
</ul>
537+
</div>
525538

526539
##### Workflow
527540

@@ -550,6 +563,6 @@ This attribute will have three possible states:
550563
* present and false
551564
* present and true
552565

553-
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.
566+
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.
554567

555568
<hr>

‎guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/How-does-it-work.page.md‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,31 @@ To support the workflows for this application of the standard the operations tha
1616

1717
### Find a Service
1818

19-
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.
19+
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.
2020

2121
#### Directory of Services API
2222

23+
<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i><b> Important:</b> DOS API Deprecation <hr>
24+
<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.
25+
<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.
26+
<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.
27+
<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>
28+
<p><b>Contact Options:</b><br/>
29+
<ul>
30+
<li><a href="https://nhsdigitallive.service-now.com/csm?id=csm_index">ServiceNow Portal (preferred option)</a> </li>
31+
<li>Email - <a href="ssd.nationalservicedesk@nhs.net">ssd.nationalservicedesk@nhs.net</a> </li>
32+
<li>Telephone - 0300 3035035 - Please call if your query is urgent </li>
33+
</ul>
34+
</div>
35+
2336
Pharmacy services are profiled on the <a href="https://digital.nhs.uk/services/directory-of-services-dos" target="_blank">Directory of Services (DoS).</a>
2437

2538
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>
2639

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

2942
For this application the Service Type search will be used:
30-
<a href="https://developer.nhs.uk/apis/dos-api/byServiceType.html" target="_blank">Search by Service Type | docs-dos-api (developer.nhs.uk).</a>
43+
<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>
3144

3245

3346
#### Guidance on how to call the DoS API
@@ -46,7 +59,7 @@ The search parameters to be used are as follows:
4659
<th>Parameter</th>
4760
<th>Type</th>
4861
<th>Required?</th>
49-
<th>GP to Pharamcy Guidance Notes</th>
62+
<th>GP to Pharmacy Guidance Notes</th>
5063
</tr>
5164
</thead>
5265
<tbody>
@@ -517,7 +530,7 @@ Receive_Request
517530

518531
if (Message == "update")
519532
{
520-
if (currentLocalData.LastUpdated > originaRequest.ReceivedDate)
533+
if (currentLocalData.LastUpdated > originalRequest.ReceivedDate)
521534
{
522535
OperationOutcome.issue.code = "conflict"
523536
throw exception with 'REC_CONFLICT'
@@ -528,7 +541,7 @@ Receive_Request
528541
{
529542
if (currentLocalData.Item.exists)
530543
{
531-
if (currentLocalData.LastUpdated > originaRequest.Received)
544+
if (currentLocalData.LastUpdated > lRequest.Received)
532545
{
533546
OperationOutcome.issue.code = "conflict"
534547
throw exception with 'REC_CONFLICT'

‎guides/Live-ImplementationGuide-BaRS/Home/Applications/BaRS-Applications/Applications/BaRS-APP5/Scope-and-Requirements.page.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The payload and workflow have been designed to support this service. Other {{pag
1616
### Functional Scope
1717
**Service Discovery**
1818
- Establishing a service to direct requests to is a mandatory step in the workflow
19-
- 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
19+
- 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
2020
- The service **must** be configured within the BaRS infrastructure (Endpoint Catalogue) before requests can be made
2121

2222
**Referral**
@@ -32,7 +32,7 @@ The payload and workflow have been designed to support this service. Other {{pag
3232
- Consent within BaRS will be for Direct-Care only
3333
- Certificates for Receiving messages to use nhs.uk domains only
3434
- Receiving endpoints are to be internet facing
35-
- Clincial Constraints exist - See Hazard Log
35+
- Clinical Constraints exist - See Hazard Log
3636
- No element level 'updates' to requests are supported. A new request must be generated to change information in the referral request
3737
- 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
3838
- 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
7878

7979
**Re-refer**
8080
- The referral Sender **must** be capable of re-referring within the current consultation or after the consultation event
81-
- 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
81+
- 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
8282
- The referral Sender **should** revoke the original referral prior to making a re-referral, whether within the current consultation or after the consultation event
8383
- 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.
8484
- 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.

0 commit comments

Comments
 (0)