For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Home
    • About the Referral Exchange (RefX)
  • Getting Started
    • API Overview
    • Accessing our APIs
    • Authentication
    • Content Types
    • Request and Response Limits
    • Create and Edit Referrals
    • Print Referrals
    • List Referrals
    • Cancel & Withdraw Referrals
    • Timeline Events
    • Implementation Reference
  • Concepts
    • Referral Lifecycle & Statuses
    • Referral Notes
    • Browser Tab Handling
    • Referral Link
    • NEHR Integration
  • API Reference
      • GETList referrals
      • GETGet referral details
    • Changelog
LogoLogo
API ReferenceRetrieving Referrals

Get referral details

GET
/api/v1/referrals/:referralId
GET
/api/v1/referrals/:referralId
$curl -G https://dummy-url-see-smartcms-spec/api/v1/referrals/referralId \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     --data-urlencode requesterIdentifier=requester@example.com \
>     -d institutionIdType=hci \
>     -d institutionId=institutionId
1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "sender": {
4    "hciCode": "S1234",
5    "name": "Singapore General Hospital",
6    "block": "123",
7    "streetName": "Outram Road",
8    "buildingName": "Main Building",
9    "floorNumber": "5",
10    "unitNumber": "05-12",
11    "postalCode": "169608"
12  },
13  "senderSystem": "HAS",
14  "offering": {
15    "id": "offering-001",
16    "name": "Gastroenterology Specialist Clinic",
17    "institutionHciCode": "S1234",
18    "institution": {
19      "hciCode": "S1234",
20      "name": "Singapore General Hospital",
21      "block": "123",
22      "streetName": "Outram Road",
23      "buildingName": "Main Building",
24      "floorNumber": "5",
25      "unitNumber": "05-12",
26      "postalCode": "169608"
27    },
28    "system": "HAS",
29    "description": "Before proceeding with your referral, please refer to the guidelines of referrals to this SOC. https://go.gov.sg/refx-nuhs-gastro-guidelines",
30    "isActive": true,
31    "isSubsidisable": true,
32    "timeslotPolicy": "timeslot-required",
33    "category": "aac",
34    "specialty": "Gastroenterology",
35    "nehrCode": "GASTRO123"
36  },
37  "patient": {
38    "uin": "S1234567A",
39    "name": "John Tan",
40    "phoneNumber": "91234567",
41    "dob": "1985-07-20",
42    "gender": "Male",
43    "chasStatus": "Orange",
44    "address": {
45      "postalCode": "560123",
46      "block": "45",
47      "streetName": "Bukit Timah Road",
48      "floorNumber": "12",
49      "unitNumber": "12-34"
50    },
51    "residentialStatus": "SC",
52    "nationality": "Singapore",
53    "isHsgEnrolled": true
54  },
55  "referringDoctor": {
56    "mcr": "MCR123456",
57    "idType": "mcr",
58    "name": "Dr. Lim Wei",
59    "email": "dr.limwei@clinic.sg",
60    "contactNumber": "98765432"
61  },
62  "isSubsidised": true,
63  "isUrgent": true,
64  "createdAt": "2024-05-01T00:00:00Z",
65  "updatedAt": "2024-05-01T00:00:00Z",
66  "formResponses": [
67    {
68      "question": "Does the patient have any known allergies?",
69      "id": "q1",
70      "answer": "Penicillin"
71    }
72  ],
73  "attachments": [
74    {
75      "url": "https://refer.health.gov.sg/attachments/ecg-report-2024-04-30.png",
76      "name": "ecg-report.png"
77    }
78  ],
79  "coreStatus": "draft",
80  "isCancellable": true,
81  "notes": [
82    {
83      "id": "note-001",
84      "content": "Patient requested early appointment due to worsening symptoms.",
85      "authorHciCode": "S1234",
86      "authorName": "Dr. Lim Wei",
87      "createdAt": 1719820800000,
88      "updatedAt": 1719820800000
89    }
90  ],
91  "timelineEvents": [
92    {
93      "type": "draft.created",
94      "description": "PartnersBuddy rescheduled the appointment from 16 Dec, 10:00 PM to 21 Dec,11:00 PM",
95      "producedAt": 1718764800000,
96      "system": "HAS"
97    }
98  ],
99  "links": [
100    {
101      "referralId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
102      "url": "https://refer.health.gov.sg/referrals/3fa85f64-5717-4562-b3fc-2c963f66afa6/amend",
103      "type": "amend",
104      "label": "Amend Referral"
105    }
106  ],
107  "appointments": [
108    {
109      "status": "scheduled",
110      "visitDateTime": "2024-01-15T09:30:00Z",
111      "isDischarged": true,
112      "institutionName": "Singapore General Hospital",
113      "specialtyName": "Gastroenterology",
114      "subSpecialtyName": "Hepatology",
115      "location": "Outram Road Clinic, Room 12"
116    }
117  ],
118  "status": "draft",
119  "forms": [
120    {
121      "id": "form-001",
122      "url": "https://refer.health.gov.sg/forms/form-001",
123      "description": "Referral form for Gastroenterology",
124      "isFilled": true,
125      "formResponses": [
126        {
127          "question": "Does the patient have any known allergies?",
128          "id": "q1",
129          "answer": "Penicillin"
130        }
131      ],
132      "remark": "Please complete all fields",
133      "fields": [
134        {}
135      ],
136      "version": 1.1,
137      "migrated": true
138    }
139  ],
140  "url": "https://refer.health.gov.sg/referrals/3fa85f64-5717-4562-b3fc-2c963f66afa6",
141  "clinicLicenseNumber": "CLN-987654",
142  "clinicType": "CHAS-only",
143  "clinicalInfo": "Patient has a history of GERD and allergic to penicillin. Recent symptoms include abdominal pain and nausea.",
144  "timeslotStartAt": "2024-05-10T09:00:00Z",
145  "appointmentLocation": "Singapore General Hospital, Outram Road",
146  "nehrForm": "<html><body><h1>Referral Form</h1><p>Patient details and referral info</p></body></html>",
147  "nehrFormType": "ReferralForm|Gastroenterology"
148}
Was this page helpful?
Previous

Delete a draft referral

Next
Built with

Authentication

Authorizationstring

API key to authenticate for external integrations. Use the format: “ApiKey insert-token-here”

Path parameters

referralIdstringRequiredformat: "uuid"
Referral ID

Query parameters

additionalFieldlist of enumsOptional
Allowed values:
requesterIdentifierstringRequired
Identifier for the individual requesting the referral. Preferred to be an email.
institutionIdTypeenumRequired
The type of institution ID
Allowed values:
institutionIdstringRequired
The institution ID

Response

idstring
senderobject
senderSystemenum
offeringobject
patientobject
referringDoctorobject
isSubsidisedboolean
isUrgentboolean
createdAtstring

Created at (ISO datetime)

updatedAtstring

Updated at (ISO datetime)

formResponseslist of objects
attachmentslist of objects
coreStatusenum
isCancellableboolean
Whether this referral can be cancelled
noteslist of objects
timelineEventslist of objects
linkslist of objects
appointmentslist of objects
statusenumDeprecated
Deprecated. Use coreStatus instead.
formslist of objects
List of forms required to complete the referral
urlstring
URL to view the referral
clinicLicenseNumberstring
Clinic license number
clinicTypeenum
Clinic type
Allowed values:
clinicalInfostring
Any clinical information that is relevant to the referral, e.g. medical history, drug allergies, treatment provided, etc.
timeslotStartAtstring

Timeslot start time (ISO datetime)

appointmentLocationstring
Appointment location
nehrFormstring
Referral form rendered as HTML for NEHR integration
nehrFormTypestring

Form type description(s) for NEHR integration, concatenated by | if multiple

Errors

401
Unauthorized Error
404
Not Found Error