Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Endpoint Catalogue (Archived)

APIs In Development

As of November 2022, our new e-RS FHIR API solution MUST be used for all new Partner integrations.

Please navigate to https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir for more information including how to Onboard.

The below information is intended for use by current/existing Live Partners only.

Deprecated FHIR v3 API endpoints

ID Name Endpoint URL Status Retirement Date
A001 Create Professional Session POST: /v1/ProfessionalSession Deprecated TBC
A002 Professional Session Select Role PUT: /v1/ProfessionalSession/{sessionKey} Deprecated TBC
A003 Delete Professional Session DELETE: /v1/ProfessionalSession/{sessionKey} Deprecated TBC
A004 Retrieve Reference Data GET: /STU3/v1/CodeSystem/{CodeSystemID} Deprecated TBC
A005 Retrieve Referral GET: /STU3/v1/ReferralRequest/{id} Deprecated TBC
A006 Retrieve Attachment GET: /STU3/v1/Binary/{AttachmentLogicalID} Deprecated TBC
A007 Retrieve Clinical Information GET: /STU3/v1/ReferralRequest/{ubrn}/$ers.generateCRI Deprecated TBC
A008 Retrieve Worklist POST: /STU3/v1/ReferralRequest/$ers.fetchworklist Deprecated TBC
A010 Patient Service Search POST: STU3/v1/HealthcareService/$ers.searchHealthcareServicesForPatient Deprecated TBC
A011 Create Referral POST: STU3/v1/ReferralRequest/$ers.createReferral Deprecated TBC
A012 Maintain Referral Letter POST: STU3/v1/ReferralRequest/{ubrn}/$ers.maintainReferralLetter Deprecated TBC
A013 Accept Referral POST: /STU3/v1/ReferralRequest/{ubrn}/$ers.acceptReferral Deprecated TBC
A014 Reject Referral POST: /STU3/v1/ReferralRequest/{ubrn}/$ers.rejectReferral Deprecated TBC
A015 Retrieve Appointment Slots GET: /STU3/v1/Slot Deprecated TBC
A016 Book or Defer Appointment POST: /STU3/v1/Appointment Deprecated TBC
A019 Generate Patient Letter POST: /STU3/v1/ReferralRequest/{ubrn}/$ers.generatePatientLetter Deprecated TBC
A020 Upload File To Document Store POST: /STU3/v1/Binary Deprecated TBC
A021 Create Referral And Send For Triage POST: /STU3/v1/ReferralRequest/$ers.createReferralAndSendForTriage Deprecated TBC
A022 Cancel Appointment, Action Later POST: /STU3/v1/ReferralRequest/{ubrn}/$ers.CancelAppointmentActionLater Deprecated TBC
A023 Retrieve Advice and Guidance Requests Worklist GET: /STU3/v1/CommunicationRequest/$ers.fetchworklist Deprecated TBC
A024 Retrieve Advice and Guidance Request Summary GET: /STU3/v1/CommunicationRequest/ Deprecated TBC
A025 Retrieve Advice and Guidance Conversation GET: /STU3/v1/Communication?[parameters] Deprecated TBC
A026 Send Advice and Guidance Response POST: /STU3/v1/CommunicationRequest/{ubrn}/$ers.sendCommunicationToRequester Deprecated TBC
A027 Convert Advice and Guidance Request to Referral POST: /STU3/v1/ReferralRequest/$ers.createFromCommunicationRequestActionLater Deprecated TBC
A028 Record Review Outcome POST: /STU3/v1/ReferralRequest/ Deprecated TBC
A029 Available Actions For User List GET: /STU3/v1/Task?focus=ReferralRequest/{ubrn}/_history/int&intent=proposal&status=ready Deprecated TBC

Deprecated FHIR v2 API endpoints

ID Name Status Retirement Date
A004 Retrieve Reference Data (DSTU2) Deprecated TBC
A005 Retrieve Referral (DSTU2) Deprecated TBC
A006 Retrieve Attachment (DSTU2) Deprecated TBC
A007 Retrieve Clinical Information (DSTU2) Deprecated TBC
A008 Retrieve Worklist (DSTU2) Deprecated TBC

Retired APIs

ID Name Status Retirement Date Notes
A009 Generic Service Search (Alpha) Retired OCT 2019 Experimental API, not progressed to production
A017 Defer Appointment (Alpha) Retired DEC 2020 This functionality has been incorporated into A016: Book or Defer Appointment
A018 Re-book Appointment (Alpha) Retired JUN 2020 Prototype API shelved for future development as required

All content is available under the Open Government Licence v3.0, except where otherwise stated