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": "string"
}'

{
  "id": "string",
  "sender": {
    "hciCode": "string",
    "name": "string",
    "block": "string",
    "streetName": "string",
    "buildingName": "string",
    "floorNumber": "string",
    "unitNumber": "string",
    "postalCode": "string"
  },
  "senderSystem": "HAS",
  "offering": {
    "id": "string",
    "name": "string",
    "institutionHciCode": "string",
    "institution": {
      "hciCode": "string",
      "name": "string",
      "block": "string",
      "streetName": "string",
      "buildingName": "string",
      "floorNumber": "string",
      "unitNumber": "string",
      "postalCode": "string"
    },
    "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": "string",
    "nehrCode": "string"
  },
  "patient": {
    "uin": "string",
    "name": "string",
    "phoneNumber": "91234567",
    "dob": "1990-01-01",
    "gender": "Male",
    "chasStatus": "string",
    "address": {
      "postalCode": "string",
      "block": "string",
      "streetName": "string",
      "floorNumber": "string",
      "unitNumber": "string"
    },
    "residentialStatus": "SC",
    "nationality": "Singapore"
  },
  "referringDoctor": {
    "mcr": "string",
    "idType": "mcr",
    "name": "string",
    "email": "string",
    "contactNumber": "string"
  },
  "isSubsidised": true,
  "isUrgent": true,
  "createdAt": "2024-05-01T00:00:00Z",
  "updatedAt": "2024-05-01T00:00:00Z",
  "formResponses": [
    {
      "question": "string",
      "id": "string",
      "answer": "string"
    }
  ],
  "attachments": [
    {
      "url": "string",
      "name": "ecg-report.png"
    }
  ],
  "coreStatus": "draft",
  "isCancellable": true,
  "canBackToDraft": true,
  "notes": [
    {
      "id": "string",
      "content": "string",
      "authorHciCode": "string",
      "authorName": "string",
      "createdAt": 1.1,
      "updatedAt": 1.1
    }
  ],
  "status": "draft",
  "submittedAt": "2024-05-01T00:00:00Z",
  "forms": [
    {
      "id": "string",
      "url": "string",
      "description": "string",
      "isFilled": true,
      "formResponses": [
        {
          "question": "string",
          "id": "string",
          "answer": "string"
        }
      ],
      "remark": "string",
      "fields": [
        {}
      ],
      "version": 1.1,
      "migrated": true
    }
  ],
  "url": "string",
  "clinicLicenseNumber": "string",
  "clinicType": "CHAS-only",
  "clinicalInfo": "string",
  "timeslotStartAt": "2024-05-01T00:00:00Z",
  "appointmentLocation": "string"
}

Path parameters

referralIdstringRequiredformat: "uuid"

Referral ID

Request

This endpoint expects an object.

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

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

statusenumDeprecated

Deprecated. Use coreStatus instead.

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

Allowed values:

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