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

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.

B

internal

Booking specification versions

The initial requirement is to find appointment Slots and create an Appointment in a free slot. The interactions in scope are: search Slot (a RESTful search) and create Appointment.

C

internal

Child Protection Information Sharing - HL7 V3 API

Information for developers - message definitions and interactions required to support the rollout of the Child Protection Information Sharing (CP-IS) system.

internal

Clinical Decision Support - FHIR API

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

D

external

Diagnostic Data Services - FHIR API

Exchange diagnostics service outputs securely and effectively from primary to secondary care with the Diagnostic Data Services (DDS).

external

Diagnostic Image Reporting

Spine-supported messaging that supports the requesting of diagnostic imaging procedures, Diagnostic Imaging department encounters, and diagnostic imaging reports in response to requests.

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.

external

Digital Maternity - FHIR API

Exchange of maternity records between different care providers which will mean that information from a record can be understood by all IT systems in use across the country, enabling the seamless exchange of information regardless of local maternity system boundary.

internal

Digital Medicine - FHIR API

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

external

Directory of Services

Retrieve service information about a wide range of health and care services in England with the Directory of Service (DoS) API.

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.

external

Electronic Prescription Service (EPS) Directory of Service (DoS) API

Access information about dispensing services, including search for dispensers by patient location and urgency of need.

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.

external

End Of Life - Clinical document architecture on FHIR

DEPRECATED: Transfer end-of-life documents between GP and palliative care systems

external

End Of Life - FHIR API

Transfer end-of-life records using the FHIR standard

external

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 from primary to secondary care using the e-Referral Service (e-RS) HL7 V3 API.

F

external

Female Genital Mutilation - FHIR API

Share information about Female Genital Mutilation (FGM) between relevant NHS professionals.

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

external

Hello World 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

external

Messaging Exchange for Social care and Health (MESH)

This component of the Spine allows messages and files to be delivered to registered recipients.

N

external

National Data Opt-out - FHIR API

The National Data Opt-out (NDOP) makes possibile to capture and control patient preferences for sharing of data by healthcare organisations.

external

National Early Warning Score (NEWS) 2 - FHIR API

Share a patient's National Early Warning Score (NEWS) 2 scores, sub-scores and associated vital signs between systems and across care boundaries, for example, between two hospitals, or between GP and ambulance systems.

external

National Events Management System

Allows patient-centric event messages including birth notifications, change of address, change of GP, death notifications, professional contacts, and vaccinations to be published from one system, and distributed between subscribers

internal

National Health Application and Infrastructure Services - NHAIS GP Links API

Manage GP registrations and other patient data in NHAIS.

external

National Pathology Messaging - FHIR API

The National Pathology Messaging supports the ability to share pathology results in NHS primary and secondary care settings.

external

National Population Failsafe Management - FHIR API

The National Population Failsafe Management (NPFM) fulfills the data item requirements to implement and manage national failsafe alerts.

external

National Record Locator - FHIR API

Locate and share patient records across the health and care system with the National Record Locator (NRL) 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 and more.

internal

NHS 111 HL7 V3 API

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

external

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/ORD API

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

external

Outpatients - HL7 V3 API

Spine-supported messaging that supports the communication of Outpatient reports.

P

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.

external

Prescription Tracker

The Prescription Tracker service provides a read only interface to obtain information about a patient’s prescriptions within the Electronic Prescription Service (EPS).

R

internal

Reasonable Adjustment Flag - FHIR API

Access patients' Reasonable Adjustments Flag, a national record which indicates that reasonable adjustments are required for an individual, with our FHIR API.

S

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.

U

external

Urgent & Emergency Care Appointment Booking - FHIR API

Use this API to connect to Urgent & Emergency Care (UEC) services to support booking from any to any accross care settings.

Last edited: 17 September 2020 1:36 pm