API and integration catalogue

In production Beta

GP Connect: Access Document - FHIR API

Retrieve unstructured documents from a patient’s GP practice record.

FHIR Hospital A&E / emergency department Outpatient Inpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 Access to records Continuity of care REST API Intermediary STU3

In production

GP Connect: Send Document - FHIR

Send a PDF consultation summary to a registered GP practice.

FHIR Hospital A&E / emergency department Outpatient Inpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Continuity of care MESH STU3 Internet facing Message integration

Retired

Health Protection Electronic Notification API

Inform Public Health England (PHE) that a notifiable disease has been diagnosed in a patient, using our Health Protection Electronic Notification (HPEN) API. Includes PHE's response message.

GP / primary care API Messaging OOH GP Tests and diagnostics Information governance Community health Hospital Urgent and emergency care Ambulance services NHS 111 A&E / emergency department

Active

Interface Mechanism 1 API standards

API standards to support the integration of your systems with any principal clinical GP system using IM1.

Hospital A&E / emergency department Patient-facing GP / primary care Urgent and emergency care API standard Access to records

In development

Interface Mechanism 1 PFS Auth

Authenticate users with this API to create an IM1 session, enabling access to Patient-Facing APIs.

Patient-facing Hospital GP / primary care Urgent and emergency care API standard

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

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

In production

National Data Opt-out - MESH

Submit a list of NHS numbers via MESH to be checked against the National Data Opt-out Service.

Hospital GP / primary care MESH Message integration Patient communication

Deprecated

National Early Warning Score 2 API standards

API standards to enable sharing of patients' vital signs and NEWS2 scores between systems and across care boundaries, for example, between two hospitals.

FHIR Hospital GP / primary care Urgent and emergency care Ambulance services Access to records A&E / emergency department Inpatient Continuity of care API standard STU3