In production Under review for deprecation

Access Control Service HL7 V3 API

Manage patient consent to share their information, including their Summary Care Record (SCR), with the Access Control Service.

Access to records Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central HL7 V3

---

In production

Alerts - HL7 V3 API

Send an alert to a Privacy Officer so they can audit whether access to a patient’s data was appropriate.

Information governance Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central HL7 V3 Has adaptor

---

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

---

Retired

Ambulance Messaging - HL7 V3

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

Referrals and bookings Urgent and emergency care Ambulance services Message integration HL7 V3

---

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

In production

Child Protection - Information Sharing - HL7 V3 API

Access child protection information from Child Protection - Information Sharing (CP-IS) from a healthcare setting.

Access to records Key care information Community health Hospital A&E / emergency department Inpatient Social care Urgent and emergency care Ambulance services OOH GP API Central HL7 V3 MESH Has adaptor Uses digital onboarding

---

In production

Child Protection - Information Sharing - MESH

Share information with Child Protection - Information Sharing (CP-IS) as a local authority.

Access to records Key care information Social care MESH

---

Active

Child Protection - Information Sharing - SMSP API standards

Become a Spine Mini Service Provider giving access to child protection information from Child Protection - Information Sharing (CP-IS) for an unscheduled care provider using our SMSP API standards.

Access to records Key care information Community health Hospital A&E / emergency department Inpatient Social care Urgent and emergency care Ambulance services OOH GP API standard HL7 V3

---

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

---

Retired

Crisis Care Extract API

Send a CDA document containing Crisis Care Extract information supporting the sharing of care plans for urgent and emergency care.

Continuity of care Key care information Messaging Hospital A&E / emergency department GP / primary care Urgent and emergency care API

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 production Deprecated

Digital Medicine - FHIR

Notify a patient's registered GP practice about care services delivered at a pharmacy, such as an immunisation.

Continuity of care Dispensing Vaccination Pharmacy GP / primary care Message integration Internet facing FHIR STU3 MESH

---

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

Draft

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.

Prescribing Dispensing Hospital A&E / emergency department Inpatient GP / primary care Urgent and emergency care API standard FHIR STU3

---

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

---

In production Deprecated

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. This is now deprecated.

Prescribing Dispensing Community health A&E / emergency department GP / primary care Urgent and emergency care OOH GP API Central HL7 V3 Has adaptor

---

Beta In production

Electronic Prescription Service Tracker - REST API

Track a patient’s prescriptions using our Electronic Prescription Service (EPS) Tracker API.

Prescribing Pharmacy API Central Internet facing REST

---

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

---

Retired

Emergency Department - HL7 V3

Send an emergency department report following discharge or transfer of responsibility for a patient.

Continuity of care Hospital A&E / emergency department GP / primary care Urgent and emergency care Message integration HL7 V3

---

Draft

End of Life API standards

API standards to enable sharing and updating of digital end of life care (EoLC) records.

Access to records Community health Hospital GP / primary care Social care Urgent and emergency care Ambulance services NHS 111 API standard FHIR STU3

In production Deprecated

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.

Key care information Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central FHIR DSTU2

---

Deprecated

Female Genital Mutilation - Information Sharing - SMSP API standards

Become a Spine Mini Service Provider giving access to female genital mutilation (FGM) information for children under 18 to relevant NHS professionals across England, using our Female Genital Mutilation - Information Sharing (FGM-IS) SMSP API standards.

Key care information Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API standard FHIR DSTU2

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

---

Beta In production

GP Connect Update Record

Use this integration to update a patient's GP record from a community pharmacy with structured data.

Continuity of care Pharmacy Message integration Internet facing FHIR STU3 MESH

Retired

Health Protection Electronic Notification API

Inform Public Health England (PHE) that a notifiable disease has been diagnosed in a patient, using our Health Protection Electronic Notification (HPEN) API. Includes PHE's response message.

Messaging Information governance Tests and diagnostics Community health Hospital A&E / emergency department GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API

Active

Interface Mechanism 1 API standards

API standards to support the integration of your systems with any principal clinical GP system using IM1.

Access to records Hospital A&E / emergency department Patient-facing GP / primary care Urgent and emergency care API standard

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

---

Draft

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.

Access to records Continuity of care Hospital A&E / emergency department Inpatient GP / primary care Urgent and emergency care Ambulance services API standard FHIR STU3

---

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

---

Active

NHS 111 API standard

API standard to 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 services NHS 111 API standard SOAP HL7 V3 Has adaptor

---

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

---

Retired

Outpatients - HL7 V3

Access an outpatient report.

Continuity of care Hospital Outpatient GP / primary care Message integration HL7 V3

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 Under review for deprecation

Personal Demographics Service - HL7 V3 API

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

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central SOAP HL7 V3 Has adaptor

---

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

---

In production Deprecated

Personal Demographics Service - SMSP API

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

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central

---

Active Under review for deprecation

Personal Demographics Service - SMSP API standards

Become a Spine Mini Service Provider giving access to patients' personal information, such as name, address, date of birth, related people, registered GP and NHS number, using our Spine Mini Service Provider (SMSP) API standards.

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API standard

---

Beta In production Internal

Prescriptions for Patients FHIR API

Use this API to access the Patient Facing Services (PFS) capabilities of the Electronic Prescription Service (EPS).

Pharmacy API FHIR REST Has sandbox Uses API platform Uses OAS

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

---

In production

Spine Directory Service - LDAP API

Access details of organisations, people and systems registered in the Spine Directory Service (SDS) using our LDAP API.

Reference data Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 API Central

---

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

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.

Access to records Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central HL7 V3 Has adaptor

---

Active

Summary Care Record - SMSP API standards

Become a Spine Mini Service Provider giving access to a patient's Summary Care Record using our SMSP API standards.

Access to records Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API standard HL7 V3

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

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

---

Retired

Visitors and Migrants - FHIR API

Identify overseas visitors and migrants liable for charging for their healthcare with the Visitors and Migrants FHIR API.

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