API and integration catalogue

In development Internal

Address Quality Service API

Add a Unique Property Reference Number (UPRN) to addresses before they are updated in the Personal Demographics Service (PDS) database.

REST API standard Uses OAS API

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

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

Internal In development

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

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

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

Internal Beta In production

Multicast Notification Service API

Publish and receive patient-related state changes from a single centralised system.

Uses OAS API Internet facing Central Has sandbox Publish-subscribe events REST STU3 MESH

In production Beta Internal

National Data Opt-out - FHIR API

Capture patients' preferences and control sharing of their data by healthcare organisations for planning and research purposes with our National Data Opt-out (NDOP) FHIR API.

FHIR Community health Hospital GP / primary care Ambulance services NHS 111 Mental health A&E / emergency department Outpatient Inpatient OOH GP Urgent and emergency care Information governance API Central Access to records Social care REST STU3 Internet facing

In production Beta Internal

Patient Care Aggregator - FHIR API

Get an aggregated list of referrals and bookings for a patient from secondary care providers.

Patient-facing API Intermediary R4 FHIR Uses API platform Internet facing REST Uses OAS Referrals and bookings