drchrono · Schema

TelemedicineAppointment

The Telehealth Appointment endpoint is an extension of the existing Appointment endpoint.

EHRElectronic Health RecordsHealthcareMedical RecordsPractice ManagementHIPAAAppointmentsBillingPrescriptionsLab IntegrationFHIR

Properties

Name Type Description
sent_patient_email object Whether a confirmation email was sent to the Patient or not
appointment integer The Appointment related to the Telehealth Appointment, analagous to the /api/appointments resource id
created_at string UTC Timestamp for when the Telehealth Appointment was created
updated_at string UTC Timestamp for when the Telehealth Appointment was updated
overlapping_duration string The duration that counts only if patient and doctor are in the video room
duration integer Length of an appointment in minutes
telehealth_url string URL used to access Telehealth Appointment
View JSON Schema on GitHub

JSON Schema

telemedicineappointment.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/drchrono/json-schema/telemedicineappointment.json",
  "title": "TelemedicineAppointment",
  "x-verbose-required": [],
  "required": [
    "appointment"
  ],
  "type": "object",
  "description": "The Telehealth Appointment endpoint is an extension of the existing Appointment endpoint.",
  "properties": {
    "sent_patient_email": {
      "description": "Whether a confirmation email was sent to the Patient or not"
    },
    "appointment": {
      "type": "integer",
      "description": "The Appointment related to the Telehealth Appointment, analagous to the /api/appointments resource id",
      "title": "Appointment"
    },
    "created_at": {
      "readOnly": true,
      "type": "string",
      "description": "UTC Timestamp for when the Telehealth Appointment was created",
      "title": "Created at"
    },
    "updated_at": {
      "readOnly": true,
      "type": "string",
      "description": "UTC Timestamp for when the Telehealth Appointment was updated",
      "title": "Updated at"
    },
    "overlapping_duration": {
      "type": "string",
      "description": "The duration that counts only if patient and doctor are in the video room",
      "title": "Overlapping duration"
    },
    "duration": {
      "readOnly": true,
      "type": "integer",
      "description": "Length of an appointment in minutes",
      "title": "Duration"
    },
    "telehealth_url": {
      "readOnly": true,
      "type": "string",
      "description": "URL used to access Telehealth Appointment",
      "title": "Telehealth url"
    }
  }
}