API and integration catalogue

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

Draft

Digital Staff Passport API standard

Allow Digital Staff Passport to access employee information in your workforce system.

Workforce Hospital API standard Internet facing Uses OAS REST

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

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

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

In production Internal

Elective Waiting List API

Use this API to access the Waiting List Minimum Data Set (WLMDS) – The national electronic database of NHS patient waiting list details such as date of birth, a patient's care pathway and date they began waiting.

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

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.

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

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.

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