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

List referrals

GET
/api/v1/institutions/:institutionIdType/:institutionId/referrals
GET
/api/v1/institutions/:institutionIdType/:institutionId/referrals
$curl https://dummy-url-see-smartcms-spec/api/v1/institutions/hci/institutionId/referrals \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "data": [
3    {
4      "id": "ref-20240601-001",
5      "sender": {
6        "hciCode": "S1234",
7        "name": "Singapore General Hospital",
8        "block": "Outram Road",
9        "streetName": "Outram Road",
10        "buildingName": "Main Building",
11        "floorNumber": "5",
12        "unitNumber": "05-12",
13        "postalCode": "169608"
14      },
15      "senderSystem": "HAS",
16      "offering": {
17        "id": "off-1001",
18        "name": "Gastroenterology Specialist Clinic",
19        "institutionHciCode": "S1234",
20        "institution": {
21          "hciCode": "S1234",
22          "name": "Singapore General Hospital",
23          "block": "Outram Road",
24          "streetName": "Outram Road",
25          "buildingName": "Main Building",
26          "floorNumber": "5",
27          "unitNumber": "05-12",
28          "postalCode": "169608"
29        },
30        "system": "HAS",
31        "description": "Before proceeding with your referral, please refer to the [guidelines of referrals to this SOC](https://go.gov.sg/refx-nuhs-gastro-guidelines).",
32        "isActive": true,
33        "isSubsidisable": true,
34        "timeslotPolicy": "timeslot-required",
35        "category": "aac",
36        "specialty": "Gastroenterology",
37        "nehrCode": "GASTRO123"
38      },
39      "patient": {
40        "uin": "S1234567A",
41        "name": "Tan Wei Ming",
42        "phoneNumber": "91234567",
43        "dob": "1985-07-15",
44        "gender": "Male",
45        "chasStatus": "Orange",
46        "address": {
47          "postalCode": "560123",
48          "block": "123",
49          "streetName": "Bukit Timah Road",
50          "floorNumber": "12",
51          "unitNumber": "12-34"
52        },
53        "residentialStatus": "SC",
54        "nationality": "Singapore"
55      },
56      "referringDoctor": {
57        "mcr": "MCR123456",
58        "idType": "mcr",
59        "name": "Dr. Lim Mei Ling",
60        "email": "meiling.lim@clinic.sg",
61        "contactNumber": "98765432"
62      },
63      "isSubsidised": true,
64      "isUrgent": false,
65      "createdAt": "2024-05-01T08:30:00Z",
66      "updatedAt": "2024-05-02T10:15:00Z",
67      "formResponses": [
68        {
69          "question": "What are the patient's main symptoms?",
70          "id": "q1",
71          "answer": "Abdominal pain and nausea"
72        }
73      ],
74      "attachments": [
75        {
76          "url": "https://refer.health.gov.sg/attachments/ecg-report-20240501.png",
77          "name": "ecg-report.png"
78        }
79      ],
80      "coreStatus": "draft",
81      "isCancellable": true,
82      "notes": [
83        {
84          "id": "note-001",
85          "content": "Patient prefers morning appointments.",
86          "authorHciCode": "S1234",
87          "authorName": "Nurse Joy",
88          "createdAt": 1683000000,
89          "updatedAt": 1683003600
90        }
91      ],
92      "status": "draft",
93      "forms": [
94        {
95          "id": "form-001",
96          "url": "https://refer.health.gov.sg/forms/form-001",
97          "description": "Gastroenterology Referral Form",
98          "isFilled": true,
99          "formResponses": [
100            {
101              "question": "What are the patient's main symptoms?",
102              "id": "q1",
103              "answer": "Abdominal pain and nausea"
104            }
105          ],
106          "remark": "Please complete all fields before submission.",
107          "fields": [
108            {
109              "fieldType": "text",
110              "label": "Symptoms description"
111            }
112          ],
113          "version": 1.1,
114          "migrated": true
115        }
116      ],
117      "url": "https://refer.health.gov.sg/referrals/ref-20240601-001",
118      "clinicLicenseNumber": "CLN-56789",
119      "clinicType": "CHAS-only",
120      "clinicalInfo": "Patient has a history of gastritis and is allergic to penicillin.",
121      "timeslotStartAt": "2024-05-10T09:00:00Z",
122      "appointmentLocation": "SGH Main Building, Room 512"
123    }
124  ],
125  "metadata": {
126    "hasNext": true,
127    "totalCount": 25,
128    "nextParams": {
129      "offset": 10,
130      "pageSize": 10
131    }
132  }
133}
Was this page helpful?
Previous

Get referral details

Next
Built with

Authentication

Authorizationstring

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

Path parameters

institutionIdTypeenumRequired
The type of institution ID
Allowed values:
institutionIdstringRequired
The institution ID

Query parameters

offsetdoubleOptionalDefaults to 0
Offset for pagination
pageSizedoubleOptional<=1000Defaults to 10
Number of items per page
statuslist of enumsOptional
roleenumOptional
To filter by the institution's role in the referral. e.g. For outbound referrals, use "sender'
Allowed values:
referrerIdstringOptional
To filter by the referrer ID
referrerIdTypeenumOptional

Type of ID specified in referrerId. Use together with referrerId to filter based on referrer.

Allowed values:
patientUinstringOptional
To filter by the patient UIN

Response

datalist of objects
metadataobject

Errors

401
Unauthorized Error