API ReferenceOfferings

List all referral destinations

Authentication

Authorizationstring
API Key authentication via header

Query parameters

referrerIdstringRequired
ID of the referring individual.
referrerIdTypeenumRequired
Type of ID specified in referrerId.
Allowed values:
referrerInstitutionIdstringRequired
ID of the referring institution.
patientPostalCodestringOptional
Postal code of the patient

Response

idstring
namestring

Name of the offering - use these as labels

institutionHciCodestring
institutionobject
systemenum
descriptionstring

Clinical guidelines and other information which clinicians should read before proceeding with creating the referral. May contain URLs - should be rendered in a Linkify component

isActiveboolean
Whether the offering is able to receive new referrals currently
isSubsidisableboolean
Whether this offering supports subsidized referrals.
timeslotPolicyenum

How timeslots are handled for this offering. Is enforced at validation. timeslot-required: Timeslots must be selected when creating a referral. optional-timeslots-and-urgentable: Timeslots are selectable but optional. If no timeslot is selected, the referral will be routed to a manual call-centre for scheduling. If you indicate isUrgent: true, the timeslot will be disregarded and referral will be sent to the call-centre for triage. no-timeslots: Timeslots are not selectable for this offering. Calling the timeslot API will return an error.

Allowed values:
isAllowedboolean
Whether the offering is allowed based on the provided query parameters
categoryenum
Category of the offering. Used to group offerings together.
Allowed values:
specialtystring
Specialty of the offering
nehrCodestring
NEHR code for the offering
reasonlist of objects
Reason the offering is not allowed, if applicable

Errors

401
Offerings List Request Unauthorized Error