Skip to main content

API catalogue

First time here? Check out Getting Started with NHS Digital APIs.

These are the APIs which are currently available, or in development, from NHS Digital. It includes API services as well as API standards defined by us. 

25 results

Include retired APIs


C

COVID-19 Medical Exemptions - FHIR API

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

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

COVID-19 Test Results - FHIR API

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

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

Cyber Alerts - REST API

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

Information governance Security Internet facing REST API service Central

D

Data Registers Service - REST API

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

Reference data Internet facing REST API service Central

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 Urgent and Emergency Care REST API.

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

E

Electronic Prescription Service Directory of Services API

Access information about dispensing services, including searching for dispensers who can provide dispensing services for a patient with a given location and urgency, using our Electronic Prescription Service (EPS) Directory of Services (DoS) API.

Prescribing Dispensing Reference data Urgent and emergency care OOH GP Internet facing REST API service Central

Electronic Prescription Service - FHIR API

Access the Electronic Prescription Service (EPS) - the national service used to send electronic prescriptions from GP surgeries to pharmacies.

Prescribing Dispensing Outpatient Internet facing FHIR R4 REST Has sandbox Uses API platform API service Central

Electronic Prescription Service Tracker - REST API

Track a patient’s prescriptions using our Electronic Prescription Service (EPS) Tracker API.

Prescribing Pharmacy Internet facing REST API service Central

Electronic Transmission of Prescriptions Web Services - REST API

Get prescription dispenser information for a patient, using NHS UK Web Services.

Access to records Dispensing Reference data Community health Pharmacy GP / primary care Urgent and emergency care OOH GP Internet facing REST API service Central

F

FHIR Converter API

Convert FHIR resources from FHIR STU3 to FHIR R4 and vice versa.

Internet facing FHIR STU3 R4 REST Uses API platform API service Central

G

GP2GP Management Information MESH API

Provide information to NHS Digital on the progress of the patient migration process between GP practices (GP2GP).

Continuity of care GP / primary care Internet facing REST MESH API service Central

GP Registrations Management Information API

Send real-time management information about GP registrations to us at NHS Digital.

Continuity of care GP / primary care Internet facing REST Uses API platform API service Central

H

Health Research Data Catalogue API

Retrieve information suitable for publication in a health research data catalogue.

Access to records Key care information Internet facing REST Has sandbox Uses API platform API service Central

Hello World API

Teach yourself how to connect to our RESTful APIs.

Internet facing REST Has sandbox Uses API platform API service Central

I

Immunisation History - FHIR API

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

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

N

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.

Access to records Information governance Community health Hospital A&E / emergency department Inpatient Outpatient Mental health GP / primary care Social care Urgent and emergency care Ambulance services NHS 111 OOH GP Internet facing FHIR STU3 REST API service Central

NHS Syndicated Content - REST APIs

Pull content from the NHS.UK website about health conditions, health news, medicines A-Z and more, using our free NHS Syndicated Content APIs and widgets.

Patient Internet facing REST API service Central

O

Organisation Data Service - ORD API

Access the full dataset of health and social care organisations in England and Wales, such as trusts or GP practices, using our Organisation Data Service (ODS) ORD API.

Reference data Community health Dentistry Hospital A&E / emergency department Inpatient Outpatient Mental health Pharmacy GP / primary care Social care Urgent and emergency care Ambulance services NHS 111 OOH GP Internet facing REST SOAP API service Central

R

Reasonable Adjustment Flag - FHIR API

Access the Reasonable Adjustment Flag - a national record which indicates that a patient requires reasonable adjustments and includes relevant details.

Key care information Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Internet facing FHIR STU3 REST Has sandbox Uses API platform API service Central

S

Service Search API

Access the information about NHS services, including searching for and getting a lists of coronavirus (COVID 19) walk-in sites, organisation types and organisations.

Vaccination Reference data Patient Internet facing REST API service Central

Signing Service API

Generate an electronic signature using your smartcard.

Prescribing Security Outpatient Internet facing REST Uses API platform API service Central

Summary Care Record - FHIR API

Access patient's Summary Care Record (SCR), an electronic record of important patient information, using our FHIR API.

Access to records Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Internet facing FHIR R4 REST Has sandbox Uses API platform API service Central

T

Technology Reference Update Distribution API

Automate the download of TRUD release files, including classification products, NHS data model and dictionary, and terminology products.

Reference data Internet facing REST API service Central

Terminology Server - FHIR APIs

Retrieve terminologies and classifications from the NHS Digital Terminology Server, such as SNOMED-CT or ICD-10.

Reference data Internet facing FHIR R4 REST API service Central

U

Urgent and Emergency Care Continuous Quality Improvement API

Submit 111 or 999 call triage data for quality monitoring purposes, following an NHS Pathways patient phone assessment.

Continuity of care Urgent and emergency care NHS 111 Internet facing REST API service Central