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 '{
  "institutionIdType": "hci",
  "institutionId": "S1234A"
}'

{
  "id": "a3f1c9e2-4b7d-4f8a-9c2e-123456789abc",
  "sender": {
    "hciCode": "S1234A",
    "name": "Singapore General Hospital",
    "block": "1",
    "streetName": "Outram Road",
    "buildingName": "Main Building",
    "floorNumber": "5",
    "unitNumber": "05-12",
    "postalCode": "169608"
  },
  "senderSystem": "HAS",
  "offering": {
    "id": "offering-001",
    "name": "Gastroenterology Specialist Clinic",
    "institutionHciCode": "S1234A",
    "institution": {
      "hciCode": "S1234A",
      "name": "Singapore General Hospital",
      "block": "1",
      "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": "S7654321D",
    "name": "John Tan",
    "phoneNumber": "91234567",
    "dob": "1985-07-15",
    "gender": "Male",
    "chasStatus": "Orange",
    "address": {
      "postalCode": "560123",
      "block": "123",
      "streetName": "Jurong West Street 41",
      "floorNumber": "12",
      "unitNumber": "12-34"
    },
    "residentialStatus": "SC",
    "nationality": "Singapore",
    "isHsgEnrolled": true
  },
  "referringDoctor": {
    "mcr": "MCR1234567A",
    "idType": "mcr",
    "name": "Dr. Lim Wei",
    "email": "weilim@clinic.sg",
    "contactNumber": "98765432"
  },
  "isSubsidised": true,
  "isUrgent": true,
  "createdAt": "2024-05-01T00:00:00Z",
  "updatedAt": "2024-05-01T00:00: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"
    }
  ],
  "status": "cancelled",
  "isCancellable": false,
  "notes": [
    {
      "id": "note-001",
      "content": "Referral cancelled due to patient request.",
      "authorHciCode": "S1234A",
      "authorName": "Dr. Lim Wei",
      "createdAt": 1682899200,
      "updatedAt": 1682899200
    }
  ],
  "forms": [
    {
      "id": "form-001",
      "url": "https://refer.health.gov.sg/forms/form-001",
      "description": "Patient medical history form",
      "isFilled": true,
      "formResponses": [
        {
          "question": "Has the patient had previous surgeries?",
          "id": "q2",
          "answer": "No"
        }
      ],
      "fields": [
        {}
      ],
      "version": 1.1,
      "migrated": true
    }
  ],
  "url": "https://refer.health.gov.sg/referrals/a3f1c9e2-4b7d-4f8a-9c2e-123456789abc",
  "clinicLicenseNumber": "CLN1234567",
  "clinicType": "CHAS-only",
  "clinicalInfo": "Patient has a history of gastritis and is allergic to penicillin.",
  "timeslotStartAt": "2024-05-10T09:00:00Z",
  "appointmentLocation": "Singapore General Hospital, Main Building, Level 5"
}

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.

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

cancelNotestringOptional<=8000 characters

Optional note to save when cancelling the referral

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

statusenum

isCancellableboolean

Whether this referral can be cancelled

noteslist of objects

formslist of objectsOptional

List of forms required to complete the referral

urlstringOptional

URL to view the referral

clinicLicenseNumberstringOptional

Clinic license number

clinicTypeenumOptional

Clinic type

clinicalInfostringOptional

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

timeslotStartAtstringOptional

Timeslot start time (ISO datetime)

appointmentLocationstringOptional

Appointment location

Errors

401

Unauthorized Error