Interactions
The API has a single endpoint (/Patient/{id}) and utilises GET and POST HTTP request methods to differentiate between the requests. Those requests represent the following interactions.
Get a patient's permissions
Get a patient's permissions, from the perspective of a patient facing application e.g. the NHS App can be used to fulfil two main use cases:
- To provide the information to the patient so they can see what permissions they have to their medical record and access to services.
- For the application to determine which features and functionality within the application should be displayed and made available to the patient. For example, if the patient has
viewaccess (and by implication doesn't have manage access) to the appointments service there would be no point in displaying buttons to book or cancel appointments.
For more detailed information see:
Enabling online access for a first time user
The act of using the get permissions API will enable online access and set a patient's default permissions the first time the request is made. This is detailed in the new online patient access page.
As a result, all applications using the PFS APIs should call the get permissions API prior to any other interactions. If this doesn't happen there is a chance the patient will not have online access enabled and the expected API response will return a not found error.
Request a change to a patient's permission
Request a change to the permission a patient has to their medical record and online services provided by the GP practice.
The API provides the ability to request:
- additional access to the appointments
- additional access to the prescriptions
- additional access to their current medical record
- detailed coded record access to their historical medical record
For more detailed information see: