Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Endpoint Catalogue

Catalogue of all currently available external e-Referral API endpoints
Id     Name Family Verb         URI Status FHIR
A001 Create Professional Session Session POST /v1/ProfessionalSession Live  
A002 Professional Session Select Role Session PUT /v1/ProfessionalSession/{sessionKey} Live  
A003 Delete Professional Session Session DELETE /v1/ProfessionalSession/{sessionKey} Live  
A004 Retrieve Reference Data Reference Data GET /v1/ValueSet/{valueSetId} Live Model
A005 Retrieve Referral Request Clinical Referral Information GET /v1/ReferralRequest/{id} Live Model
A006 Retrieve Attachment Clinical Referral Information GET /v1/Binary/att-{referralRequestAttachmentId Live  
A007 Retrieve Clinical Information Clinical Referral Information GET /v1/Binary/$ers.generateCRI Live Model
A008 Retrieve Worklist Clinical Referral Information GET /v1/ReferralRequest/$ers.fetchworklist Live Model
A009 Directory Service Search Service Search POST /v1/HealthcareService/$dos.serviceSearch Alpha  
A010 Patient Service Search Service Search POST /v1/HealthcareService/$patient.serviceSearch Alpha  
A011 Create Referral Request Through Shortlist Referral Request POST /v1/CreateReferral Alpha  
A012 Upload Attachments Referral Request POST /v1/ReferralRequest//$ers.uploadReferralLetter Alpha  
A013 Accept Referral Referral Request POST /v1/ReferralRequest//$ers.accept Alpha  
A014 Reject Referral Referral Request POST /v1/ReferralRequest//$ers.reject Alpha  
A015 Retrieve Appointment Slots Referral Request POST /v1/Slot/$ers.searchAppointmentSlots Alpha  
A016 Book Appointment Referral Request POST /v1/ReferralRequest/{UBRN}/$ers.bookdirect Alpha  
A017 Defer Booking to Provider Referral Request POST /v1/ReferralRequest/{UBRN}/$ers.deferBooking Alpha  
A018 Re-book Appointment Referral Request POST /v1/ReferralRequest/{UBRN}/$ers.deferBooking Alpha  
A019 Generate Patient Letter Referral Request POST /v1/ReferralRequest/{UBRN}/$ers.generatePatientLetter Alpha  

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