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

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.

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

Ambulance Analytics - FHIR API

Submit ambulance analytics data to our Data Processing Service (DPS) for analysis and review by NHS England and ambulance trusts.

Urgent And Emergency Care Ambulance FHIR MESH API Service Central
internal

Ambulance Messaging - HL7 V3 API

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

Urgent And Emergency Care Ambulance Appointment / Scheduling HL7 V3 API Service Intermediary

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.

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

D

internal

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 NHS 111 OOH GP Demographics API Service Central

E

internal

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 NHS 111 Access to Records FHIR API Standard

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.

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

G

internal

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 NHS 111 A&E / Emergency Department Access to Records Continuity of Care (ToC) FHIR REST API Service Intermediary
internal

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 NHS 111 A&E / Emergency Department Access to Records Continuity of Care (ToC) FHIR REST API Service Intermediary
internal

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 NHS 111 A&E / Emergency Department Access to Records Continuity of Care (ToC) FHIR REST API Service Intermediary
internal

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 NHS 111 A&E / Emergency Department Appointment / Scheduling Continuity of Care (ToC) FHIR REST API Service Intermediary
internal

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 NHS 111 A&E / Emergency Department Continuity of Care (ToC) FHIR REST MESH API Service Intermediary

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.

Community health Hospital A&E / Emergency Department Inpatient Outpatient Mental Health GP / Primary Care Social Care Urgent And Emergency Care Ambulance NHS 111 A&E / Emergency Department OOH GP Access to Records Information Governance FHIR MESH API Service Central
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.

Hospital A&E / Emergency Department Inpatient GP / Primary Care Urgent And Emergency Care Ambulance A&E / Emergency Department Access to Records Continuity of Care (ToC) FHIR API Standard
internal

NHS 111 API

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 NHS 111 A&E / Emergency Department SOAP HL7 V3 MESH API Service Intermediary
internal

NHS Identity API

Verify the identity of health and care professionals in England, such as NHS staff, when they access national clinical information systems.

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

O

internal

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

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

P

internal

Personal Demographics Service - FHIR API

Access patients' personal information, such as name, address, date of birth, related people 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 NHS 111 OOH GP Demographics FHIR API Service Central
internal

Personal Demographics Service - HL7 V3 API

Access patients' personal information, such as name, address, date of birth, related people 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 NHS 111 OOH GP Demographics SOAP HL7 V3 API Service Central
internal

Personal Demographics Service - SMSP API

Access patients' personal information, such as name, address, date of birth, related people and NHS number using our SMSP API.

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

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.

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

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.

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

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 NHS 111 Reference Data API Service Central
internal

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 NHS 111 OOH GP Access to Records FHIR REST API Service Central
internal

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 NHS 111 OOH GP Access to Records HL7 V3 API Service Central
Last edited: 30 March 2021 11:47 am