Internet explorer is no longer supported

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

This API is currently for internal NHS Digital use only.

This API is in beta.

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.

This API is available on the internet and, indirectly, on the Health and Social Care Network (HSCN).

For more details, see Network access for APIs.

There are several independent instances of this API available for testing, each with a different base URL:

For a full list of interactions for this API, see Consent REST.

For details on the general structure of the interactions, see FHIR.