Request This endpoint expects an object.
referrerInstitutionId string Required
HCI code of the institution authoring this referral.
referrerInstitutionIdType enum Required
The type of institution ID
Allowed values: hci
referrerInstitutionName string Required
Name of the institution authoring this referral.
referrerId string Required
Id of the doctor authoring this referral.
requesterIdentifier string Required
Identifier for the individual requesting the link. The individual may or may not be the referrer. Preferred to be an email.
referrerIdType enum Required
Type of ID specified in referrerId.
Allowed values: mcr nric email brightUserId dcr
referrerName string Required
Name of the doctor authoring this referral.
referrerEmail string Optional
Email of the doctor authoring this referral.
referrerContactNumber string Optional format: "^[3689][0-9]{7}$"
Contact number of the doctor authoring this referral.
patientUin string Optional
Patient UIN, e.g. NRIC or FIN
patientName string Optional
Patient name
patientPhoneNumber string Optional format: "^[3689][0-9]{7}$"
Patient phone number - only Singaporean accepted for now
patientDob string Optional format: "ISO 8601"
Patient date of birth
patientGender enum Optional
Patient gender
Allowed values: Male Female
residentialStatus enum Optional
Patient residential status
Allowed values: SC PR Foreigner
nationality enum Optional
Patient nationality
isPatientHsgEnrolled boolean Optional
Patient Healthier SG (HSG) enrolment status
clinicLicenseNumber string Optional
Clinic license number
clinicType enum Optional
Clinic type
Allowed values: CHAS-only CHAS and HSG CHAS and Healthier SG
clinicalInfo string Optional
Any clinical information that is relevant to the referral, e.g. medical history, drug allergies, treatment provided, etc.
