API and integration catalogue

In development Draft

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

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

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

Retired

Discharge - HL7 V3

Send a discharge report following transfer of responsibility for a patient.

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

Draft

Dose Syntax API standards

API standards to provide a structured way to record dosage instructions between primary and secondary care settings.

Community health Hospital GP / primary care Continuity of care FHIR API standard Prescribing Dispensing STU3

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