API and integration catalogue

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

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

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

Retired

Data Registers Service - REST API

Access a wide range of live lists of lookup data with our Data Registers Service.

Reference data REST API Central Internet facing

In production

Digital Signature Service API

Generate an electronic signature using your NHS CIS2 Authenticator.

Outpatient Prescribing REST API Central Security Uses API platform Internet facing Uses OAS CIS2 authentication

In production

Directory of Healthcare Services (Service Search) API

Find information about NHS healthcare services, including lists of NHS organisation types, organisations, and coronavirus (COVID-19) walk-in sites.

Vaccination Reference data Patient-facing REST API Central Internet facing

In production

Directory of Services - Urgent and Emergency Care - REST API

Access information on a wide range of health and care services across England using our Directory of Services (DoS) Urgent and Emergency Care REST API.

Patient-facing GP / primary care NHS 111 Reference data REST API Central Internet facing Urgent and emergency care Uses OAS

In production

Directory of Services - Urgent and Emergency Care - SOAP API

Access information on a wide range of health and care services across England using our Directory of Services Urgent and Emergency Care SOAP API.

GP / primary care NHS 111 Urgent and emergency care Patient-facing Reference data SOAP API Central Internet facing

In production

e-Referral Service - FHIR API

Access the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care.

Hospital GP / primary care FHIR API Central STU3 Uses API platform Internet facing Has sandbox Uses OAS REST Referrals and bookings CIS2 authentication

Deprecated In production

e-Referral Service - FHIR API (HSCN)

Access the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care via HSCN only.

Hospital GP / primary care API Central FHIR STU3 DSTU2 Referrals and bookings