Full details for a referral | Referral Exchange docs

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

1 { 2 "id": "id", 3 "sender": { 4 "hciCode": "hciCode", 5 "name": "name", 6 "block": "block", 7 "streetName": "streetName", 8 "postalCode": "postalCode", 9 "buildingName": "buildingName", 10 "floorNumber": "floorNumber", 11 "unitNumber": "unitNumber" 12 }, 13 "senderSystem": "HAS", 14 "offering": { 15 "id": "id", 16 "name": "name", 17 "institutionHciCode": "institutionHciCode", 18 "institution": { 19 "hciCode": "hciCode", 20 "name": "name", 21 "block": "block", 22 "streetName": "streetName", 23 "postalCode": "postalCode", 24 "buildingName": "buildingName", 25 "floorNumber": "floorNumber", 26 "unitNumber": "unitNumber" 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 }, 35 "patient": { 36 "uin": "uin", 37 "name": "name", 38 "phoneNumber": "91234567", 39 "dob": "1990-01-01", 40 "gender": "Male", 41 "chasStatus": "chasStatus", 42 "address": { 43 "postalCode": "postalCode", 44 "block": "block", 45 "streetName": "streetName", 46 "floorNumber": "floorNumber", 47 "unitNumber": "unitNumber" 48 }, 49 "residentialStatus": "SC", 50 "isHsgEnrolled": true 51 }, 52 "referringDoctor": { 53 "mcr": "mcr", 54 "idType": "mcr", 55 "name": "name", 56 "email": "email", 57 "contactNumber": "contactNumber" 58 }, 59 "isSubsidised": true, 60 "isUrgent": true, 61 "createdAt": "2024-05-01T00:00:00Z", 62 "updatedAt": "2024-05-01T00:00:00Z", 63 "formResponses": [ 64 { 65 "question": "question", 66 "id": "id", 67 "answer": "answer" 68 } 69 ], 70 "attachments": [ 71 { 72 "url": "url", 73 "name": "ecg-report.png" 74 } 75 ], 76 "status": "draft", 77 "notes": [ 78 { 79 "id": "id", 80 "content": "content", 81 "authorHciCode": "authorHciCode", 82 "authorName": "authorName", 83 "createdAt": 1.1, 84 "updatedAt": 1.1 85 } 86 ], 87 "timelineEvents": [ 88 { 89 "type": "draft.created", 90 "description": "PartnersBuddy rescheduled the appointment from 16 Dec, 10:00 PM to 21 Dec,11:00 PM", 91 "producedAt": 1718764800000, 92 "system": "HAS" 93 } 94 ], 95 "links": [ 96 { 97 "type": "upsert", 98 "referralId": "referralId", 99 "url": "url" 100 } 101 ], 102 "appointments": [ 103 { 104 "status": "booked", 105 "visitDateTime": "2024-01-15T09:30:00Z", 106 "isDischarged": true, 107 "institutionName": "institutionName", 108 "specialtyName": "specialtyName", 109 "subSpecialtyName": "subSpecialtyName" 110 } 111 ], 112 "forms": [ 113 { 114 "id": "id", 115 "url": "url", 116 "description": "description", 117 "isFilled": true, 118 "formResponses": [ 119 { 120 "question": "question", 121 "id": "id", 122 "answer": "answer" 123 } 124 ] 125 } 126 ], 127 "url": "url", 128 "clinicLicenseNumber": "clinicLicenseNumber", 129 "clinicType": "CHAS-only", 130 "clinicalInfo": "clinicalInfo", 131 "timeslotStartAt": "2024-05-01T00:00:00Z", 132 "appointmentLocation": "appointmentLocation" 133 }

Authentication

Authorizationstring

API Key authentication via header

Path Parameters

referralIdstringRequired

Referral ID

Query Parameters

additionalFieldenumOptional

Allowed values:

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

statusenum

noteslist of objects

timelineEventslist of objects

linkslist of objects

appointmentslist of objects

formslist of objects or null

List of forms required to complete the referral

urlstring or null

URL to view the referral

clinicLicenseNumberstring or null

Clinic license number

clinicTypeenum or null

Clinic type

Allowed values:

clinicalInfostring or null

Any clinical information that is relevant to the referral, e.g. medical history, drug allergies, treatment provided, etc.

timeslotStartAtstring or null

Timeslot start time (ISO datetime)

appointmentLocationstring or null

Appointment location

Authentication

Path Parameters

Query Parameters

Response

Errors