In production

Ambulance Data Submission - FHIR API

Submit ambulance data to our Data Processing Service (DPS) for analysis and review by NHS England and ambulance trusts, using our Ambulance Data Submission - FHIR API (formerly Ambulance Analytics).

Urgent and emergency care Ambulance services API Central Internet facing FHIR R4 REST MESH Has sandbox Uses API platform Uses OAS

---

In production Deprecated

Assessment Discharge and Withdrawal - FHIR

Support transfer of care from hospital to social services for patients with care and support needs.

Continuity of care Hospital Inpatient Social care Message integration Internet facing FHIR DSTU2 MESH

In production

Booking and Referral - FHIR API

Send booking and referral information between NHS service providers using our Booking and Referral FHIR API.

Referrals and bookings A&E / emergency department Ambulance services NHS 111 API Intermediary Internet facing FHIR R4 REST Uses API platform Uses OAS Uses digital onboarding

Draft

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.

Clinical decision support Hospital A&E / emergency department Patient-facing GP / primary care Urgent and emergency care NHS 111 API standard FHIR STU3 REST

In production

Demographics Batch Service

Submit a file of patient information to the Spine for tracing against the Personal Demographics Service (PDS).

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Central Message integration Internet facing

---

In production

Digital Child Health - FHIR

Share information about a child's health between healthcare workers.

Continuity of care Hospital A&E / emergency department Inpatient Mental health GP / primary care Urgent and emergency care Publish-subscribe events Internet facing FHIR STU3 MESH NEMS

---

In development

Digital Signature Service API

Generate an electronic signature using your NHS CIS2 Authenticator.

Prescribing Security Outpatient API Central Internet facing REST Uses API platform Uses OAS

---

In production

Directory of Services - Urgent and Emergency Care - REST API

Access information on a wide range of health and care services across England using our Directory of Services Urgent and Emergency Care REST API.

Reference data Patient-facing GP / primary care Urgent and emergency care NHS 111 API Central Internet facing REST

---

In production

Directory of Services - Urgent and Emergency Care - SOAP API

Access information on a wide range of health and care services across England using our Directory of Services Urgent and Emergency Care SOAP API.

Reference data Patient-facing GP / primary care Urgent and emergency care NHS 111 API Central Internet facing SOAP

In production Under review for deprecation

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.

Prescribing Dispensing Reference data Urgent and emergency care OOH GP API Central Internet facing REST

---

In production

Electronic Prescription Service - FHIR API

Access the Electronic Prescription Service (EPS) - the national service used to send electronic prescriptions from GP surgeries to pharmacies.

Prescribing Dispensing Outpatient GP / primary care API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS

---

Retired

Electronic Transmission of Prescriptions Web Services - REST API

Get prescription dispenser information for a patient, using NHS UK Web Services.

Access to records Dispensing Reference data Community health Pharmacy GP / primary care Urgent and emergency care OOH GP API Central Internet facing REST

---

In production Under review for deprecation

Electronic Transmission of Prescriptions Web Services - SOAP API

Get prescription dispenser information for a patient, using NHS UK Web Services.

Access to records Dispensing Reference data Community health Pharmacy GP / primary care Urgent and emergency care OOH GP API Central Internet facing SOAP

In development Internal

GP Connect (Patient Facing) Access Record - FHIR API

Access a patient's GP records.

Access to records Continuity of care Patient-facing Pharmacy GP / primary care OOH GP API Intermediary Internet facing FHIR STU3 REST Uses OAS

---

Beta In production

GP Connect Access Document - FHIR API

Retrieve unstructured documents from a patient’s GP practice record.

Access to records Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 API Intermediary FHIR STU3 REST

---

In production

GP Connect Access Record: HTML - FHIR API

View a patient's GP practice record, with read-only access.

Access to records Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 API Intermediary FHIR DSTU2 REST

---

In production

GP Connect Access Record: Structured - FHIR API

Retrieve structured information from a patient's GP practice record.

Access to records Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 API Intermediary FHIR STU3 REST

---

In production

GP Connect Appointment Management - FHIR API

Manage GP practice appointments between different systems.

Continuity of care Referrals and bookings Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Intermediary FHIR STU3 REST

---

In production

GP Connect Send Document - FHIR

Send a PDF consultation summary to a registered GP practice.

Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Message integration Internet facing FHIR STU3 MESH

In production

National Care Records Service integration

Integrate point-of-care applications with the National Care Records Service (NCRS) to quickly and easily view patient records.

Access to records Demographics Key care information Community health Dentistry Hospital A&E / emergency department Inpatient Outpatient Maternity Mental health Patient-facing Pharmacy GP / primary care Transport / infrastructure Social care Urgent and emergency care Ambulance services NHS 111 OOH GP UI integration Internet facing

---

Beta In production 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.

Access to records Information governance Community health Hospital A&E / emergency department Inpatient Outpatient Mental health GP / primary care Social care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing FHIR STU3 REST

---

Retired

National Population Failsafe Management - FHIR API

Raise failsafe alerts about children with the National Population Failsafe Management (NPFM) FHIR API.

Continuity of care Key care information Hospital A&E / emergency department Inpatient Mental health GP / primary care Urgent and emergency care API Intermediary Internet facing FHIR

---

In production Deprecated

NHS Booking - FHIR API

Search for free slots and book appointments with this API formerly known as FHIR NHS Scheduling API

Referrals and bookings Urgent and emergency care NHS 111 API Intermediary Internet facing FHIR STU3

---

In production

NHS CIS2 Care Identity Authentication

Verify the identity of healthcare workers in England, such as NHS staff, using the NHS Care Identity Service 2 (CIS2). CIS2 uses the OpenID Connect (OIDC) standard to provide single sign-on across local and national digital services using smartcards or modern alternatives.

Security Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 API Central UI integration Internet facing Uses digital onboarding

In production

Organisation Data Service - FHIR API

Access a reduced dataset of health and social care organisations in England and Wales, such as trusts or GP practices, using our Organisation Data Service (ODS) FHIR API. 

Community health Dentistry Hospital A&E / emergency department Outpatient Mental health Pharmacy GP / primary care Social care Ambulance services NHS 111 OOH GP API FHIR STU3 REST Uses OAS

---

In production

Organisation Data Service - ORD API

Access the full dataset of health and social care organisations in England and Wales, such as trusts or GP practices, using our Organisation Data Service (ODS) Organisation Reference Data (ORD) API. 

Reference data Community health Dentistry Hospital A&E / emergency department Inpatient Outpatient Mental health Pharmacy GP / primary care Social care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing REST SOAP

---

In production Deprecated

Out Of Hours

Send details of an out of hours (OOH) assessment from an out of hours GP system to the patient's registered GP.

Continuity of care GP / primary care Urgent and emergency care NHS 111 Message integration Internet facing MESH

In production

Personal Demographics Service - FHIR API

Access patients' personal information, such as name, address, date of birth, related people, registered GP, nominated pharmacy and NHS number using the FHIR version of the Personal Demographics Service (PDS) API.

Demographics Community health Hospital Mental health Patient-facing Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

---

In production

Personal Demographics Service MESH

Search the Personal Demographics Service (PDS) for patient details using the MESH UI. Formerly known as Master Patient Trace.

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Central Message integration Internet facing

---

In production

Personal Demographics Service Notifications - FHIR

Receive notifications about changes to a patient's demographic details, including record change, birth, death, change of address and change of GP.

Continuity of care Demographics Hospital A&E / emergency department Inpatient Mental health GP / primary care Urgent and emergency care Publish-subscribe events Internet facing FHIR STU3 MESH NEMS

Retired

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.

Key care information Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing FHIR STU3 REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

Beta In production

Spine Directory Service - FHIR API

Access accredited system information and messaging endpoint details in the Spine Directory Service (SDS) using our FHIR-conformant API.

Reference data Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS

---

Beta In production

Summary Care Record - FHIR API

Access a patient's Summary Care Record (SCR), an electronic record of important patient information, using our FHIR API.

Access to records Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

In production

Transfer of Care Emergency Care Discharge - FHIR

Send discharge information from an emergency care provider to a GP practice.

Continuity of care Hospital A&E / emergency department GP / primary care Urgent and emergency care Message integration Internet facing FHIR STU3 MESH

---

In production

Transfer of Care Outpatient Clinic Letter - FHIR

Create and transmit documents containing Transfer of Care information following an outpatient consultation in a clinic.

Continuity of care Hospital Outpatient GP / primary care Message integration Internet facing FHIR STU3 MESH

---

Deprecated

Transfer of Care - pre-FHIR

Send transfer of care information from acute trusts to a GP practice using deprecated legacy pre-FHIR workflows.

Continuity of care GP / primary care Urgent and emergency care NHS 111 Message integration Internet facing MESH

In production

Urgent and Emergency Care Continuous Quality Improvement API

Submit 111 or 999 call triage data for quality monitoring purposes, following an NHS Pathways patient phone assessment.

Continuity of care Urgent and emergency care NHS 111 API Central Internet facing REST

In production

Vaccination Events - FHIR

Publish or receive messages about changes to a patient's vaccination details.

Continuity of care Vaccination Community health Hospital Inpatient Outpatient GP / primary care Publish-subscribe events Internet facing FHIR STU3 MESH NEMS