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

26 results

Include retired APIs


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.

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

C

Child Protection - Information Sharing - HL7 V3 API

Access child protection information from Child Protection - Information Sharing (CP-IS) as a local authority or an unscheduled care provider using our HL7 V3 API.

Access to Records Key Care Information Community health Hospital A&E / Emergency Department Inpatient Social Care Urgent And Emergency Care Ambulance Services OOH GP HL7 V3 Has adaptor API Service Central

Child Protection - Information Sharing - SMSP API standards

Become a Spine Mini Service Provider giving access to child protection information from Child Protection - Information Sharing (CP-IS) for an unscheduled care provider using our SMSP API standards.

Access to Records Key Care Information Community health Hospital A&E / Emergency Department Inpatient Social Care Urgent And Emergency Care Ambulance Services OOH GP HL7 V3 API Standard

D

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

Digital Maternity API standards

API standards to enable sharing and updating of digital maternity records.

Access to Records Continuity of Care (ToC) Community health Hospital Maternity GP / Primary Care FHIR STU3 API Standard

Dose Syntax API standards

API standards to provide a structured way to record dosage instructions between primary and secondary care settings.

Continuity of Care (ToC) Prescribing Dispensing Community health Hospital GP / Primary Care FHIR STU3 API Standard

E

Electronic Prescription Service - HL7 V3 API

Access the Electronic Prescription Service (EPS) to send prescriptions from prescribers such as GPs to dispensers such as pharmacies using our HL7 V3 API.

Prescribing Dispensing Community health A&E / Emergency Department GP / Primary Care Urgent And Emergency Care OOH GP HL7 V3 Has adaptor API Service Central

Electronic Transmission of Prescriptions Web Services - SOAP 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 SOAP API Service Central

End of Life API standards

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

Access to Records Community health Hospital GP / Primary Care Social Care Urgent And Emergency Care Ambulance Services NHS 111 FHIR STU3 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.

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

Female Genital Mutilation - Information Sharing - SMSP API standards

Become a Spine Mini Service Provider giving access to female genital mutilation (FGM) information for children under 18 to relevant NHS professionals across England, using our Female Genital Mutilation - Information Sharing (FGM-IS) SMSP API standards.

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

G

General Practice Extraction Service - MESH API

Send anonymised or patient-identifiable data from GP clinical systems to the General Practice Extraction Service (GPES) for planning and research.

Access to Records Key Care Information Community health MESH 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 FHIR STU3 REST API Service Central

O

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 FHIR STU3 API Service Central

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

Demographics Community health Hospital Mental Health Patient Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP FHIR R4 Has sandbox Uses API platform 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.

Demographics Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP SOAP HL7 V3 Has adaptor API Service Central
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

Personal Demographics Service - SMSP API standards

Become a Spine Mini Service Provider giving access to 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 standards.

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

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 FHIR STU3 REST Has sandbox Uses API platform API Service Central

S

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 FHIR R4 REST Has sandbox Uses API platform 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.

Access to Records Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP HL7 V3 Has adaptor API Service Central

Summary Care Record - SMSP API standards

Become a Spine Mini Service Provider giving access to a patient's Summary Care Record using our SMSP API standards.

Access to Records Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP HL7 V3 API Standard

V

Vaccination Adverse Reactions COVID-19 API

Provide information to NHS Digital on adverse reactions relating to coronavirus (COVID-19) vaccinations.

Vaccination Community health GP / Primary Care MESH API Service Intermediary

Vaccination APIs

Provide information to NHS Digital relating to coronavirus (COVID-19) and seasonal flu 2021-22 vaccinations.

Appointment / Scheduling Vaccination Community health GP / Primary Care MESH API Service Intermediary

Vaccination Events - FHIR API

Publish or receive messages about changes to a patient's vaccination details.

Continuity of Care (ToC) Vaccination Community health Hospital Inpatient Outpatient GP / Primary Care FHIR STU3 MESH NEMS API Service Intermediary