Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

National Data Opt-out | Reference

Developer Cheat Sheet shortcuts for the technical build of National Data Opt-out API.

National Data Opt-out Profiles:

Profile
NDOP-Consent-1
Spine-OperationOutcome-1

National Data Opt-out Extensions

Extension
Extension-NDOP-ProxyRole-1
Extension-NDOP-OptOutSource-1
Extension-NDOP-NICReference-1

National Data Opt-out Valuesets

Valueset Description
NDOP-OptOutSource-1 How the Opt-out preference was set e.g Online, GP, etc.
NDOP-ProxyRole-1 The role of a proxy where used to set Opt-out preferences
NDOP-OptOutCategory-1 OPTIONAL Opt-out category to support future Opt-out programmes.
Spine-ErrorOrWarningCode-1 Spine error codes

National Data Opt-out CodeSystems

CodeSystem Description
NDOP-OptOutSource-1 List of Opt-out sources
NDOP-ProxyRole-1 List of approved proxy roles
NDOP-OptOutCategory-1 List of approved categories
Spine-ErrorOrWarningCode-1 Spine error codes and descriptions.

Identifiers

identifier URI Comment
Patient https://demographics.spineservices.nhs.uk/STU3/Patient/[NHS Number] Patient
organization https://directory.spineservices.nhs.uk/STU3/Organization/[Org Code] NHS Digital (X26)
Tags: development

All content is available under the Open Government Licence v3.0, except where otherwise stated