Skip to content

Commit

Permalink
Merge pull request #78 from nhsd-a2si/master
Browse files Browse the repository at this point in the history
DS-786 Merge new PoC fields documentation to publish
  • Loading branch information
forjayssake authored Nov 22, 2023
2 parents 7756cd6 + cb53658 commit ea35a1c
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 6 deletions.
11 changes: 10 additions & 1 deletion _pages/rest_api/byClinicalTerm.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,9 @@ Where matching services are returned, the following data items should be include
* Hex
* Endpoints
* Distance from patient

* Public name
* Professional referral information

## Note about response fields

## Email
Expand Down Expand Up @@ -177,3 +179,10 @@ 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.

## Professional referral information

Additional referral information.
12 changes: 10 additions & 2 deletions _pages/rest_api/byODSCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,9 @@ Where matching services are returned, the following data items should be include
* ID
* Name
* Endpoints


* Service public name
* Professional referral information

## Note about response fields

## Email
Expand Down Expand Up @@ -143,3 +144,10 @@ 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.

## Professional referral information

Additional referral information.
12 changes: 11 additions & 1 deletion _pages/rest_api/byServiceId.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,9 @@ Where matching services are returned, the following data items should be include
* ID
* Name
* Endpoints

* Service public name
* Professional referral information


## Note about repsonse fields

Expand Down Expand Up @@ -140,3 +142,11 @@ 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.

## Professional referral information

Additional referral information.
12 changes: 10 additions & 2 deletions _pages/rest_api/byServiceType.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,8 @@ Where matching services are returned, the following data items should be include
* Hex
* Endpoints
* Distance from patient

* Service public name
* Professional referral information

## Note about response fields

Expand Down Expand Up @@ -175,7 +176,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.


## 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.

## Professional referral information

Additional referral information.

0 comments on commit ea35a1c

Please sign in to comment.