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": "off-9876",
16     "name": "Gastroenterology Specialist Outpatient 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": "Ang Mo Kio Avenue 3",
48       "floorNumber": "12",
49       "unitNumber": "12-34"
50     },
51     "residentialStatus": "SC",
52     "nationality": "Singapore"
53   },
54   "referringDoctor": {
55     "mcr": "MCR123456",
56     "idType": "mcr",
57     "name": "Dr. Lim Wei",
58     "email": "dr.limwei@clinic.sg",
59     "contactNumber": "98765432"
60   },
61   "isSubsidised": true,
62   "isUrgent": true,
63   "createdAt": "2024-05-01T00:00:00Z",
64   "updatedAt": "2024-05-01T09:00:00Z",
65   "formResponses": [
66     {
67       "question": "What are the patient's main symptoms?",
68       "id": "q1",
69       "answer": "Abdominal pain and nausea"
70     }
71   ],
72   "attachments": [
73     {
74       "url": "https://refer.health.gov.sg/attachments/ecg-report.png",
75       "name": "ecg-report.png"
76     }
77   ],
78   "coreStatus": "draft",
79   "isCancellable": true,
80   "notes": [
81     {
82       "id": "note-001",
83       "content": "Patient requested early appointment if possible.",
84       "authorHciCode": "S1234",
85       "authorName": "Dr. Lim Wei",
86       "createdAt": 1719820800000,
87       "updatedAt": 1719824400000
88     }
89   ],
90   "timelineEvents": [
91     {
92       "type": "draft.created",
93       "description": "PartnersBuddy rescheduled the appointment from 16 Dec, 10:00 PM to 21 Dec,11:00 PM",
94       "producedAt": 1718764800000,
95       "system": "HAS"
96     }
97   ],
98   "links": [
99     {
100       "referralId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
101       "url": "https://refer.health.gov.sg/referrals/3fa85f64-5717-4562-b3fc-2c963f66afa6/amend",
102       "type": "amend",
103       "label": "Amend Referral"
104     }
105   ],
106   "appointments": [
107     {
108       "status": "scheduled",
109       "visitDateTime": "2024-06-15T09:30:00Z",
110       "isDischarged": false,
111       "institutionName": "Singapore General Hospital",
112       "specialtyName": "Gastroenterology",
113       "subSpecialtyName": "Hepatology",
114       "location": "Clinic 5, SGH"
115     }
116   ],
117   "status": "draft",
118   "submittedAt": "2024-05-01T08:30:00Z",
119   "forms": [
120     {
121       "id": "form-001",
122       "url": "https://refer.health.gov.sg/forms/form-001",
123       "description": "Gastroenterology Referral Form",
124       "isFilled": true,
125       "formResponses": [
126         {
127           "question": "What are the patient's main symptoms?",
128           "id": "q1",
129           "answer": "Abdominal pain and nausea"
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-2024-5678",
142   "clinicType": "CHAS-only",
143   "clinicalInfo": "Patient has a history of gastritis and allergic to penicillin.",
144   "timeslotStartAt": "2024-05-10T14:00:00Z",
145   "appointmentLocation": "SGH Outpatient Clinic 5",
146   "nehrForm": "<html><body><h1>Referral Form</h1><p>Patient details and referral info</p></body></html>",
147   "nehrFormType": "Gastroenterology|Referral"
148 }

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sender": {
    "hciCode": "S1234",
    "name": "Singapore General Hospital",
    "block": "123",
    "streetName": "Outram Road",
    "buildingName": "Main Building",
    "floorNumber": "5",
    "unitNumber": "05-12",
    "postalCode": "169608"
  },
  "senderSystem": "HAS",
  "offering": {
    "id": "off-9876",
    "name": "Gastroenterology Specialist Outpatient Clinic",
    "institutionHciCode": "S1234",
    "institution": {
      "hciCode": "S1234",
      "name": "Singapore General Hospital",
      "block": "123",
      "streetName": "Outram Road",
      "buildingName": "Main Building",
      "floorNumber": "5",
      "unitNumber": "05-12",
      "postalCode": "169608"
    },
    "system": "HAS",
    "description": "Before proceeding with your referral, please refer to the [guidelines of referrals to this SOC](https://go.gov.sg/refx-nuhs-gastro-guidelines).",
    "isActive": true,
    "isSubsidisable": true,
    "timeslotPolicy": "timeslot-required",
    "category": "aac",
    "specialty": "Gastroenterology",
    "nehrCode": "GASTRO123"
  },
  "patient": {
    "uin": "S1234567A",
    "name": "John Tan",
    "phoneNumber": "91234567",
    "dob": "1985-07-20",
    "gender": "Male",
    "chasStatus": "Orange",
    "address": {
      "postalCode": "560123",
      "block": "45",
      "streetName": "Ang Mo Kio Avenue 3",
      "floorNumber": "12",
      "unitNumber": "12-34"
    },
    "residentialStatus": "SC",
    "nationality": "Singapore"
  },
  "referringDoctor": {
    "mcr": "MCR123456",
    "idType": "mcr",
    "name": "Dr. Lim Wei",
    "email": "dr.limwei@clinic.sg",
    "contactNumber": "98765432"
  },
  "isSubsidised": true,
  "isUrgent": true,
  "createdAt": "2024-05-01T00:00:00Z",
  "updatedAt": "2024-05-01T09:00:00Z",
  "formResponses": [
    {
      "question": "What are the patient's main symptoms?",
      "id": "q1",
      "answer": "Abdominal pain and nausea"
    }
  ],
  "attachments": [
    {
      "url": "https://refer.health.gov.sg/attachments/ecg-report.png",
      "name": "ecg-report.png"
    }
  ],
  "coreStatus": "draft",
  "isCancellable": true,
  "notes": [
    {
      "id": "note-001",
      "content": "Patient requested early appointment if possible.",
      "authorHciCode": "S1234",
      "authorName": "Dr. Lim Wei",
      "createdAt": 1719820800000,
      "updatedAt": 1719824400000
    }
  ],
  "timelineEvents": [
    {
      "type": "draft.created",
      "description": "PartnersBuddy rescheduled the appointment from 16 Dec, 10:00 PM to 21 Dec,11:00 PM",
      "producedAt": 1718764800000,
      "system": "HAS"
    }
  ],
  "links": [
    {
      "referralId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "url": "https://refer.health.gov.sg/referrals/3fa85f64-5717-4562-b3fc-2c963f66afa6/amend",
      "type": "amend",
      "label": "Amend Referral"
    }
  ],
  "appointments": [
    {
      "status": "scheduled",
      "visitDateTime": "2024-06-15T09:30:00Z",
      "isDischarged": false,
      "institutionName": "Singapore General Hospital",
      "specialtyName": "Gastroenterology",
      "subSpecialtyName": "Hepatology",
      "location": "Clinic 5, SGH"
    }
  ],
  "status": "draft",
  "submittedAt": "2024-05-01T08:30:00Z",
  "forms": [
    {
      "id": "form-001",
      "url": "https://refer.health.gov.sg/forms/form-001",
      "description": "Gastroenterology Referral Form",
      "isFilled": true,
      "formResponses": [
        {
          "question": "What are the patient's main symptoms?",
          "id": "q1",
          "answer": "Abdominal pain and nausea"
        }
      ],
      "remark": "Please complete all fields",
      "fields": [
        {}
      ],
      "version": 1.1,
      "migrated": true
    }
  ],
  "url": "https://refer.health.gov.sg/referrals/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clinicLicenseNumber": "CLN-2024-5678",
  "clinicType": "CHAS-only",
  "clinicalInfo": "Patient has a history of gastritis and allergic to penicillin.",
  "timeslotStartAt": "2024-05-10T14:00:00Z",
  "appointmentLocation": "SGH Outpatient Clinic 5",
  "nehrForm": "<html><body><h1>Referral Form</h1><p>Patient details and referral info</p></body></html>",
  "nehrFormType": "Gastroenterology|Referral"
}

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.

submittedAtstring

Submitted at (ISO datetime). Absent if the referral is a draft.

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

$	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": "off-9876",
16	"name": "Gastroenterology Specialist Outpatient 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": "Ang Mo Kio Avenue 3",
48	"floorNumber": "12",
49	"unitNumber": "12-34"
50	},
51	"residentialStatus": "SC",
52	"nationality": "Singapore"
53	},
54	"referringDoctor": {
55	"mcr": "MCR123456",
56	"idType": "mcr",
57	"name": "Dr. Lim Wei",
58	"email": "dr.limwei@clinic.sg",
59	"contactNumber": "98765432"
60	},
61	"isSubsidised": true,
62	"isUrgent": true,
63	"createdAt": "2024-05-01T00:00:00Z",
64	"updatedAt": "2024-05-01T09:00:00Z",
65	"formResponses": [
66	{
67	"question": "What are the patient's main symptoms?",
68	"id": "q1",
69	"answer": "Abdominal pain and nausea"
70	}
71	],
72	"attachments": [
73	{
74	"url": "https://refer.health.gov.sg/attachments/ecg-report.png",
75	"name": "ecg-report.png"
76	}
77	],
78	"coreStatus": "draft",
79	"isCancellable": true,
80	"notes": [
81	{
82	"id": "note-001",
83	"content": "Patient requested early appointment if possible.",
84	"authorHciCode": "S1234",
85	"authorName": "Dr. Lim Wei",
86	"createdAt": 1719820800000,
87	"updatedAt": 1719824400000
88	}
89	],
90	"timelineEvents": [
91	{
92	"type": "draft.created",
93	"description": "PartnersBuddy rescheduled the appointment from 16 Dec, 10:00 PM to 21 Dec,11:00 PM",
94	"producedAt": 1718764800000,
95	"system": "HAS"
96	}
97	],
98	"links": [
99	{
100	"referralId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
101	"url": "https://refer.health.gov.sg/referrals/3fa85f64-5717-4562-b3fc-2c963f66afa6/amend",
102	"type": "amend",
103	"label": "Amend Referral"
104	}
105	],
106	"appointments": [
107	{
108	"status": "scheduled",
109	"visitDateTime": "2024-06-15T09:30:00Z",
110	"isDischarged": false,
111	"institutionName": "Singapore General Hospital",
112	"specialtyName": "Gastroenterology",
113	"subSpecialtyName": "Hepatology",
114	"location": "Clinic 5, SGH"
115	}
116	],
117	"status": "draft",
118	"submittedAt": "2024-05-01T08:30:00Z",
119	"forms": [
120	{
121	"id": "form-001",
122	"url": "https://refer.health.gov.sg/forms/form-001",
123	"description": "Gastroenterology Referral Form",
124	"isFilled": true,
125	"formResponses": [
126	{
127	"question": "What are the patient's main symptoms?",
128	"id": "q1",
129	"answer": "Abdominal pain and nausea"
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-2024-5678",
142	"clinicType": "CHAS-only",
143	"clinicalInfo": "Patient has a history of gastritis and allergic to penicillin.",
144	"timeslotStartAt": "2024-05-10T14:00:00Z",
145	"appointmentLocation": "SGH Outpatient Clinic 5",
146	"nehrForm": "<html><body><h1>Referral Form</h1><p>Patient details and referral info</p></body></html>",
147	"nehrFormType": "Gastroenterology\|Referral"
148	}