From c6548fab619b1d74c2a20b6b5c5fd004b899ebf1 Mon Sep 17 00:00:00 2001 From: Jay Bush Date: Tue, 12 Sep 2023 17:00:27 +0100 Subject: [PATCH 1/2] DS-1011 Added docs for additional fields. --- _pages/rest_api/byClinicalTerm.md | 16 +++++++++++++++- _pages/rest_api/byODSCode.md | 17 +++++++++++++++-- _pages/rest_api/byServiceId.md | 17 ++++++++++++++++- _pages/rest_api/byServiceType.md | 17 +++++++++++++++-- 4 files changed, 61 insertions(+), 6 deletions(-) diff --git a/_pages/rest_api/byClinicalTerm.md b/_pages/rest_api/byClinicalTerm.md index 904f540..774e5dc 100644 --- a/_pages/rest_api/byClinicalTerm.md +++ b/_pages/rest_api/byClinicalTerm.md @@ -130,7 +130,10 @@ Where matching services are returned, the following data items should be include * Hex * Endpoints * Distance from patient - +* Public name +* Public facing information +* Professional referral information + ## Note about response fields ## Email @@ -177,3 +180,14 @@ Where a service capacity has not been updated for more than 24 hours, this is no This is a straight-line distance between the search postcode and that of the service, in miles. +## Public name + +An alternative name for the service that would be better known to the public, and may differ from the registered name. + +## Public facing information + +Service access information available to the public. + +## Professional referral information + +Additional referral information. \ No newline at end of file diff --git a/_pages/rest_api/byODSCode.md b/_pages/rest_api/byODSCode.md index 776fed1..ac8df2d 100644 --- a/_pages/rest_api/byODSCode.md +++ b/_pages/rest_api/byODSCode.md @@ -100,8 +100,10 @@ Where matching services are returned, the following data items should be include * ID * Name * Endpoints - - +* Service public name +* Public facing information +* Professional referral information + ## Note about response fields ## Email @@ -143,3 +145,14 @@ The default capacity for services is Green (High) but this may be changed to Amb Where a service capacity has not been updated for more than 24 hours, this is not returned. +## Public name + +An alternative name for the service that would be better known to the public, and may differ from the registered name. + +## Public facing information + +Service access information available to the public. + +## Professional referral information + +Additional referral information. \ No newline at end of file diff --git a/_pages/rest_api/byServiceId.md b/_pages/rest_api/byServiceId.md index 88b25e1..0a39891 100644 --- a/_pages/rest_api/byServiceId.md +++ b/_pages/rest_api/byServiceId.md @@ -98,7 +98,10 @@ Where matching services are returned, the following data items should be include * ID * Name * Endpoints - +* Service public name +* Public facing information +* Professional referral information + ## Note about repsonse fields @@ -140,3 +143,15 @@ Both public and non-public telephone numbers are included in the response. The n The default capacity for services is Green (High) but this may be changed to Amber (Low) or Red (None) for a set period of time, up to 24 hours. Services which have a Red status will return but care should be taken when deciding whether or not to display these, as they have reported that they have little or no capacity to accept new patients, or may be temporarily closed. Where a service capacity has not been updated for more than 24 hours, this is not returned. + +## Public name + +An alternative name for the service that would be better known to the public, and may differ from the registered name. + +## Public facing information + +Service access information available to the public. + +## Professional referral information + +Additional referral information. \ No newline at end of file diff --git a/_pages/rest_api/byServiceType.md b/_pages/rest_api/byServiceType.md index 3a4c8a2..772aa02 100644 --- a/_pages/rest_api/byServiceType.md +++ b/_pages/rest_api/byServiceType.md @@ -131,7 +131,9 @@ Where matching services are returned, the following data items should be include * Hex * Endpoints * Distance from patient - +* Service public name +* Public facing information +* Professional referral information ## Note about response fields @@ -175,7 +177,18 @@ The default capacity for services is Green (High) but this may be changed to Amb Where a service capacity has not been updated for more than 24 hours, this is not returned. - ## Distance from patient This is a straight-line distance between the search postcode and that of the service, in miles. + +## Public name + +An alternative name for the service that would be better known to the public, and may differ from the registered name. + +## Public facing information + +Service access information available to the public. + +## Professional referral information + +Additional referral information. \ No newline at end of file From 9098d7a8ead6940565ded17577b7283a12084104 Mon Sep 17 00:00:00 2001 From: Jay Bush Date: Mon, 25 Sep 2023 08:22:31 +0100 Subject: [PATCH 2/2] DS-1011 Removed public facing information of PoC API documentation --- _pages/rest_api/byClinicalTerm.md | 5 ----- _pages/rest_api/byODSCode.md | 5 ----- _pages/rest_api/byServiceId.md | 5 ----- _pages/rest_api/byServiceType.md | 5 ----- 4 files changed, 20 deletions(-) diff --git a/_pages/rest_api/byClinicalTerm.md b/_pages/rest_api/byClinicalTerm.md index 774e5dc..bff9e34 100644 --- a/_pages/rest_api/byClinicalTerm.md +++ b/_pages/rest_api/byClinicalTerm.md @@ -131,7 +131,6 @@ Where matching services are returned, the following data items should be include * Endpoints * Distance from patient * Public name -* Public facing information * Professional referral information ## Note about response fields @@ -184,10 +183,6 @@ This is a straight-line distance between the search postcode and that of the ser An alternative name for the service that would be better known to the public, and may differ from the registered name. -## Public facing information - -Service access information available to the public. - ## Professional referral information Additional referral information. \ No newline at end of file diff --git a/_pages/rest_api/byODSCode.md b/_pages/rest_api/byODSCode.md index ac8df2d..2e0dd41 100644 --- a/_pages/rest_api/byODSCode.md +++ b/_pages/rest_api/byODSCode.md @@ -101,7 +101,6 @@ Where matching services are returned, the following data items should be include * Name * Endpoints * Service public name -* Public facing information * Professional referral information ## Note about response fields @@ -149,10 +148,6 @@ Where a service capacity has not been updated for more than 24 hours, this is no An alternative name for the service that would be better known to the public, and may differ from the registered name. -## Public facing information - -Service access information available to the public. - ## Professional referral information Additional referral information. \ No newline at end of file diff --git a/_pages/rest_api/byServiceId.md b/_pages/rest_api/byServiceId.md index 0a39891..6e884f7 100644 --- a/_pages/rest_api/byServiceId.md +++ b/_pages/rest_api/byServiceId.md @@ -99,7 +99,6 @@ Where matching services are returned, the following data items should be include * Name * Endpoints * Service public name -* Public facing information * Professional referral information @@ -148,10 +147,6 @@ Where a service capacity has not been updated for more than 24 hours, this is no An alternative name for the service that would be better known to the public, and may differ from the registered name. -## Public facing information - -Service access information available to the public. - ## Professional referral information Additional referral information. \ No newline at end of file diff --git a/_pages/rest_api/byServiceType.md b/_pages/rest_api/byServiceType.md index 772aa02..e7998b1 100644 --- a/_pages/rest_api/byServiceType.md +++ b/_pages/rest_api/byServiceType.md @@ -132,7 +132,6 @@ Where matching services are returned, the following data items should be include * Endpoints * Distance from patient * Service public name -* Public facing information * Professional referral information ## Note about response fields @@ -185,10 +184,6 @@ This is a straight-line distance between the search postcode and that of the ser An alternative name for the service that would be better known to the public, and may differ from the registered name. -## Public facing information - -Service access information available to the public. - ## Professional referral information Additional referral information. \ No newline at end of file