Skip to main content
Table of contents

National Data Opt-out - FHIR API

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

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.

Documentation

National Data Opt-out - FHIR API documentation

Endpoint

https://digital.nhs.uk/developer/api-catalogue/national-data-opt-out-fhir

Contact

https://digital.nhs.uk/developer/help-and-support