API and integration catalogue

Internal Retired

COVID-19 Medical Exemptions - FHIR API

Access a patient’s coronavirus (COVID-19) medical exemption status.

Vaccination Patient-facing FHIR R4 REST Has sandbox API Central Uses API platform Internet facing Uses OAS

Deprecated

COVID-19 Test Results - FHIR API

Access a patient’s coronavirus (COVID-19) test results history.

Patient-facing FHIR REST API Central Tests and diagnostics Has sandbox R4 Uses API platform Internet facing Uses OAS

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

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

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 development

Eligibility Signposting API

Access the Patient Eligibility Signposting Data Product - the nationally curated single source of vaccination eligibility status and signposted actions for individuals.

Central Medication management Vaccination Patient-facing Internet facing REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

In production

GP Connect (Patient Facing) Access Record - FHIR API

Access a patient's GP records.

Access to records Continuity of care Patient-facing GP / primary care Pharmacy OOH GP Intermediary REST Internet facing Uses OAS FHIR STU3 API

In production

GP Connect (Patient Facing) Prescriptions - FHIR API

Manage a patient's prescriptions.

Continuity of care GP / primary care Patient-facing API Intermediary REST Internet facing Uses OAS FHIR R4 Prescribing

In production

GP Connect (Patient Facing) User Permissions API

Manage a patient's permissions to access their medical records and services at their GP practice.

Continuity of care Security Patient-facing API Intermediary Internet facing Uses OAS REST GP / primary care