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.
National Data Opt-out - FHIR API
Capture patients' preferences and control sharing of their data by healthcare organisations for planning and research purposes with our National Data Opt-out (NDOP) FHIR API.
Page contents
Overview
Use this API to capture patients' preferences and control sharing of their data by healthcare organisations for planning and research purposes using National Data Opt-out (NDOP).
You can:
- create National Data Opt-out preferences for a patient
- get existing National Data Opt-out preferences for a patient
- update the National Data Opt-out preferences for a patient
- display transaction history of National Data Opt-out preferences for a patient
API status
This API is in beta.
Technology
This API is a FHIR API.
Specifically, it is based on the HL7 FHIR STU3 3.0.1 Messaging Implementation, April 2017.
For more details, see FHIR.
Interactions
For a full list of interactions for this API, see Consent REST.
For details on the general structure of the interactions, see FHIR.
Last edited: 4 February 2021 5:13 pm