Design principles
API scope
The scope of the API is to enable the ability for patients using patient facing applications (e.g the NHS App) to:
order a repeat prescription
view all medication including acute and repeat medcations, both current and historic
cancel an unactioned order for a repeat prescription
check the status of a prescription order
view active prescription requests
order an electronic repeat prescription as a one off to a pharmacy other than the patient's nominated pharmacy
Order a repeat prescription
This API will only allow orders for repeat prescriptions. Acute prescriptions should be handled via other methods until this functionality is supported.
A patient can add supporting evidence or additional information to a reqest which ensures that the practitioner will have all relevant information upon reviewing a medication order. For example a patient can include additional details such as where they are going on holiday or if they are reaching the end of their previous prescription.
The details of the request are bundled together into MedicationRequest:
- Status (requested, approved, rejected)
- Intent (order)
- Medication (name of medication)
- Authored On (DD/MM/YY)
- Note (free text supporting information provided by the user)
- Status Reason (to be used when request is rejected)
- Requester (patient)
- Dosage Instructions
- Previous Prescription (ID linking to the previous prescription issued)
- Prescription Type (repeat)
As part of the ordering process the patient can check the pharmacy the prescription will be sent to (once approved by a practitioner) for electronic prescriptions. This is where they can choose to send their prescription to an alternative pharmacy as a one-off nomination. This functionality is only available for electronic prescriptions which are processed via EPS.
When a patient chooses a one off nomination the MedicationRequest bundle will also include location details which can then be sent on for EPS to process should the practitioner approve the request:
- ODS Site Code
- Name
- Type
- Hours of Operation
For paper prescriptions the patient will be informed to collect their prescription from their practitioner.
View medication
Retrieves a full list of all medications related to the patient, including current and historic medication for both repeat and acute prescriptions.
Cancel prescription order
Patients can only cancel a prescription order if it has not been processed by a practitioner, while the status is 'Requested'.
Each medication item is requested individually and then bundled together into a single message. This means that each item will have its own status and can be cancelled on an individual basis instead of the entire request.
Prescription status
Prescription tracking will follow the status model shown below. This requires the practitioner to be EPS enabled. Statuses within the green area are in scope for the Prescriptions Management API.
For paper prescriptions tracking will end once the prescription has been printed.
Requested
Repeat prescription order has been created and submitted to practitioner systems but processing has not been started.
Approved
Repeat prescription order has been reviewed by a practitioner and passed through the system to EPS for processing/ printed ready for collection by the patient.
Rejected
Repeat prescription order has been reviewed by a practitioner and will not be processed further. When this selection is made by a practitioner they should be required to provide a rejection reason so the patient has context for this decision. This note is included within the 'status reason' free text field to ensure the full context of the response from the practitioner can be included in any response.