API ReferenceLinks

Create a new referral link

Authentication

Authorizationstring
API Key authentication via header

Request

This endpoint expects an object.
referrerInstitutionIdstringRequired
HCI code of the institution authoring this referral.
referrerInstitutionNamestringRequired
Name of the institution authoring this referral.
referrerIdstringRequired
Id of the doctor authoring this referral.
referrerIdTypeenumRequired
Type of ID specified in referrerId.
Allowed values:
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

patientDobstringOptional
Patient date of birth
patientGenderenumOptional
Patient gender
Allowed values:
addressobjectOptional
residentialStatusenumOptional
Patient residential status
Allowed values:
isPatientHsgEnrolledbooleanOptional

Patient Healthier SG (HSG) enrolment status

clinicLicenseNumberstringOptional
Clinic license number
clinicTypeenumOptional
Clinic type
Allowed values:
clinicalInfostringOptional
Any clinical information that is relevant to the referral, e.g. medical history, drug allergies, treatment provided, etc.

Response

typeenum
type of referral link
Allowed values:
referralIdstring
The ID of the referral
urlstring
The URL of the link

Errors