Skip to content

Commit

Permalink
Merge branch 'main' into use_proxygen_lambda
Browse files Browse the repository at this point in the history
  • Loading branch information
anthony-nhs authored Aug 7, 2024
2 parents 0936690 + a73294b commit 520bf35
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions packages/specification/eps-prescription-status-update-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,17 @@ info:
email: [email protected]
description: |
## Overview
The Prescription Status Update API allows dispensing suppliers to push status information about electronic prescriptions to patients on a national scale via the NHS App (and potential other third parties in the future).
This includes letting patients know when their prescription is ready to collect.
The overall aim of the service is to reduce burden to front line NHS services by reducing the number of routine patient queries about their prescriptions.
Use this API to enable dispensing suppliers to push status information about electronic prescriptions to patients on a national scale via the NHS App (and potential other third parties in the future).
The overall aim of the service is to reduce burden to frontline NHS services by reducing the number of routine patient queries about their prescriptions.
You can:
* Enable patients to know when their prescription is ready
* Enable dispensing suppliers to push status information about electronic prescriptions
* enable patients to know when their prescription is ready
* enable dispensing suppliers to push status information about electronic prescriptions
## Who can use this API
The Prescription Status Update API is intended for NHS England internal use only; however, the specification of the data stores will be required by dispensing suppliers so they can provide and push the information required to a central NHS data store.
## Related APIs
The following APIs are related to the "Prescription Status Update" API:
The following APIs are related to the Prescription Status Update API:
* [Electronic Prescriptions Service](https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-fhir): the national service for creating and dispensing prescriptions across health and social care.
* [Prescriptions for Patients](https://digital.nhs.uk/developer/api-catalogue/prescriptions-for-patients): the national service to retrieve prescriptions data for individual patients from the Electronic Prescription Service (EPS), for use in patient-facing applications.
## API Status and Roadmap
Expand Down Expand Up @@ -57,6 +58,7 @@ info:
* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
* 400 to 499 if it failed because of a client error by your application
* 500 to 599 if it failed because of an error on our server
Errors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.
## Open source
You might find the following [open source](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#open-source) resources useful:
Expand Down Expand Up @@ -212,15 +214,15 @@ paths:
/checkprescriptionstatusupdates:
get:
operationId: check-prescription-status-updates
summary: Check Prescription status updates
summary: Check prescription status updates
description: |
## This endpoint is only available in PTL environments
## Overview
This returns prescription status updates created by the authorized application. The result can be filtered by a combination of odscode, nhsnumber or prescription id.
A maximum of 15 results is returned. If more results are available, then headers LastEvaluatedKey-PrescriptionID and LastEvaluatedKey-TaskID are returned in the result. These values should be used in a subsequent request in the headers ExclusiveStartKey-PrescriptionID and ExclusiveStartKey-TaskID.
Note that it is possible that less than 15 results are returned even when more are available. This is a feature of the database and filtering method being used. At least 5 results will be returned, if available.
It is possible that less than 15 results are returned even when more are available. This is a feature of the database and filtering methods being used. At least 5 results will be returned, if available.
parameters:
- in: query
name: odscode
Expand Down

0 comments on commit 520bf35

Please sign in to comment.