API and integration catalogue

In production Deprecated

Digital Medicine - FHIR

Notify a patient's registered GP practice about care services delivered at a pharmacy, such as an immunisation.

GP / primary care FHIR Pharmacy Dispensing Vaccination Continuity of care MESH STU3 Internet facing Message integration

In production

Directory of Services - Urgent and Emergency Care - REST API

Access information on a wide range of health and care services across England using our Directory of Services (DoS) Urgent and Emergency Care REST API.

Patient-facing GP / primary care NHS 111 Reference data REST API Central Internet facing Urgent and emergency care Uses OAS

In production

Directory of Services - Urgent and Emergency Care - SOAP API

Access information on a wide range of health and care services across England using our Directory of Services Urgent and Emergency Care SOAP API.

GP / primary care NHS 111 Urgent and emergency care Patient-facing Reference data SOAP API Central Internet facing

Retired

Discharge - HL7 V3

Send a discharge report following transfer of responsibility for a patient.

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

Draft

Dose Syntax API standards

API standards to provide a structured way to record dosage instructions between primary and secondary care settings.

Community health Hospital GP / primary care Continuity of care FHIR API standard Prescribing Dispensing STU3

In production

e-Referral Service - FHIR API

Access the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care.

Hospital GP / primary care FHIR API Central STU3 Uses API platform Internet facing Has sandbox Uses OAS REST Referrals and bookings CIS2 authentication

Deprecated In production

e-Referral Service - FHIR API (HSCN)

Access the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care via HSCN only.

Hospital GP / primary care API Central FHIR STU3 DSTU2 Referrals and bookings

Draft

Electronic Prescribing and Medicines Administration API standards

Use these API standards to share medication requests between ePMA systems and hospital pharmacy or stock control systems.

FHIR Hospital Inpatient GP / primary care Prescribing Urgent and emergency care A&E / emergency department Dispensing API standard STU3

In production

Electronic Prescription Service - FHIR API

Access the Electronic Prescription Service (EPS) - the national service used to send electronic prescriptions from GP surgeries to pharmacies.

FHIR Outpatient Prescribing Dispensing REST API Central Has sandbox R4 Uses API platform Internet facing GP / primary care Uses OAS CIS2 authentication

In production Deprecated

Electronic Prescription Service - HL7 V3 API

Access the Electronic Prescription Service (EPS) to send prescriptions from prescribers such as GPs to dispensers such as pharmacies using our HL7 V3 API. This is now deprecated.

Community health GP / primary care A&E / emergency department Prescribing Urgent and emergency care OOH GP Dispensing HL7 V3 API Central Has adaptor CIS2 authentication