API and integration catalogue

In production Under review for deprecation

GP2GP Management Information MESH

Provide information to us on the progress of the patient migration process between GP practices (GP2GP).

GP / primary care MESH REST Continuity of care Internet facing Message integration

In production

Health Research Data Catalogue API

Retrieve information suitable for publication in a health research data catalogue.

Access to records Key care information REST Has sandbox Uses API platform API Central Internet facing Uses OAS Uses digital onboarding

In development

Healthcare Worker - FHIR API

Healthcare worker (HCW) API enables systems to search, retrieve and display healthcare worker data from NHS employees with a health care profile.

Uses OAS Internet facing REST FHIR Uses digital onboarding

In production

Hello World API

Teach yourself how to connect to our RESTful APIs.

REST Has sandbox Uses API platform API Central Internet facing Uses OAS CIS2 authentication

In development

Immunisation FHIR API

Access and update a patient's immunisation record, including coronavirus, influenza and human papillomavirus immunisations.

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

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

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