Convert a referral to draft | Referral Exchange docs

curl -X POST https://dummy-url-see-smartcms-spec/api/v1/referrals/referralId/back-to-draft \
     -H "Content-Type: application/json" \
     -d '{
  "institutionIdType": "hci",
  "institutionId": "S1234A"
}'

{
  "id": "a3f1c9e2-7b4d-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": "off-987654321",
    "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": "S1234567D",
    "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",
      "buildingName": "Jurong East Apartments",
      "city": "Jurong",
      "geographicalArea": "West",
      "country": "Singapore"
    },
    "residentialStatus": "SC",
    "nationality": "Singapore",
    "race": "Chinese",
    "email": "john.tan@example.com"
  },
  "referringDoctor": {
    "mcr": "MCR1234567",
    "idType": "mcr",
    "name": "Dr. Lim Wei",
    "email": "lim.wei@clinic.sg",
    "contactNumber": "98765432"
  },
  "isSubsidised": true,
  "isUrgent": true,
  "createdAt": "2024-05-01T08:30:00Z",
  "updatedAt": "2024-05-01T10: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"
    }
  ],
  "coreStatus": "draft",
  "isCancellable": true,
  "canBackToDraft": true,
  "notes": [
    {
      "id": "note-001",
      "content": "Referral sent back to draft for additional information.",
      "authorHciCode": "S1234A",
      "authorName": "Dr. Lim Wei",
      "createdAt": 1714550400000,
      "updatedAt": 1714554000000
    }
  ],
  "offeringClinician": {
    "name": "Dr. Sarah Lee"
  },
  "submittedAt": "2024-05-01T09:00:00Z",
  "forms": [
    {
      "id": "form-001",
      "url": "https://refer.health.gov.sg/forms/form-001",
      "description": "Patient medical history form",
      "isFilled": true,
      "formResponses": [
        {
          "question": "Does the patient have any allergies?",
          "id": "q2",
          "answer": "No known allergies"
        }
      ],
      "remark": "Please complete all sections",
      "fields": [
        {}
      ],
      "version": 1.1,
      "migrated": true
    }
  ],
  "url": "https://refer.health.gov.sg/referrals/a3f1c9e2-7b4d-4f8a-9c2e-123456789abc",
  "clinicLicenseNumber": "CLN-2024-5678",
  "clinicType": "CHAS-only",
  "clinicalInfo": "Patient has a history of gastritis and is currently on proton pump inhibitors.",
  "timeslotStartAt": "2024-05-10T14:00:00Z",
  "appointmentLocation": "Singapore General Hospital, Main Building, 5th Floor"
}

Path parameters

referralIdstringRequiredformat: "uuid"

Referral ID

Request

This endpoint expects an object.

institutionIdTypeenumRequired

The type of institution ID

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

coreStatusenum

isCancellableboolean

Whether this referral can be cancelled

canBackToDraftboolean

Whether this referral can be sent back to draft (to be amended and resubmitted)

noteslist of objects

offeringClinicianobjectOptional

submittedAtstringOptional

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

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

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error