Get the recommended offering for a category based on postal code
Authentication
Authorizationstring
API Key authentication via header
Query Parameters
category
Offering category to retrieve recommendation for
postalCode
Postal code of the patient to retrieve recommendation for
Response
id
name
Name of the offering - use these as labels
institutionHciCode
institution
system
description
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
isActive
Whether the offering is able to receive new referrals currently
isSubsidisable
Whether this offering supports subsidized referrals.
timeslotPolicy
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:
category
Category of the offering. Used to group offerings together.
