API for "End Triage request"

e-Referral Service (e-RS) e-Referral Service FHIR API
1

Hi,

Any API can be used to “End Triage request” for specific eRS record?

Thanks.

Jerry

2

Hi Jerry,

Yes, you can use the A028 Record Triage Outcome endpoint to end a triage request:

POST /STU3/ReferralRequest/{ubrn}/$ers.recordReviewOutcome

This is available for referrals in AWAITING_TRIAGE status. The available outcomes are:

  • RETURN_TO_REFERRER_WITH_ADVICE - return the referral to the referrer with clinical advice.
  • ACCEPT_REFER_BOOK_LATER - accept the referral and defer booking to the admin team.
  • CANCEL_APPOINTMENT_ACTION_LATER - cancel appointment with action deferred.

A reviewComments field is mandatory with all outcomes.

Roles required: SERVICE_PROVIDER_CLINICIAN or SERVICE_PROVIDER_CLINICIAN_ADMIN

You can check if the action is available for a given referral first using A029 Available Actions for User.

See further informtion here: e-Referral Service - FHIR API - NHS England Digital

I hope this help, please let us know if you need any further details.

George

3

Hi,

Is there any different in the ERS backend if we “End the triage” with A028 API (e.g CANCEL_APPOINTMENT_ACTION_LATER) vs eRS frontend >“Appointments for Booking” worklist>Select “End Triage request” under “Actions” dropdown menu> Select “Sent to community service not available in this system”?

4

Hi Jerry,

Yes, there is a significant difference between these two actions:

A028 with CANCEL_APPOINTMENT_ACTION_LATER keeps the referral active. It cancels the current appointment and requires another clinician to rebook/redirect the referral. The referral moves to the “Appointments for Booking” worklist for further action.

“End Triage Request” → “Sent to community service not available in this system” (via the frontend) cancels the referral entirely. This is a terminal state, no further action can be taken on the referral within eRS.

Hope this Helps,

George

5

Thx George,

Any FHIR API can be used to “End Triage Request” and save “Sent to community service not available in this system” to related eRS record?

6

Hey Jerry,

Yes you can use A036 (Cancel Referral). You would call:

POST /STU3/ReferralRequest/{ubrn}/$ers.cancelReferral

with reason code COMMUNITY_SERVICE_NA. The referral must be in a triage state and a comment is mandatory.

Hope this helps :slight_smile:

George