Skip to content

Commit 49dc4e1

Browse files
committed
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.
1 parent 2cdde5e commit 49dc4e1

3 files changed

Lines changed: 42 additions & 3 deletions

File tree

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

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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

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

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,27 @@ The BaRS referral process as shown above does not include guidance on how a user
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 | docs-dos-api (developer.nhs.uk).</a>
3144

3245

3346
#### Guidance on how to call the DoS API

0 commit comments

Comments
 (0)