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 standards defined by us. If you're looking for other standards or reference materials, try our Developer A-Z

A

Alerts - HL7 V3 API

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

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Information Governance HL7 V3 API Service Central

C

Clinical Decision Support API standards

API standards to support the triage and onward referral of patients who are interacting with Urgent and Emergency Care services, such as NHS 111.

Hospital A&E / Emergency Department Patient GP / Primary Care Urgent And Emergency Care NHS 111 A&E / Emergency Department Clinical Decision Support FHIR REST API Standard

D

Demographics Batch Service API

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

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Demographics API Service Central

Directory of Services - REST API

Access information on a wide range of health and care services across England using our Directory of Services REST API.

Patient GP / Primary Care Urgent And Emergency Care NHS 111 Reference Data REST API Service Central

Directory of Services - SOAP API

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

Patient GP / Primary Care Urgent And Emergency Care NHS 111 Reference Data SOAP API Service Central

E

End of Life API standards

API standards to enable sharing and updating of digital end of life care (EoLC) records.

Community health Hospital GP / Primary Care Social Care Urgent And Emergency Care Ambulance Services NHS 111 Access to Records FHIR API Standard

F

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.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Key Care Information FHIR API Service Central

G

GP Connect Access Document - FHIR API

Retrieve unstructured documents from a patient’s GP practice record.

Hospital A&E / Emergency Department Inpatient Outpatient GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department Access to Records Continuity of Care (ToC) FHIR REST API Service Intermediary

GP Connect Access Record HTML - FHIR API

View a patient's GP practice record, with read-only access.

Hospital A&E / Emergency Department Inpatient Outpatient GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department Access to Records Continuity of Care (ToC) FHIR REST API Service Intermediary

GP Connect Access Record Structured - FHIR API

Retrieve structured information from a patient’s GP practice record.

Hospital A&E / Emergency Department Inpatient Outpatient GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department Access to Records Continuity of Care (ToC) FHIR REST API Service Intermediary

GP Connect Appointment Management - FHIR API

Manage GP practice appointments between different systems.

Hospital A&E / Emergency Department Inpatient Outpatient GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department Appointment / Scheduling Continuity of Care (ToC) FHIR REST API Service Intermediary

GP Connect Send Document - FHIR API

Send a PDF consultation summary to a registered GP practice.

Hospital A&E / Emergency Department Inpatient Outpatient GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department Continuity of Care (ToC) FHIR MESH API Service Intermediary

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.

Community health Hospital A&E / Emergency Department Inpatient Outpatient Mental Health GP / Primary Care Social Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department OOH GP Access to Records Information Governance FHIR REST API Service Central

NHS 111 API standard

API standard to share information between NHS 111 and other organisations, such as GPs and ambulance services, and query the Repeat Caller Service.

Hospital A&E / Emergency Department GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department SOAP HL7 V3 API Standard

NHS Booking - FHIR API

Search for free slots and book appointments with this API formerly known as FHIR NHS Scheduling API

Urgent And Emergency Care NHS 111 Appointment / Scheduling FHIR API Service Intermediary

NHS Care Identity Service 2 API

Verify the identity of healthcare workers in England, such as NHS staff, when they access national clinical information systems.

Hospital GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 Security API Service Central

O

Organisation Data Service - FHIR API

Access details of health and social care organisations using our Organisation Data Service (ODS) FHIR API.

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 A&E / Emergency Department OOH GP Reference Data FHIR API Service Central

Organisation Data Service - ORD API

Access details of health and social care organisations using our Organisation Data Service (ODS) ORD API.

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 A&E / Emergency Department OOH GP Reference Data REST SOAP API Service Central

P

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.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Demographics FHIR Sandbox API Service Central

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.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Demographics SOAP HL7 V3 API Service Central

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 SMSP API.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Demographics 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.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Key Care Information FHIR REST Sandbox API Service Central

S

Spine Directory Service - FHIR API

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

Hospital GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 Reference Data FHIR Sandbox API Service Central

Spine Directory Service - LDAP API

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

Hospital GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 Reference Data 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.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Access to Records FHIR REST Sandbox API Service Central

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.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Access to Records HL7 V3 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.

Urgent And Emergency Care NHS 111 Continuity of Care (ToC) REST API Service Central