We have detected that you are using Internet Explorer to visit this website. Internet Explorer is now being phased out by Microsoft. As a result, NHS Digital no longer supports any version of Internet Explorer for our web-based products, as it involves considerable extra effort and expense, which cannot be justified from public funds. Some features on this site will not work. You should use a modern browser such as Edge, Chrome, Firefox, or Safari. If you have difficulty installing or accessing a different browser, contact your IT support team.
Alerts - HL7 V3 API
Send an alert for the attention of a Privacy Officer so they can audit whether access to a patient’s data was appropriate, using our HL7 V3 API.
Use this API to send an alert for the attention of a Privacy Officer - also known as Summary Care Record Governance Person (SGP) in community pharmacies - so they can audit proactively whether access to a patient’s data was appropriate.
This provides a general alerting mechanism covering, for example, when a user looks up a patient on the Summary Care Record application (SCRa).
This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development.
You must do this before you can go live (see ‘Onboarding’ below).
The following APIs are related to this one:
This API is stable.
This API is an HL7 V3 API.
It uses asynchronous HL7 V3.
For more details, see HL7 V3.
Security and authorisation
This API is user-restricted, meaning an end user must be present and authenticated to use it.
The end user must be:
- a healthcare professional
- strongly authenticated, using either an NHS smartcard or a modern alternative
We support the following security patterns:
- user-restricted HL7 V3 API, using NHS Identity
- user-restricted HL7 V3 API, using CIS
For more details see user-restricted APIs.
For some activities, the end user must be authorised to perform that activity.
The API itself does not perform any authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database.
For more details see our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page.
You can test this API using our Path to Live environments.