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 |  |
TBC |
| A002 | Professional Session Select Role | PUT: /v1/ProfessionalSession/{sessionKey} | |
TBC |
| A003 | Delete Professional Session | DELETE: /v1/ProfessionalSession/{sessionKey} | |
TBC |
| A004 | Retrieve Reference Data | GET: /STU3/v1/CodeSystem/{CodeSystemID} | |
TBC |
| A005 | Retrieve Referral | GET: /STU3/v1/ReferralRequest/{id} | |
TBC |
| A006 | Retrieve Attachment | GET: /STU3/v1/Binary/{AttachmentLogicalID} | |
TBC |
| A007 | Retrieve Clinical Information | GET: /STU3/v1/ReferralRequest/{ubrn}/$ers.generateCRI | |
TBC |
| A008 | Retrieve Worklist | POST: /STU3/v1/ReferralRequest/$ers.fetchworklist | |
TBC |
| A010 | Patient Service Search | POST: STU3/v1/HealthcareService/$ers.searchHealthcareServicesForPatient | |
TBC |
| A011 | Create Referral | POST: STU3/v1/ReferralRequest/$ers.createReferral | |
TBC |
| A012 | Maintain Referral Letter | POST: STU3/v1/ReferralRequest/{ubrn}/$ers.maintainReferralLetter | |
TBC |
| A013 | Accept Referral | POST: /STU3/v1/ReferralRequest/{ubrn}/$ers.acceptReferral | |
TBC |
| A014 | Reject Referral | POST: /STU3/v1/ReferralRequest/{ubrn}/$ers.rejectReferral | |
TBC |
| A015 | Retrieve Appointment Slots | GET: /STU3/v1/Slot | |
TBC |
| A016 | Book or Defer Appointment | POST: /STU3/v1/Appointment | |
TBC |
| A019 | Generate Patient Letter | POST: /STU3/v1/ReferralRequest/{ubrn}/$ers.generatePatientLetter | |
TBC |
| A020 | Upload File To Document Store | POST: /STU3/v1/Binary | |
TBC |
| A021 | Create Referral And Send For Triage | POST: /STU3/v1/ReferralRequest/$ers.createReferralAndSendForTriage | |
TBC |
| A022 | Cancel Appointment, Action Later | POST: /STU3/v1/ReferralRequest/{ubrn}/$ers.CancelAppointmentActionLater | |
TBC |
| A023 | Retrieve Advice and Guidance Requests Worklist | GET: /STU3/v1/CommunicationRequest/$ers.fetchworklist | |
TBC |
| A024 | Retrieve Advice and Guidance Request Summary | GET: /STU3/v1/CommunicationRequest/ | |
TBC |
| A025 | Retrieve Advice and Guidance Conversation | GET: /STU3/v1/Communication?[parameters] | |
TBC |
| A026 | Send Advice and Guidance Response | POST: /STU3/v1/CommunicationRequest/{ubrn}/$ers.sendCommunicationToRequester | |
TBC |
| A027 | Convert Advice and Guidance Request to Referral | POST: /STU3/v1/ReferralRequest/$ers.createFromCommunicationRequestActionLater | |
TBC |
| A028 | Record Review Outcome | POST: /STU3/v1/ReferralRequest/ | |
TBC |
| A029 | Available Actions For User List | GET: /STU3/v1/Task?focus=ReferralRequest/{ubrn}/_history/int&intent=proposal&status=ready | |
TBC |
Deprecated FHIR v2 API endpoints
| ID | Name | Status | Retirement Date |
|---|---|---|---|
| A004 | Retrieve Reference Data (DSTU2) | |
TBC |
| A005 | Retrieve Referral (DSTU2) | |
TBC |
| A006 | Retrieve Attachment (DSTU2) | |
TBC |
| A007 | Retrieve Clinical Information (DSTU2) | |
TBC |
| A008 | Retrieve Worklist (DSTU2) | |
TBC |
Retired APIs
| ID | Name | Status | Retirement Date | Notes |
|---|---|---|---|---|
| A009 | Generic Service Search (Alpha) |  |
OCT 2019 | Experimental API, not progressed to production |
| A017 | Defer Appointment (Alpha) | |
DEC 2020 | This functionality has been incorporated into A016: Book or Defer Appointment |
| A018 | Re-book Appointment (Alpha) | |
JUN 2020 | Prototype API shelved for future development as required |