API and integration catalogue

In production

Demographics Batch Service

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

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

In production

Digital Signature Service API

Generate an electronic signature using your NHS CIS2 Authenticator.

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

Draft In development

Digital Staff Passport API

Notify Digital Staff Passport about changes to employee information in your workforce system. Use alongside the Digital Staff Passport API standard.

Workforce Hospital Internet facing Uses OAS REST Central

In production

Directory of Healthcare Services (Service Search) API

Find information about NHS healthcare services, including lists of NHS organisation types, organisations, and coronavirus (COVID-19) walk-in sites.

Vaccination Reference data Patient-facing REST API Central Internet facing

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 (DoS) Urgent and Emergency Care REST API.

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

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.

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

In production

e-Referral Service - FHIR API

Access the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care.

Hospital GP / primary care FHIR API Central STU3 Uses API platform Internet facing Has sandbox Uses OAS REST Referrals and bookings CIS2 authentication

Deprecated In production

e-Referral Service - FHIR API (HSCN)

Access the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care via HSCN only.

Hospital GP / primary care API Central FHIR STU3 DSTU2 Referrals and bookings

In production

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.

Hospital HL7 V3 API Central Has adaptor Referrals and bookings

Internal In production Beta

e-Referral Service Patient Care – FHIR API

Retrieve referrals for a patient from the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care.

FHIR Patient-facing Hospital Central API Internet facing R4 REST Uses API platform Uses OAS Referrals and bookings