Skip to main content

API catalogue

First time here? Check out Getting Started with our APIs.

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

18 results

Include retired APIs


A
Stable

Access Control Service HL7 V3 API

Manage patient consent to share their information, including their Summary Care Record (SCR), with the Access Control Service.

Access to records Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API service Central HL7 V3
Stable

Alerts - HL7 V3 API

Send an alert to a Privacy Officer so they can audit whether access to a patient’s data was appropriate.

Information governance Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API service Central HL7 V3 Has adaptor

D
Stable

Demographics Batch Service API

Submit a file of patient information to the Spine for tracing against the Personal Demographics Service (PDS).

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API service Central Internet facing
Stable

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 API service Central Internet facing REST
Stable

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.

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

F
Beta

Female Genital Mutilation - Information Sharing - FHIR API

Share female genital mutilation (FGM) information for children under 18 with relevant NHS professionals across England using our Female Genital Mutilation (FGM) Information Sharing FHIR API.

Key care information Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API service Central FHIR DSTU2

N
Beta Internal use only

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 API service Central Internet facing FHIR STU3 REST
Stable

NHS CIS2 Care Identity Authentication - API

Verify the identity of healthcare workers in England, such as NHS staff, when they access national clinical information systems, using the NHS Care Identity Service 2 (CIS2). 

Security Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 API service Central Internet facing

O
Stable

Organisation Data Service - FHIR API

Access a reduced dataset of health and social care organisations in England and Wales, such as trusts or GP practices, using our Organisation Data Service (ODS) FHIR 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 API service Central Internet facing FHIR STU3
Stable

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 API service Central Internet facing REST SOAP

P
Stable

Personal Demographics Service - FHIR API

Access patients' personal information, such as name, address, date of birth, related people, registered GP and NHS number using our FHIR version of the Personal Demographics Service (PDS) API.

Demographics Community health Hospital Mental health Patient Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API service Central Internet facing FHIR R4 Has sandbox Uses API platform Uses OAS
Stable Under review

Personal Demographics Service - HL7 V3 API

Access patients' personal information, such as name, address, date of birth, related people, registered GP and NHS number using our HL7 V3 version of the Personal Demographics Service (PDS) API.

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API service Central SOAP HL7 V3 Has adaptor
Deprecated

Personal Demographics Service - SMSP API

Access patients' personal information, such as name, address, date of birth, related people, registered GP and NHS number using our Spine Mini Service Provider (SMSP) API.

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API service Central

R
Alpha

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 API service Central Internet facing FHIR STU3 REST Has sandbox Uses API platform Uses OAS

S
Private beta

Spine Directory Service - FHIR API

Access accredited system information and messaging endpoint details in the Spine Directory Service (SDS) using our FHIR-conformant API.

Reference data Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 API service Central Internet facing FHIR R4 Has sandbox Uses API platform Uses OAS
Stable

Spine Directory Service - LDAP API

Access details of organisations, people and systems registered in the Spine Directory Service (SDS) using our LDAP API.

Reference data Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 API service Central
Alpha

Summary Care Record - FHIR API

Access a 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 API service Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS
Stable

Summary Care Record - HL7 V3 API

Access a patient's Summary Care Record (SCR) using our HL7 V3 API. Also previously known as PSIS query and GP summary.

Access to records Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API service Central HL7 V3 Has adaptor