Create a new referral | Referral Exchange docs

curl -X POST https://dummy-url-see-smartcms-spec/api/v1/referrals \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "patient": {
    "uin": "uin",
    "name": "name",
    "phoneNumber": "91234567",
    "dob": "1990-01-01",
    "gender": "Male"
  },
  "offeringId": "offeringId",
  "senderHciCode": "senderHciCode",
  "senderInstitutionName": "senderInstitutionName",
  "doctorMcr": "doctorMcr",
  "doctorName": "doctorName",
  "doctorEmail": "doctorEmail",
  "doctorContactNumber": "doctorContactNumber",
  "isSubsidised": true,
  "isUrgent": true,
  "isDraft": true,
  "formResponses": [
    {
      "question": "question",
      "id": "id",
      "answer": "answer"
    }
  ]
}'

{
  "id": "id",
  "sender": {
    "hciCode": "hciCode",
    "name": "name",
    "block": "block",
    "streetName": "streetName",
    "postalCode": "postalCode",
    "buildingName": "buildingName",
    "floorNumber": "floorNumber",
    "unitNumber": "unitNumber"
  },
  "senderSystem": "HAS",
  "offering": {
    "id": "id",
    "name": "name",
    "institutionHciCode": "institutionHciCode",
    "institution": {
      "hciCode": "hciCode",
      "name": "name",
      "block": "block",
      "streetName": "streetName",
      "postalCode": "postalCode",
      "buildingName": "buildingName",
      "floorNumber": "floorNumber",
      "unitNumber": "unitNumber"
    },
    "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",
    "nehrCode": "nehrCode"
  },
  "patient": {
    "uin": "uin",
    "name": "name",
    "phoneNumber": "91234567",
    "dob": "1990-01-01",
    "gender": "Male",
    "address": {
      "postalCode": "postalCode",
      "block": "block",
      "streetName": "streetName",
      "floorNumber": "floorNumber",
      "unitNumber": "unitNumber"
    },
    "residentialStatus": "SC",
    "isHsgEnrolled": true,
    "chasStatus": "chasStatus"
  },
  "referringDoctor": {
    "mcr": "mcr",
    "idType": "mcr",
    "name": "name",
    "email": "email",
    "contactNumber": "contactNumber"
  },
  "isSubsidised": true,
  "isUrgent": true,
  "createdAt": "2024-05-01T00:00:00Z",
  "updatedAt": "2024-05-01T00:00:00Z",
  "formResponses": [
    {
      "question": "question",
      "id": "id",
      "answer": "answer"
    }
  ],
  "attachments": [
    {
      "url": "url",
      "name": "ecg-report.png"
    }
  ],
  "status": "draft",
  "isCancellable": true,
  "notes": [
    {
      "id": "id",
      "content": "content",
      "authorHciCode": "authorHciCode",
      "authorName": "authorName",
      "createdAt": 1.1,
      "updatedAt": 1.1
    }
  ],
  "forms": [
    {
      "id": "id",
      "url": "url",
      "description": "description",
      "isFilled": true,
      "formResponses": [
        {
          "question": "question",
          "id": "id",
          "answer": "answer"
        }
      ],
      "fields": [
        {
          "key": "value"
        }
      ],
      "version": 1.1,
      "migrated": true
    }
  ],
  "url": "url",
  "clinicLicenseNumber": "clinicLicenseNumber",
  "clinicType": "CHAS-only",
  "clinicalInfo": "clinicalInfo",
  "timeslotStartAt": "2024-05-01T00:00:00Z",
  "appointmentLocation": "appointmentLocation"
}

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.

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

isCancellableboolean

Whether this referral can be cancelled

noteslist of objects

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

Errors

400

Referrals Upsert Request Bad Request Error

401

Referrals Upsert Request Unauthorized Error