Skip to main content
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.

 

Overview

This API is currently for internal NHS Digital use only.

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

Who can use this API

This API is currently for internal NHS Digital use only.


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.


Network access

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.


Environments and testing

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

Spine environment Network availability Base URL
Development HSCN https://msg.dev.spine2.ncrs.nhs.uk/
Integration HSCN https://msg.int.spine2.ncrs.nhs.uk/
Deployment HSCN https://msg.dep.spine2.ncrs.nhs.uk/
Production Internet https://clinicals.spineservices.nhs.uk/

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: 22 October 2021 4:27 pm