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-001",
18        "name": "Cardiology Consultation",
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": "Cardiology",
37        "nehrCode": "CARD123"
38      },
39      "patient": {
40        "uin": "S1234567A",
41        "name": "John Tan",
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        "isHsgEnrolled": true
56      },
57      "referringDoctor": {
58        "mcr": "MCR123456",
59        "idType": "mcr",
60        "name": "Dr. Lim Wei",
61        "email": "lim.wei@example.com",
62        "contactNumber": "98765432"
63      },
64      "isSubsidised": true,
65      "isUrgent": true,
66      "createdAt": "2024-05-01T08:30:00Z",
67      "updatedAt": "2024-05-02T10:00:00Z",
68      "formResponses": [
69        {
70          "question": "What is the primary reason for referral?",
71          "id": "q1",
72          "answer": "Chest pain and shortness of breath"
73        }
74      ],
75      "attachments": [
76        {
77          "url": "https://refer.health.gov.sg/attachments/ecg-report-20240501.png",
78          "name": "ecg-report.png"
79        }
80      ],
81      "coreStatus": "draft",
82      "isCancellable": true,
83      "notes": [
84        {
85          "id": "note-001",
86          "content": "Patient prefers morning appointments.",
87          "authorHciCode": "S1234",
88          "authorName": "Nurse Lee",
89          "createdAt": 1683000000,
90          "updatedAt": 1683003600
91        }
92      ],
93      "status": "draft",
94      "forms": [
95        {
96          "id": "form-001",
97          "url": "https://refer.health.gov.sg/forms/form-001",
98          "description": "Cardiology referral form",
99          "isFilled": true,
100          "formResponses": [
101            {
102              "question": "What is the primary reason for referral?",
103              "id": "q1",
104              "answer": "Chest pain and shortness of breath"
105            }
106          ],
107          "remark": "Please complete all fields",
108          "fields": [
109            {}
110          ],
111          "version": 1.1,
112          "migrated": true
113        }
114      ],
115      "url": "https://refer.health.gov.sg/referrals/ref-20240601-001",
116      "clinicLicenseNumber": "CLN-987654",
117      "clinicType": "CHAS-only",
118      "clinicalInfo": "Patient has a history of hypertension and diabetes. Allergic to penicillin.",
119      "timeslotStartAt": "2024-05-10T09:00:00Z",
120      "appointmentLocation": "SGH Cardiology Clinic, 5th Floor"
121    }
122  ],
123  "metadata": {
124    "hasNext": true,
125    "totalCount": 1,
126    "nextParams": {
127      "offset": 10,
128      "pageSize": 10
129    }
130  }
131}
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