API and integration catalogue

In production Deprecated

Female Genital Mutilation - Information Sharing - FHIR API

Share female genital mutilation (FGM) information for children under 18 with relevant NHS professionals across England using our Female Genital Mutilation (FGM) Information Sharing FHIR API.

FHIR Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Key care information API Central DSTU2

Retired

Legitimate Relationship Service - HL7 V3 API

Access patients' Legitimate Relationships (LR) using our HL7 V3 API.

Hospital Access to records Information governance HL7 V3 API Central Has adaptor CIS2 authentication

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

NHS App API

Engage with users of the NHS App.

Hospital GP / primary care Patient-facing Patient communication REST API FHIR R4 Uses API platform Internet facing Central Uses OAS Uses digital onboarding

In production

NHS Notify MESH

Send messages to patients and the public with NHS Notify using MESH.

Central Community health Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Mental health OOH GP Pharmacy Demographics Internet facing Message integration

In production

Organisation Data Service - ORD API

Access the full dataset of health and social care organisations in England and Wales, such as trusts or GP practices, using our Organisation Data Service (ODS) Organisation Reference Data (ORD) API. 

Community health Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Mental health Social care Dentistry A&E / emergency department Outpatient Inpatient OOH GP Pharmacy Reference data REST SOAP API Central Internet facing

In production

Personal Demographics Service - FHIR API

Access patients' personal information, such as name, address, date of birth, related people, registered GP, nominated pharmacy and NHS number using the FHIR version of the Personal Demographics Service (PDS) API.

FHIR Community health Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Mental health OOH GP Pharmacy Demographics API Central Has sandbox R4 Patient-facing Uses API platform Internet facing Uses OAS REST Uses digital onboarding CIS2 authentication

In production Under review for deprecation

Personal Demographics Service - HL7 V3 API

Access patients' personal information, such as name, address, date of birth, related people, registered GP and NHS number using our HL7 V3 version of the Personal Demographics Service (PDS) API.

Community health Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Mental health OOH GP Pharmacy Demographics SOAP HL7 V3 API Central Has adaptor CIS2 authentication

Deprecated In production

Personal Demographics Service - SMSP API

Access patients' personal information, such as name, address, date of birth, related people, registered GP and NHS number using our Spine Mini Service Provider (SMSP) API.

Community health Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Mental health OOH GP Pharmacy Demographics API Central

In production

Personal Demographics Service MESH

Search the Personal Demographics Service (PDS) for patient details using the MESH UI. Formerly known as Master Patient Trace.

Central Community health Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Mental health OOH GP Pharmacy Demographics Internet facing Message integration