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

external

Ambulance Domain Message Specification

Spine-supported Ambulance messaging.

internal

Assessment discharge and withdrawal - developer resource

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 - Domain Message Specification

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 API

Learn how to build standard APIs for Clinical Decision Support Systems.

external

Clinical document architecture - document header

Generic document header FHIR specification

external

Clinical document architecture - end-of-life

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

D

external

Diagnostic data services

Pass pathology messages securely and effectively

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 Specification Versions

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

Exchange of maternity records between different care providers

internal

Digital medicine specification versions

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

external

Discharge Domain Message Specification

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

E

internal

Electronic Prescription Service - HL7 V3 API

Access the Electronic Prescription Service to send prescriptions from GP surgeries to pharmacies using our HL7 V3 API.

external

Electronic prescription tracker

Read-only interface to track information about a patient's prescription

external

Emergency Department Domain Message Specification

Spine-supported messaging that supports the communication of Emergency Department reports.

external

End-of-life (FHIR)

Transfer end-of-life records using the FHIR standard

internal

ePMA API

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

external

e-Referral Service - FHIR API

Make referrals from primary to secondary care using our FHIR API.

internal

e-Referral Service - HL7 V3 API

Receive referrals for secondary care using our HL7 V3 API.

F

external

Female genital mutilation

Share risk information about female genital mutilation between relevant NHS professionals.

G

external

GP connect API

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

H

external

Hello World API

Use this API alongside our tutorials to learn how to connect to our APIs.

L

internal

Legitimate Relationship Service - HL7 V3 API

Access patients' legitimate relationships using our HL7 V3 API.

M

external

Mental Health Domain Message Specification

Spine-supported Mental Health-related messaging.

external

Messaging exchange for social care and health (MESH)

Exchange messages and files between providers

N

external

National data opt-out

Capture patient preferences for sharing of data by healthcare organisations

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

external

National pathology FHIR messaging

Share pathology results in NHS primary and secondary care settings

external

National population failsafe management

Implement national failsafe alerts

external

National record locator

Locate and share patient records across the health and care system

internal

NHAIS GP Links API

Manage GP registrations and other patient data in NHAIS.

external

NHS.UK content syndication APIs

Use our APIs and widgets to syndicate official NHS information about conditions, health news, medicines, and more.

external

NHS 111 Domain Message Specification

Spine-supported NHS 111-related messaging.

internal

NHS Identity: Guidance for developers

Find developer information for NHS Identity, including services offered and how to integrate and use NHS Identity, along with other help and support.

O

external

Organisation data service (FHIR/ORD)

Lookup NHS organisation reference data, using a FHIR or ORD interface

external

Outpatients Domain Message Specification

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

P

external

Personal Demographics Service - FHIR API

Access patients' personal information, such as name, date of birth and address, using our FHIR-compliant RESTful API.

internal

Personal Demographics Service - HL7 V3 API

Access patients' personal information, such as name, date of birth and address using our HL7 V3 API.

external

Personal Demographics Service - SMSP API

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

R

internal

Reasonable Adjustments - FHIR API

Access patients' reasonable adjustments flag.

S

external

Scheduling

Search for free slots and book appointments through NHS scheduling

internal

Spine Directory Service - LDAP API

Access data in the Spine Directory Service using our LDAP API.

internal

Summary Care Record - FHIR API

Access patients' summary care records using our FHIR API.

internal

Summary Care Record - HL7 V3 API

Access patients' summary care records using our HL7 V3 API.

T

internal

Transfer of Care specification versions

This page contains the new and previous Transfer of Care specifications.

Last edited: 10 July 2020 10:39 am