Skip to main content

API catalogue

These are the APIs which are currently available, or in development, from NHS Digital. If you're looking for API standards, or other reference materials, try our Developer A-Z

Refine results

A

internal

Alerts - HL7 V3 API

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

internal

Ambulance Analytics - FHIR API

Submit ambulance call centre data to the Data Processing Service (DPS) for analysis and review by NHS England and local ambulance trusts.

internal

Ambulance Messaging - HL7 V3 API

Ambulance Messaging supports the Ambulance Service Summary Patient Report containing a summary of care events and care data.

internal

Assessment Discharge and Withdrawal - FHIR API

The Assessment Discharge and Withdrawal (ADW) specification defines a number of messages to support the exchange of structured information between healthcare and social care organisations.

C

internal

Child Protection - Information Sharing - HL7 V3 API

Access child protection information from Child Protection - Information Sharing (CP-IS) using our HL7 V3 API.

internal

Clinical Decision Support - FHIR API

The Clinical Decision Support (CDS) improves the flow of information through the urgent and emergency care system.

D

internal

Digital Child Health - FHIR API

The Child Health Events contain information meaningful to those managing the personal health of themselves or their families, professionals providing direct care to children and young people and those managing the health of populations.

internal

Digital Maternity API standards

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

internal

Digital Medicine - FHIR API

The digital medicines specification supports FHIR messages to support pharmacy information flows.

internal

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.

internal

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.

internal

Discharge - HL7 V3 API

Send a discharge report following transfer of responsibility for a patient.

E

internal

Electronic Prescribing and Medicines Administration - FHIR API

Share medication requests between electronic hospital patient medicines administration (ePMA) systems and hospital pharmacy or stock control systems.

internal

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.

internal

Electronic Prescription Service - FHIR API

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

internal

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.

internal

Electronic Prescription Service Tracker - REST API

Track a patient’s prescriptions within the Electronic Prescription Service (EPS).

internal

Emergency Department - HL7 V3 API

Send an emergency department report following discharge or transfer of responsibility for a patient.

internal

End of Life API standards

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

internal

e-Referral Service - FHIR API

Create paperless referrals from primary to secondary care using the e-Referral Service (e-RS) FHIR API.

internal

e-Referral Service - HL7 V3 API

Create paperless referrals or manage appointment slots in secondary care using the e-Referral Service (e-RS) HL7 V3 API.

F

internal

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.

G

internal

GP2GP - HL7 V3 API

Transfer patients' electronic health records, securely and quickly, between their old and new practices when they change GPs.

external

GP Connect - FHIR API

Share information between GP practices and authorised clinical staff, quickly and efficiently

H

internal

Hello World REST API

Teach yourself how to connect to our RESTful APIs.

L

internal

Legitimate Relationship Service - HL7 V3 API

Access patients' Legitimate Relationships (LR) using our HL7 V3 API.

M

internal

Message Exchange for Social Care and Health (MESH) API

The Message Exchange for Social Care and Health (MESH) is the main secure large file transfer service used across health and social care organisations.

N

internal

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.

internal

National Early Warning Score 2 API standards

API standards to enable sharing of patients' vital signs and NEWS2 scores between systems and across care boundaries, for example, between two hospitals.

internal

National Event Management Service - FHIR API

Publish and subscribe to patient-centric event messages with the National Events Management Service (NEMS).

internal

National Health Application and Infrastructure Services - NHAIS GP Links API

Manage GP registrations and other patient data in NHAIS.

internal

National Population Failsafe Management - FHIR API

Raise failsafe alerts about children with the National Population Failsafe Management (NPFM) FHIR API.

internal

National Record Locator - FHIR API

Locate and access patient information shared by other healthcare organisations using the National Record Locator (NRL) FHIR API.

external

NHS.UK website content syndication APIs

Use our APIs and widgets to syndicate information from the NHS.UK website about conditions, health news, medicines A-Z and more.

internal

NHS 111 HL7 V3 API

Point-to-point messages for interacting with NHS 111.

internal

NHS App API

Engage with users of the NHS App.

internal

NHS Booking - FHIR API

Search for free slots and book appointments through NHS Booking

internal

NHS Identity: guidance for developers

Guidance for developers wanting to use NHS Identity and OpenID Connect 1.0 to verify the identity of users and obtain basic profile information 

O

external

Organisation Data Service - FHIR API

The Organisation Data Service (ODS) API Suite provides a searchable national repository of NHS Organisation Reference Data using a FHIR interface.

external

Organisation Data Service - ORD API

The Organisation Data Service (ODS) API Suite provides a searchable national repository of NHS Organisation Reference Data using an ORD interface.

internal

Outpatients - HL7 V3 API

Access an outpatient report.

P

internal

Pathology API standards

API standards to enable the exchange of Pathology data between systems.

internal

Personal Demographics Service - FHIR API

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

internal

Personal Demographics Service - HL7 V3 API

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

external

Personal Demographics Service - SMSP API

Access patients' personal information, such as name, address, date of birth and related people using our Spine Mini Service Provider (SMSP) version of the Personal Demographics Service (PDS) API.

R

internal

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.

S

internal

Spine Directory Service - FHIR API

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

internal

Spine Directory Service - LDAP API

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

internal

Summary Care Record - FHIR API

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

internal

Summary Care Record - HL7 V3 API

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

T

internal

Transfer of Care - FHIR API

The Transfer Of Care (TOC) specifications contain new and previous versions of Acute Inpatient Discharge, Emergency Care Discharge, Mental Health Discharge, Outpatient Clinic Letter.

Last edited: 2 December 2020 10:13 am