Retrieves a paginated list of referrals

{
  "data": [
    {
      "id": "ref-1234567890",
      "sender": {
        "hciCode": "S1234",
        "name": "Singapore General Hospital",
        "block": "12",
        "streetName": "Outram Road",
        "buildingName": "SGH Medical Centre",
        "floorNumber": "5",
        "unitNumber": "05-10",
        "postalCode": "169608"
      },
      "senderSystem": "HAS",
      "offering": {
        "id": "off-987654321",
        "name": "Gastroenterology Consultation",
        "institutionHciCode": "S1234",
        "institution": {
          "hciCode": "S1234",
          "name": "Singapore General Hospital",
          "block": "12",
          "streetName": "Outram Road",
          "buildingName": "SGH Medical Centre",
          "floorNumber": "5",
          "unitNumber": "05-10",
          "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": "Jurong West Street 41",
          "floorNumber": "10",
          "unitNumber": "10-15"
        },
        "residentialStatus": "SC",
        "nationality": "Singapore",
        "isHsgEnrolled": true
      },
      "referringDoctor": {
        "mcr": "MCR123456",
        "idType": "mcr",
        "name": "Dr. Lim Wei",
        "email": "weilim@sgh.com.sg",
        "contactNumber": "98765432"
      },
      "isSubsidised": true,
      "isUrgent": false,
      "createdAt": "2024-05-01T08:30:00Z",
      "updatedAt": "2024-05-02T10:00:00Z",
      "formResponses": [
        {
          "question": "Has the patient experienced abdominal pain?",
          "id": "q1",
          "answer": "Yes, intermittent pain over the past week"
        }
      ],
      "attachments": [
        {
          "url": "https://refer.health.gov.sg/attachments/ecg-report-12345.png",
          "name": "ecg-report.png"
        }
      ],
      "status": "pending-acceptance",
      "isCancellable": true,
      "notes": [
        {
          "id": "note-001",
          "content": "Patient requested morning appointment.",
          "authorHciCode": "S1234",
          "authorName": "Nurse Tan",
          "createdAt": 1682923200000,
          "updatedAt": 1682926800000
        }
      ],
      "forms": [
        {
          "id": "form-001",
          "url": "https://refer.health.gov.sg/forms/form-001",
          "description": "Gastroenterology referral form",
          "isFilled": true,
          "formResponses": [
            {
              "question": "Describe the symptoms",
              "id": "symptoms",
              "answer": "Intermittent abdominal pain and nausea"
            }
          ],
          "fields": [
            {
              "fieldType": "text",
              "label": "Symptoms description"
            }
          ],
          "version": 1.1,
          "migrated": true
        }
      ],
      "url": "https://refer.health.gov.sg/referrals/ref-1234567890",
      "clinicLicenseNumber": "CLN-56789",
      "clinicType": "CHAS-only",
      "clinicalInfo": "Patient has a history of gastritis and is allergic to penicillin.",
      "timeslotStartAt": "2024-05-10T09:00:00Z",
      "appointmentLocation": "SGH Medical Centre, Room 501"
    }
  ],
  "metadata": {
    "hasNext": true,
    "totalCount": 25,
    "nextParams": {
      "offset": 10,
      "pageSize": 10
    }
  }
}

Authentication

Authorizationstring

API key to authenticate for external integrations. Use the format: “ApiKey insert-token-here”

Query parameters

offsetdoubleOptionalDefaults to 0

Offset for pagination

pageSizedoubleOptional<=1000Defaults to 10

Number of items per page

statuslist of enumsOptional

Allowed values:

roleenumOptional

To filter by the institution's role in the referral. e.g. For outbound referrals, use "sender'

Allowed values:

referrerIdstringOptional

To filter by the referrer ID

referrerIdTypeenumOptional

Type of ID specified in referrerId. Use together with referrerId to filter based on referrer.

Allowed values:

patientUinstringOptional

To filter by the patient UIN

hciCodestringOptional

To identify the requesting institution

institutionIdstringOptional

To filter by the requesting institution

Response

datalist of objects

metadataobject

Errors

401

Unauthorized Error

$	curl https://dummy-url-see-smartcms-spec/api/v1/referrals \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"