API and integration catalogue

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

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

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

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.

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

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

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.

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

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

In production Beta

Electronic Prescription Service Tracker - REST API

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

Pharmacy Prescribing REST API Central Internet facing