National Data Opt-out - FHIR API

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
• update the National Data Opt-out preferences for a patient
• display transaction history of National Data Opt-out preferences for a patient

You cannot currently:

• get existing National Data Opt-out preferences for a patient

Use the Check for National Data Opt-outs Service (POS) to get existing National Data Opt-out preferences for one or more patients. If your use case is not met by the POS service, please contact us.

This API is currently for internal NHS Digital use only.

The following APIs are related to this API:

• National Data Opt-out - MESH - submit a list of NHS numbers via MESH to be checked against the National Data Opt-out Service (NDOP)
• Access Control Service HL7 V3 API - use this API to manage patient consent to share their information, including their Summary Care Record (SCR), with the Access Control Service

This API is in production, beta but internal, meaning the API is not currently available for integration by external third parties. If you want to use it, contact us and we'll look at making it available.

This API is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays.

For more details, see service levels.

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.

This API is application-restricted, meaning:

• the calling application is authenticated - we do care who it is

• the end user is not authenticated - we do not verify who it is or whether they are present

In particular, it uses TLS Mutual Authentication (TLS-MA).

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

Integration testing

Our integration test environment:

• is for formal integration testing
• is stateful, so persists updates

For more details see integration testing with our RESTful APIs.

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

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