Retrieves a paginated list of referrals

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

{
  "data": [
    {
      "id": "id",
      "sender": {
        "hciCode": "hciCode",
        "name": "name",
        "block": "block",
        "streetName": "streetName",
        "postalCode": "postalCode"
      },
      "senderSystem": "HAS",
      "offering": {
        "id": "id",
        "name": "name",
        "institutionHciCode": "institutionHciCode",
        "institution": {
          "hciCode": "hciCode",
          "name": "name",
          "block": "block",
          "streetName": "streetName",
          "postalCode": "postalCode"
        },
        "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"
      },
      "patient": {
        "uin": "uin",
        "name": "name",
        "phoneNumber": "91234567",
        "dob": "1990-01-01",
        "gender": "Male"
      },
      "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"
            }
          ]
        }
      ],
      "url": "url",
      "clinicLicenseNumber": "clinicLicenseNumber",
      "clinicType": "CHAS-only",
      "clinicalInfo": "clinicalInfo",
      "timeslotStartAt": "2024-05-01T00:00:00Z",
      "appointmentLocation": "appointmentLocation"
    }
  ],
  "metadata": {
    "hasNext": true,
    "totalCount": 1.1,
    "nextParams": {
      "offset": 1.1,
      "pageSize": 1.1
    }
  }
}

Authentication

Authorizationstring

API Key authentication via header

Query parameters

offsetdoubleOptionalDefaults to 0

Offset for pagination

pageSizedoubleOptional<=1000Defaults to 10

Number of items per page

statusenumOptional

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

Referrals List Request Unauthorized Error