Fetches one referral | Referral Exchange docs

curl -G https://dummy-url-see-smartcms-spec/api/v1/public/referrals/referralId \
     -H "Content-Type: application/json" \
     --data-urlencode requesterIdentifier=doctor.jane@example.com \
     -d institutionIdType=hci \
     -d institutionId=S1234

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sender": {
    "hciCode": "S1234",
    "name": "Singapore General Hospital",
    "block": "Outram Road",
    "streetName": "Outram Road",
    "buildingName": "Main Building",
    "floorNumber": "5",
    "unitNumber": "05-12",
    "postalCode": "169608"
  },
  "senderSystem": "HAS",
  "offering": {
    "id": "offering-001",
    "name": "Gastroenterology Specialist Clinic",
    "institutionHciCode": "S1234",
    "institution": {
      "hciCode": "S1234",
      "name": "Singapore General Hospital",
      "block": "Outram Road",
      "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-15",
    "gender": "Male",
    "chasStatus": "Orange",
    "address": {
      "postalCode": "560123",
      "block": "123",
      "streetName": "Bukit Timah Road",
      "floorNumber": "12",
      "unitNumber": "12-34"
    },
    "residentialStatus": "SC",
    "nationality": "Singapore",
    "isHsgEnrolled": true
  },
  "referringDoctor": {
    "mcr": "MCR1234567",
    "idType": "mcr",
    "name": "Dr. Jane Lee",
    "email": "jane.lee@clinic.sg",
    "contactNumber": "98765432"
  },
  "isSubsidised": true,
  "isUrgent": true,
  "createdAt": "2024-05-01T08:30: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"
    }
  ],
  "forms": [
    {
      "id": "form-001",
      "url": "https://refer.health.gov.sg/forms/form-001",
      "description": "Patient Referral Form",
      "isFilled": true,
      "formResponses": [
        {
          "question": "Describe the symptoms in detail",
          "id": "f1q1",
          "answer": "Patient reports intermittent abdominal pain over 2 weeks."
        }
      ],
      "fields": [
        {
          "fieldType": "text",
          "label": "Symptoms Description"
        }
      ],
      "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 mild asthma. No known drug allergies. Previous treatment included antacids."
}

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

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.

Errors

404

Not Found Error