API and integration catalogue

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

EPS FHIR Dispensing API

Use this API to access the Electronic Prescription Service (EPS). EPS is the national service used to send electronic prescription messages between prescribers and community dispensers.

FHIR Outpatient Dispensing REST API Central Has sandbox R4 Uses API platform Internet facing Uses OAS CIS2 authentication

In production

EPS FHIR Prescribing API

Use this API to access the Electronic Prescription Service (EPS). EPS is the national service used to send electronic prescription messages between prescribers and community dispensers.

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

Retired

Eyecare Electronic Referral Service API standard

Pass details of a new eyecare referral to an Eyecare Electronic Referral System (EeRS).

Referrals and bookings API standard Uses OAS REST Hospital Outpatient

Retired

FHIR Converter API

Convert FHIR resources from FHIR STU3 to FHIR R4 and vice versa.

API Central REST FHIR STU3 R4 Uses API platform Internet facing Uses OAS