API and integration catalogue

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

Under review for deprecation

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

Organisation Data Terminology - FHIR API

Use this API to access a dataset of health and social care organisations and sites, such as trusts or GP practices, using the Organisation Data Service (ODS). 

Uses OAS FHIR REST Uses digital onboarding R4 Has sandbox Uses API platform Reference data

Deprecated In production

Out Of Hours

Send details of an out of hours (OOH) assessment from an out of hours GP system to the patient's registered GP.

NHS 111 GP / primary care Urgent and emergency care Message integration Internet facing MESH Continuity of care

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

Draft

Patient Care Aggregator Get Appointments API standard

As a secondary care provider, provide a list of bookings for a patient to the Patient Care Aggregator.

Referrals and bookings API standard Internet facing FHIR R4 REST Uses OAS Uses digital onboarding