Skip to navigation

Quickstart

The simplest way to integrate with RefX is to use Referral Link, a hosted page that handles referral form logic, validations, and submission.

  1. Create a Referral Link

Send a POST request to:

POST /api/v1/links/upsert

Example body:

{
"referrerInstitutionId": "SKH001",
"referrerInstitutionName": "Sengkang Family Clinic",
"referrerId": "M12345Z",
"referrerIdType": "mcr",
"referrerName": "Dr. Tan Mei Ling"
}

Response:

{
"type": "upsert",
"referralId": "8c23c9b6-b0c5-4e4b-b34e-76e451bc5f19",
"url": "https://refer.health.gov.sg/referrals/8c23c9b6-b0c5-4e4b-b34e-76e451bc5f19"
}
  1. Open the Referral Link

Redirect the user to the url in the response to open the hosted referral form.