Retrieves a paginated list of referrals

1 curl https://dummy-url-see-smartcms-spec/api/v1/referrals \ 2 -H "Authorization: <apiKey>"

1 { 2 "data": [ 3 { 4 "id": "id", 5 "sender": { 6 "hciCode": "hciCode", 7 "name": "name", 8 "block": "block", 9 "streetName": "streetName", 10 "postalCode": "postalCode" 11 }, 12 "senderSystem": "HAS", 13 "offering": { 14 "id": "id", 15 "name": "name", 16 "institutionHciCode": "institutionHciCode", 17 "institution": { 18 "hciCode": "hciCode", 19 "name": "name", 20 "block": "block", 21 "streetName": "streetName", 22 "postalCode": "postalCode" 23 }, 24 "system": "HAS", 25 "description": "Before proceeding with your referral, please refer to the guidelines of referrals to this SOC. https://go.gov.sg/refx-nuhs-gastro-guidelines", 26 "isActive": true, 27 "isSubsidisable": true, 28 "timeslotPolicy": "timeslot-required" 29 }, 30 "patient": { 31 "uin": "uin", 32 "name": "name", 33 "phoneNumber": "91234567", 34 "dob": "1990-01-01", 35 "gender": "Male", 36 "chasStatus": "chasStatus" 37 }, 38 "referringDoctor": { 39 "mcr": "mcr", 40 "idType": "mcr", 41 "name": "name", 42 "email": "email", 43 "contactNumber": "contactNumber" 44 }, 45 "isSubsidised": true, 46 "isUrgent": true, 47 "createdAt": "2024-05-01T00:00:00Z", 48 "updatedAt": "2024-05-01T00:00:00Z", 49 "formResponses": [ 50 { 51 "question": "question", 52 "id": "id", 53 "answer": "answer" 54 } 55 ], 56 "attachments": [ 57 { 58 "url": "url", 59 "name": "ecg-report.png" 60 } 61 ], 62 "status": "draft", 63 "notes": [ 64 { 65 "id": "id", 66 "content": "content", 67 "authorHciCode": "authorHciCode", 68 "authorName": "authorName", 69 "createdAt": 1.1, 70 "updatedAt": 1.1 71 } 72 ], 73 "forms": [ 74 { 75 "id": "id", 76 "url": "url", 77 "description": "description", 78 "isFilled": true, 79 "formResponses": [ 80 { 81 "question": "question", 82 "id": "id", 83 "answer": "answer" 84 } 85 ] 86 } 87 ], 88 "url": "url", 89 "clinicLicenseNumber": "clinicLicenseNumber", 90 "clinicType": "CHAS-only", 91 "clinicalInfo": "clinicalInfo", 92 "timeslotStartAt": "2024-05-01T00:00:00Z", 93 "appointmentLocation": "appointmentLocation" 94 } 95 ], 96 "metadata": { 97 "hasNext": true, 98 "totalCount": 1.1, 99 "nextParams": { 100 "offset": 1.1, 101 "pageSize": 1.1 102 } 103 } 104 }

Authentication

Authorizationstring

API Key authentication via header

Query parameters

offsetdoubleOptionalDefaults to 0

Offset for pagination

pageSizedoubleOptional<=1000Defaults to 10

Number of items per page

statusenumOptional

Allowed values:

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

hciCodestringOptional

To identify the requesting institution

institutionIdstringOptional

To filter by the requesting institution

Response

datalist of objects

metadataobject

Authentication

Query parameters

Response

Errors