Get referral details | Referral Exchange docs

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": "offering-001",
    "name": "Gastroenterology Consultation",
    "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",
    "isHsgEnrolled": true
  },
  "referringDoctor": {
    "mcr": "MCR123456",
    "idType": "mcr",
    "name": "Dr. Lim Wei",
    "email": "lim.wei@clinic.sg",
    "contactNumber": "98765432"
  },
  "isSubsidised": true,
  "isUrgent": true,
  "createdAt": "2024-05-01T00:00:00Z",
  "updatedAt": "2024-05-02T10:15: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 earlier 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": "Outram Road Clinic, Room 12"
    }
  ],
  "status": "draft",
  "forms": [
    {
      "id": "form-001",
      "url": "https://refer.health.gov.sg/forms/form-001",
      "description": "Patient referral form for gastroenterology",
      "isFilled": true,
      "formResponses": [
        {
          "question": "What are the patient's main symptoms?",
          "id": "q1",
          "answer": "Abdominal pain and nausea"
        }
      ],
      "fields": [
        {
          "fieldType": "text",
          "label": "Symptoms",
          "required": true
        }
      ],
      "version": 1.1,
      "migrated": true
    }
  ],
  "url": "https://refer.health.gov.sg/referrals/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clinicLicenseNumber": "CLN-987654",
  "clinicType": "CHAS-only",
  "clinicalInfo": "Patient has a history of gastritis and allergic to penicillin.",
  "timeslotStartAt": "2024-05-10T14:00:00Z",
  "appointmentLocation": "Singapore General Hospital, Outram Road"
}

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.

formslist of objects

List of forms required to complete the referral

urlstring

URL to view the referral

clinicLicenseNumberstring

Clinic license number

clinicTypeenum

Clinic type

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

401

Unauthorized Error

404

Not Found Error