API and integration catalogue

In production Deprecated

Immunisation History - FHIR API

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

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

In production

Message Exchange for Social Care and Health (MESH) API

Transfer messages and large files securely across health and social care organisations using the Message Exchange for Social Care and Health (MESH) API.

Messaging MESH API Central Transport / infrastructure Internet facing Uses OAS REST Uses digital onboarding

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 Uses digital onboarding

In production

National Care Records Service integration

Integrate point-of-care applications with the National Care Records Service (NCRS) to quickly and easily view patient records.

UI integration Access to records Internet facing Pharmacy Social care Dentistry Urgent and emergency care GP / primary care Key care information Demographics Community health Hospital A&E / emergency department Inpatient Outpatient Maternity Mental health Patient-facing Transport / infrastructure Ambulance services NHS 111 OOH GP

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

National Data Opt-out - MESH

Submit a list of NHS numbers via MESH to be checked against the National Data Opt-out Service.

Hospital GP / primary care MESH Message integration Patient communication

In production Under review for deprecation

National Events Management Service - FHIR API

Publish and subscribe to patient-centric healthcare event messages with the National Events Management Service (NEMS) FHIR API. This national service is implemented on the NHS Spine. 

FHIR Continuity of care MESH API Central Transport / infrastructure NEMS STU3 Internet facing Publish-subscribe events Uses digital onboarding

In production

National Health Application and Infrastructure Services - NHAIS GP Links

Manage GP registrations and other patient data in PDS using PCRM.

MESH GP / primary care Demographics Has adaptor Internet facing Message integration

In production Beta

National Imaging Registry API

Use this API to access patient imaging records across NHS and private healthcare networks. The National Imaging Registry (NIR) API allows authorised systems to view a patient’s imaging history, including examinations, diagnostic reports, and imaging studies.

Internet facing

In production

National Record Locator - FHIR API

Locate and access patient information shared by other healthcare organisations using the National Record Locator (NRL) FHIR API.

REST API Central Internet facing Access to records Transport / infrastructure FHIR R4 STU3 Uses digital onboarding