Quickstart | Referral Exchange docs

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

Create a Referral Link

Send a POST request to:

POST /api/v1/links/upsert

Example body:

1 {
2   "referrerInstitutionId": "SKH001",
3   "referrerInstitutionName": "Sengkang Family Clinic",
4   "referrerId": "M12345Z",
5   "referrerIdType": "mcr",
6   "referrerName": "Dr. Tan Mei Ling"
7 }

Response:

1 {
2   "type": "upsert",
3   "referralId": "8c23c9b6-b0c5-4e4b-b34e-76e451bc5f19",
4   "url": "https://refer.health.gov.sg/referrals/8c23c9b6-b0c5-4e4b-b34e-76e451bc5f19"
5 }

Open the Referral Link

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