Sign in

v1

latestOpenAPI 3.0.02026-07-142027.3 KB

Get referral status

Returns the status of the referral with the given ID A status update can be initiated by a clinician or admin, or set to be initiated automatically for all referrals as desired.

Step 1: PMS system requests a status check to a specific referral ID using the same API key as for the referral

Step 2: EeRS supplier provides response 200 with the status - or an error message

get/referral/{referralID}/status

Headers

Accept-Versionstring
Example:1.0.0

The version number of the API you wish to call.

api-keystring
Example:KdsASD78FA5Sjl342kfwreas

The API Key associated with the calling API consumer.

Response

OK

referralStatus'incomplete' | 'submitted' | 'closednotsubmitted' | 'printed'

Shows the current status of the referral which will be one of:

  • incomplete - the referral has been received in the EeRS system but has not yet not been closed or submitted.
  • submitted - the referral has been submitted to a provider for onward care.
  • closednotsubmitted - the referral has been closed by the user without being submitted for any further review or action by service providers e.g. because a clinician decided that a referral wasn't necessary.
  • printed - the referral was entered manually. Only populated for 200 SUCCESS response.
errorMessagestring

For responses other than 200 SUCCESS an error message will be populated.

errorCodestring

For responses other than 200 SUCCESS an error code will be populated.