Cancel a referral | Referral Exchange docs

curl -X POST https://dummy-url-see-smartcms-spec/api/v1/referrals/referralId/cancel \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "cancelNote": "Patient requested cancellation due to scheduling conflict.",
  "institutionIdType": "hci",
  "institutionId": "S1234"
}'

{
  "id": "a3f1c9e2-7b4d-4f8a-9c2e-123456789abc",
  "sender": {
    "hciCode": "S1234",
    "name": "Sunrise Medical Centre",
    "block": "123",
    "streetName": "Health Avenue",
    "buildingName": "Sunrise Building",
    "floorNumber": "5",
    "unitNumber": "05-12",
    "postalCode": "567890"
  },
  "senderSystem": "HAS",
  "offering": {
    "id": "off-9876",
    "name": "General Surgery Consultation",
    "institutionHciCode": "S1234",
    "institution": {
      "hciCode": "S1234",
      "name": "Sunrise Medical Centre",
      "block": "123",
      "streetName": "Health Avenue",
      "buildingName": "Sunrise Building",
      "floorNumber": "5",
      "unitNumber": "05-12",
      "postalCode": "567890"
    },
    "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": "General Surgery",
    "nehrCode": "GS123"
  },
  "patient": {
    "uin": "S1234567A",
    "name": "John Tan",
    "phoneNumber": "91234567",
    "dob": "1985-07-15",
    "gender": "Male",
    "chasStatus": "Orange",
    "address": {
      "postalCode": "560123",
      "block": "45",
      "streetName": "Maple Street",
      "floorNumber": "12",
      "unitNumber": "12-34"
    },
    "residentialStatus": "SC",
    "nationality": "Singapore"
  },
  "referringDoctor": {
    "mcr": "MCR123456",
    "idType": "mcr",
    "name": "Dr. Sarah Lim",
    "email": "sarah.lim@clinic.sg",
    "contactNumber": "98765432"
  },
  "isSubsidised": true,
  "isUrgent": false,
  "createdAt": "2024-05-01T10:15:00Z",
  "updatedAt": "2024-05-02T09:30:00Z",
  "formResponses": [
    {
      "question": "What is the primary reason for referral?",
      "id": "q1",
      "answer": "Abdominal pain"
    }
  ],
  "attachments": [
    {
      "url": "https://refer.health.gov.sg/attachments/ecg-report.png",
      "name": "ecg-report.png"
    }
  ],
  "coreStatus": "cancelled",
  "isCancellable": false,
  "notes": [
    {
      "id": "note-001",
      "content": "Referral cancelled by patient due to personal reasons.",
      "authorHciCode": "S1234",
      "authorName": "Nurse Lee",
      "createdAt": 1683000000,
      "updatedAt": 1683003600
    }
  ],
  "status": "cancelled",
  "submittedAt": "2024-05-01T11:00:00Z",
  "forms": [
    {
      "id": "form-001",
      "url": "https://refer.health.gov.sg/forms/form-001",
      "description": "Pre-consultation questionnaire",
      "isFilled": true,
      "formResponses": [
        {
          "question": "Do you have any allergies?",
          "id": "q2",
          "answer": "No"
        }
      ],
      "remark": "Please complete before appointment",
      "fields": [
        {}
      ],
      "version": 1.1,
      "migrated": true
    }
  ],
  "url": "https://refer.health.gov.sg/referrals/a3f1c9e2-7b4d-4f8a-9c2e-123456789abc",
  "clinicLicenseNumber": "CLN-789456",
  "clinicType": "CHAS-only",
  "clinicalInfo": "Patient has a history of hypertension and is currently on medication.",
  "timeslotStartAt": "2024-05-10T14:00:00Z",
  "appointmentLocation": "Sunrise Medical Centre, 5th Floor, Room 512"
}

Authentication

Authorizationstring

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

Path parameters

referralIdstringRequiredformat: "uuid"

Referral ID

Request

This endpoint expects an object.

cancelNotestringRequired<=8000 characters

Reason for cancelling the referral

institutionIdTypeenumRequired

The type of institution ID

institutionIdstringRequired

The institution ID

cancelledByUinstringOptional

UIN of the person cancelling the referral, if available

cancelledByNamestringOptional

Name of the person cancelling the referral, if available

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

statusenumDeprecated

Deprecated. Use coreStatus instead.

submittedAtstring

Submitted at (ISO datetime). Absent if the referral is a draft.

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