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.
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 IntermediaryC
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
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.
Hospital A&E / Emergency Department Patient / Citizen GP / Primary Care Urgent And Emergency Care NHS 111 A&E / Emergency Department Clinical Decision Support FHIR REST API StandardD
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
internal
Digital Child Health - FHIR API
Share information about a child's health between healthcare professionals.
Hospital A&E / Emergency Department Inpatient Mental Health GP / Primary Care Urgent And Emergency Care A&E / Emergency Department Continuity of Care (ToC) FHIR MESH API Service Intermediary
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.
Patient / Citizen GP / Primary Care Urgent And Emergency Care NHS 111 Reference Data REST API Service Central
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.
Patient / Citizen GP / Primary Care Urgent And Emergency Care NHS 111 Reference Data SOAP API Service CentralE
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.
Hospital A&E / Emergency Department Inpatient GP / Primary Care Urgent And Emergency Care A&E / Emergency Department Prescribing Dispensing FHIR API Standard
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.
Urgent And Emergency Care OOH GP Prescribing Dispensing Reference Data REST API Service Central
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.
Community health A&E / Emergency Department GP / Primary Care Urgent And Emergency Care A&E / Emergency Department OOH GP Prescribing Dispensing HL7 V3 API Service Central
internal
Electronic Transmission of Prescriptions Web Services - SOAP API
Access the NHS UK Web Services to retrieve dispensaries information for a patient
Community health Pharmacy GP / Primary Care Urgent And Emergency Care OOH GP Access to Records Dispensing Reference Data SOAP API Service Central
internal
Emergency Department - HL7 V3 API
Send an emergency department report following discharge or transfer of responsibility for a patient.
Hospital A&E / Emergency Department GP / Primary Care Urgent And Emergency Care A&E / Emergency Department Continuity of Care (ToC) HL7 V3 API Service Intermediary
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 StandardF
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 CentralG
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 IntermediaryN
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
National Population Failsafe Management - FHIR API
Raise failsafe alerts about children with the National Population Failsafe Management (NPFM) FHIR API.
Hospital A&E / Emergency Department Inpatient Mental Health GP / Primary Care Urgent And Emergency Care A&E / Emergency Department Continuity of Care (ToC) Key Care Information FHIR API Service Intermediary
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 Booking - FHIR API
Search for free slots and book appointments with this API formerly known as FHIR NHS Scheduling API
Urgent And Emergency Care NHS 111 Appointment / Scheduling FHIR 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 CentralO
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 CentralP
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 Notifications - FHIR API
Receive notifications about changes to a patient's demographic details, including birth, death, change of address and change of GP.
Hospital A&E / Emergency Department Inpatient Mental Health GP / Primary Care Urgent And Emergency Care A&E / Emergency Department Continuity of Care (ToC) Demographics FHIR MESH API Service Intermediary
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 CentralR
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 CentralS
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 CentralT
internal
Transfer of Care Emergency Care Discharge - FHIR API
Create and transmit documents containing Transfer of Care information supporting an emergency care discharge.
Hospital A&E / Emergency Department GP / Primary Care Urgent And Emergency Care A&E / Emergency Department Continuity of Care (ToC) FHIR MESH API Service Intermediary
Last edited: 30 March 2021 11:47 am