Create a new referral link
Authentication
Authorizationstring
API key to authenticate for external integrations. Use the format: “ApiKey insert-token-here”
Request
This endpoint expects an object.
referrerInstitutionId
HCI code of the institution authoring this referral.
referrerInstitutionName
Name of the institution authoring this referral.
referrerId
Id of the doctor authoring this referral.
requesterIdentifier
Identifier for the individual requesting the link. The individual may or may not be the referrer. Preferred to be an email.
referrerIdType
Type of ID specified in referrerId.
Allowed values:
referrerName
Name of the doctor authoring this referral.
referrerEmail
Email of the doctor authoring this referral.
referrerContactNumber
Contact number of the doctor authoring this referral.
patientUin
Patient UIN, e.g. NRIC or FIN
patientName
Patient name
patientPhoneNumber
Patient phone number - only Singaporean accepted for now
patientDob
Patient date of birth
patientGender
Patient gender
Allowed values:
address
residentialStatus
Patient residential status
Allowed values:
isPatientHsgEnrolled
Patient Healthier SG (HSG) enrolment status
clinicLicenseNumber
Clinic license number
clinicType
Clinic type
Allowed values:
clinicalInfo
Any clinical information that is relevant to the referral, e.g. medical history, drug allergies, treatment provided, etc.
Response
referralId
The ID of the referral
url
The URL of the link
type
type of referral link
Allowed values:
Errors
400
Bad Request Error
401
Unauthorized Error