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 "Authorization: <apiKey>"

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

Authentication

Authorizationstring

API Key authentication via header

Path parameters

referralIdstringRequired

Referral 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

noteslist of objects

formslist of objects

List of forms required to complete the referral

urlstring

URL to view the referral

timeslotStartAtstring

Timeslot start time (ISO datetime)

appointmentLocationstring

Appointment location

Errors

401

Referrals Back to Draft Request Unauthorized Error