Create a new referral | Referral Exchange docs

1 import requests 2 3 url = "https://dummy-url-see-smartcms-spec/api/v1/referrals" 4 5 payload = { 6 "patient": { 7 "uin": "uin", 8 "name": "name", 9 "phoneNumber": "91234567", 10 "dob": "1990-01-01", 11 "gender": "Male" 12 }, 13 "offeringId": "offeringId", 14 "senderHciCode": "senderHciCode", 15 "senderInstitutionName": "senderInstitutionName", 16 "doctorMcr": "doctorMcr", 17 "doctorName": "doctorName", 18 "doctorEmail": "doctorEmail", 19 "doctorContactNumber": "doctorContactNumber", 20 "isSubsidised": True, 21 "isUrgent": True, 22 "isDraft": True, 23 "formResponses": [ 24 { 25 "question": "question", 26 "id": "id", 27 "answer": "answer" 28 } 29 ] 30 } 31 headers = { 32 "Authorization": "<apiKey>", 33 "Content-Type": "application/json" 34 } 35 36 response = requests.post(url, json=payload, headers=headers) 37 38 print(response.json())

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 "forms": [ 88 { 89 "id": "id", 90 "url": "url", 91 "description": "description", 92 "isFilled": true, 93 "formResponses": [ 94 { 95 "question": "question", 96 "id": "id", 97 "answer": "answer" 98 } 99 ] 100 } 101 ], 102 "url": "url", 103 "clinicLicenseNumber": "clinicLicenseNumber", 104 "clinicType": "CHAS-only", 105 "clinicalInfo": "clinicalInfo", 106 "timeslotStartAt": "2024-05-01T00:00:00Z", 107 "appointmentLocation": "appointmentLocation" 108 }

Authentication

Authorizationstring

API Key authentication via header

Request

This endpoint expects an object.

patientobjectRequired

offeringIdstringRequired

senderHciCodestringRequired

HCI code of the institution authoring this referral.

senderInstitutionNamestringRequired

Name of the institution authoring this referral.

doctorMcrstringRequired

MCR number of the doctor authoring this referral.

doctorNamestringRequired

Name of the doctor authoring this referral.

doctorEmailstringRequired

Email of the doctor authoring this referral.

doctorContactNumberstringRequiredformat: "^[3689][0-9]{7}$"

Contact number of the doctor authoring this referral.

isSubsidisedbooleanRequiredDefaults to false

isUrgentbooleanRequiredDefaults to false

isDraftbooleanRequiredDefaults to false

In draft state, further edits can be made. No referral will be emitted to the service provider yet.

formResponseslist of objectsRequired

Form responses

referrerIdTypeenumOptional

Type of ID specified in referrerId.

Allowed values:

idstringOptionalformat: "uuid"

Referral ID

timeslotStartAtdoubleOptional

Timeslot start time, in milliseconds since epoch.

clinicLicenseNumberstringOptional

Clinic license number

clinicTypeenumOptional

Clinic type

Allowed values:

clinicalInfostringOptional

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

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

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

Request

Response

Errors