API ReferenceCreating Referrals

Create a new referral link

Request

This endpoint expects an object.
referrerInstitutionIdstringRequired
HCI code of the institution authoring this referral.
referrerInstitutionIdTypeenumRequired
The type of institution ID
referrerInstitutionNamestringRequired
Name of the institution authoring this referral.
referrerIdstringRequired
Id of the doctor authoring this referral.
requesterIdentifierstringRequired
Identifier for the individual requesting the link. The individual may or may not be the referrer. Preferred to be an email.
referrerIdTypeenumRequired
Type of ID specified in referrerId.
referrerNamestringRequired
Name of the doctor authoring this referral.
referrerEmailstringOptional
Email of the doctor authoring this referral.
referrerContactNumberstringOptionalformat: "^[3689][0-9]{7}$"
Contact number of the doctor authoring this referral.
patientUinstringOptional
Patient UIN, e.g. NRIC or FIN
patientNamestringOptional
Patient name
patientPhoneNumberstringOptionalformat: "^[3689][0-9]{7}$"

Patient phone number - only Singaporean accepted for now

patientDobstringOptionalformat: "ISO 8601"
Patient date of birth
patientGenderenumOptional
Patient gender
addressobjectOptional
residentialStatusenumOptional
Patient residential status
nationalityenumOptional
Patient nationality
isPatientHsgEnrolledbooleanOptional

Patient Healthier SG (HSG) enrolment status

clinicLicenseNumberstringOptional
Clinic license number
clinicTypeenumOptional
Clinic type
clinicalInfostringOptional

Optional but strongly recommended. When provided, this field enables pre-filling of the referral form. Includes medical history, drug allergies, treatment provided, and other relevant clinical context.

Response

referralIdstring
The ID of the referral
urlstring
The URL of the link
typeenum
type of referral link

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error