API and integration catalogue

Deprecated

Clinical Document Architecture API standards

API standards to send and receive Clinical Document Architecture (CDA) messages and share information in a clinically safe way.

Messaging API standard

Internal In development

Connecting Party Manager API

Register and manage details of systems and applications that connect to our APIs.

Uses OAS Has sandbox REST Uses API platform

Internal Retired

COVID-19 Medical Exemptions - FHIR API

Access a patient’s coronavirus (COVID-19) medical exemption status.

Vaccination Patient-facing FHIR R4 REST Has sandbox API Central Uses API platform Internet facing Uses OAS

Deprecated

COVID-19 Test Results - FHIR API

Access a patient’s coronavirus (COVID-19) test results history.

Patient-facing FHIR REST API Central Tests and diagnostics Has sandbox R4 Uses API platform Internet facing Uses OAS

CPIS Unscheduled Care Event - API

PLACEHOLDER

Retired

Crisis Care Extract API

Send a CDA document containing Crisis Care Extract information supporting the sharing of care plans for urgent and emergency care.

Hospital GP / primary care Urgent and emergency care A&E / emergency department Key care information Continuity of care API Messaging

Custom Prescription Status Update API

Status updates are provided on prescription items to allow users of the NHS App and third-party app consumers to track the progress of their prescriptions and when they are ready to collect.

Dispensing Internet facing REST Has sandbox Uses API platform Uses OAS

In production Beta

Cyber Alerts - REST API

Access a feed of alerts issued by our cyber security centre.

REST Security Information governance API Central Internet facing