List all referral destinations | Referral Exchange docs

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.

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

category"aac" or null

Category of the offering. Used to group offerings together.

1	import requests
2
3	url = "https://dummy-url-see-smartcms-spec/api/v1/offerings"
4
5	querystring = {"referrerId":"referrerId","referrerIdType":"mcr","referrerInstitutionId":"referrerInstitutionId"}
6
7	headers = {"Authorization": "<apiKey>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	[
2	{
3	"id": "id",
4	"name": "name",
5	"institutionHciCode": "institutionHciCode",
6	"institution": {
7	"hciCode": "hciCode",
8	"name": "name",
9	"block": "block",
10	"streetName": "streetName",
11	"postalCode": "postalCode",
12	"buildingName": "buildingName",
13	"floorNumber": "floorNumber",
14	"unitNumber": "unitNumber"
15	},
16	"system": "HAS",
17	"description": "Before proceeding with your referral, please refer to the guidelines of referrals to this SOC. https://go.gov.sg/refx-nuhs-gastro-guidelines",
18	"isActive": true,
19	"isSubsidisable": true,
20	"timeslotPolicy": "timeslot-required",
21	"isAllowed": true,
22	"category": "aac"
23	}
24	]

Authentication

Query parameters

Response

Errors