We have detected that you are using Internet Explorer to visit this website. Internet Explorer is now being phased out by Microsoft. As a result, NHS Digital no longer supports any version of Internet Explorer for our web-based products, as it involves considerable extra effort and expense, which cannot be justified from public funds. Some features on this site will not work. You should use a modern browser such as Edge, Chrome, Firefox, or Safari. If you have difficulty installing or accessing a different browser, contact your IT support team.
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.
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.
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 API standards
API standards to support transfer of care from hospital to social services for patients with care and support needs.
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 API standards
API standards to support the triage and onward referral of patients who are interacting with Urgent and Emergency Care services, such as NHS 111.
D
internal
Digital Child Health Event Messaging API standards
API standards to share information about a child's health between healthcare professionals.
internal
Digital Maternity API standards
API standards to enable sharing and updating of digital maternity records.
internal
Digital Medicine API standards
API standards for FHIR messages used to notify a patient's registered GP practice of care services provided by a pharmacy such as immunisation.
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 API standards
Use these API standards to share medication requests between 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.
internal
GP Connect - FHIR APIs
Share information between GP clinical systems and with other healthcare organisations using our GP Connect FHIR APIs.
H
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.
internal
NHS 111 API
Share information between NHS 111 and other organisations, such as GPs and ambulance services.
internal
NHS Booking - FHIR API
Search for free slots and book appointments with this API formerly known as NHS Scheduling.
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.
internal
NHS login API
Access multiple digital health and social care services with a single login for patients and the public, including authentication for returning users.
internal
NHS Syndicated Content - REST APIs
Pull content from the NHS.UK website about health conditions, health news, medicines A-Z and more, using our free NHS Syndicated Content APIs and widgets.
O
internal
Organisation Data Service - FHIR API
Access details of health and social care organisations using our Organisation Data Service (ODS) FHIR API.
internal
Organisation Data Service - ORD API
Access details of health and social care organisations using our Organisation Data Service (ODS) ORD API.
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.
internal
Personal Demographics Service - SMSP API
Access patients' personal information, such as name, address, date of birth and related people, using our SMSP 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 API standards
Use these API standards to create and transmit documents and messages containing Transfer of Care information.
V
internal
Vaccination Adverse Reactions COVID-19 API standards
API standards for the information you must provide to NHS Digital on adverse reactions relating to coronavirus (COVID-19) vaccinations.
internal
Vaccination API standards
API standards for the information you must provide to NHS Digital relating to coronavirus (COVID-19) and seasonal flu 2020-21 vaccinations.
Last edited: 15 January 2021 5:31 pm