Fetches one referral | Referral Exchange docs

curl -G https://dummy-url-see-smartcms-spec/api/v1/public/referrals/referralId \
     --data-urlencode requesterIdentifier=requester@example.com \
     -d institutionIdType=hci \
     -d institutionId=institutionId

{
  "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"
    }
  ],
  "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"
}

Path parameters

referralIdstringRequired

Referral ID

Query parameters

additionalFieldenumOptional

Allowed values:

requesterIdentifierstringRequired

Identifier for the individual requesting the referral. Preferred to be an email.

institutionIdType"hci"Required

The type of institution ID

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

Allowed values:

clinicalInfostring

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

Errors

404

Public Get Referral Request Not Found Error