API and integration catalogue

In production Under review for deprecation

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 Patient-facing Reference data SOAP API Central Internet facing Uses OAS Urgent and emergency care Uses digital onboarding

In production Beta

Directory of Services Search API

Use this API to access healthcare services details profiled in the Directory of Services. This API provides read-only access to the data held in the directory.

NHS 111 REST Central Internet facing Uses OAS Uses digital onboarding Urgent and emergency care

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

DOS Search

Placeholder for dos-search

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

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

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