Delete a draft referral | Referral Exchange docs

curl -X DELETE "https://dummy-url-see-smartcms-spec/api/v1/referrals/referralId?institutionIdType=hci&institutionId=institutionId" \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sender": {
    "hciCode": "S1234",
    "name": "Singapore General Hospital",
    "block": "123",
    "streetName": "Outram Road",
    "buildingName": "Main Building",
    "floorNumber": "5",
    "unitNumber": "05-12",
    "postalCode": "169608"
  },
  "senderSystem": "HAS",
  "offering": {
    "id": "offering-001",
    "name": "Cardiology Consultation",
    "institutionHciCode": "S1234",
    "institution": {
      "hciCode": "S1234",
      "name": "Singapore General Hospital",
      "block": "123",
      "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": "Cardiology",
    "nehrCode": "CARD123"
  },
  "patient": {
    "uin": "S1234567A",
    "name": "John Tan",
    "phoneNumber": "91234567",
    "dob": "1985-07-15",
    "gender": "Male",
    "chasStatus": "Orange",
    "address": {
      "postalCode": "560123",
      "block": "45",
      "streetName": "Ang Mo Kio Avenue 3",
      "floorNumber": "12",
      "unitNumber": "12-34"
    },
    "residentialStatus": "SC",
    "nationality": "Singapore",
    "isHsgEnrolled": true
  },
  "referringDoctor": {
    "mcr": "MCR123456",
    "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 is the primary reason for referral?",
      "id": "q1",
      "answer": "Chest pain and shortness of breath"
    }
  ],
  "attachments": [
    {
      "url": "https://refer.health.gov.sg/attachments/ecg-report-20240430.png",
      "name": "ecg-report.png"
    }
  ],
  "status": "draft",
  "isCancellable": true,
  "notes": [
    {
      "id": "note-001",
      "content": "Initial referral draft created.",
      "authorHciCode": "S1234",
      "authorName": "Dr. Lim Wei",
      "createdAt": 1682899200,
      "updatedAt": 1682899200
    }
  ],
  "forms": [
    {
      "id": "form-001",
      "url": "https://refer.health.gov.sg/forms/form-001",
      "description": "Cardiology referral form",
      "isFilled": true,
      "formResponses": [
        {
          "question": "Describe symptoms",
          "id": "f1q1",
          "answer": "Intermittent chest pain for 2 weeks"
        }
      ],
      "fields": [
        {
          "fieldType": "text",
          "label": "Symptoms description"
        }
      ],
      "version": 1.1,
      "migrated": true
    }
  ],
  "url": "https://refer.health.gov.sg/referrals/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clinicLicenseNumber": "CLN-987654",
  "clinicType": "CHAS-only",
  "clinicalInfo": "Patient has a history of hypertension and diabetes. Allergic to penicillin.",
  "timeslotStartAt": "2024-05-10T09:00:00Z",
  "appointmentLocation": "SGH Cardiology Clinic, Level 5"
}

Authentication

Authorizationstring

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

Path parameters

referralIdstringRequiredformat: "uuid"

Referral ID

Query parameters

institutionIdTypeenumRequired

The type of institution ID

Allowed values:

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

statusenum

isCancellableboolean

Whether this referral can be cancelled

noteslist 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

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