Skip to main content

​
Object Definition

{
  "id": 67176890458,                                     // long(64) read-only 
  "scheduled_date": "2016-10-13T11:15:00Z",              // datetime(iso8601)
  "duration": 15,                                        // integer  (in minutes)
  "reason": null,                                        // null or string(50)
  "description": "",                                     // string(500)
  "status": {                                            // optional in "Create"
    "status": "Confirmed",                               // optional in "Update"
    "room": "Room 102",
    "status_date": "2016-10-13T01:02:37"                 // read-only
  },
  "time_slot_type": "event",                             // set on create, read-only
  "patient": null,                                       // must be explicitly set to null
  "physician": 131074,                                   // long(64)
  "practice": 65540,                                     // long(64)
  "metadata": null,
  "created_date": "2016-10-13T00:47:01Z",                // datetime(iso8601)   read-only
  "last_modified_date": "2016-10-13T00:59:16Z",          // datetime(iso8601)   read-only
  "deleted_date": null                                   // datetime(iso8601)   read-only
}
AttributeAllowed Valus
status.statusScheduled, Confirmed, Checked Out, Cancelled, With Doctor, In Room, Checked In, In Room - Vitals Taken, Not Seen, Billed
status.roomthe value must be one of available rooms
duration5-min increment and must be between 1 to 1440
If the “reason” field is being set to not null, it should not be free-text. The values are mapped to “appointment types” in the EMR.