API and integration catalogue

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

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

Beta In production

Patient Care Aggregator Record Service API

As a secondary care provider, let the Patient Care Aggregator know which patients you have bookings for.

Referrals and bookings API Central Uses OAS REST Internet facing Uses digital onboarding

Patient Care Aggregator Reporting API

Use this API to send events which happen within your service boundary to the Wayfinder Reporting Service.

Patient flags change event

Use this document alongside the Create Subscriptions API documentation when you want to subscribe to this event..

NEMS Publish-subscribe events Patient-facing FHIR Uses API platform Access to records Messaging Demographics

Internal Beta In production

Patient Flags Service - FHIR API

This service provides access to flags associated with a patient.

Key care information GP / primary care Central FHIR R4 Uses OAS Has sandbox REST Uses API platform

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