API and integration catalogue

Active

NHS 111 API standard

API standard to share information between NHS 111 and other organisations, such as GPs and ambulance services, and query the Repeat Caller Service.

NHS 111 GP / primary care Ambulance services SOAP Hospital Urgent and emergency care A&E / emergency department HL7 V3 API standard Has adaptor

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

Under review for deprecation

Organisation Data Service - FHIR API

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

Community health Ambulance services NHS 111 Mental health Dentistry Social care Pharmacy REST OOH GP Hospital FHIR GP / primary care API Outpatient A&E / emergency department STU3 Uses OAS

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

Retired

Outpatients - HL7 V3

Access an outpatient report.

Hospital GP / primary care Outpatient Continuity of care HL7 V3 Message integration

In production Under review for deprecation

Pathology Messaging - EDIFACT

Receive pathology test results in GP practices from laboratories.

Hospital GP / primary care Tests and diagnostics MESH Has adaptor Internet facing Message integration

Pathology Messaging - FHIR

Share pathology results from a Laboratory Information Management System (LIMS) to the requestor in NHS primary or secondary care settings.

Hospital GP / primary care FHIR Tests and diagnostics MESH STU3 Internet facing Message integration

In production Under review for deprecation

Pathology Messaging - HL7 V3

Request laboratory tests and send the results back to the requester, usually the patient's GP or consultant.

Hospital GP / primary care Tests and diagnostics HL7 V3 Has adaptor Message integration CIS2 authentication

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