action drchrono_appointments_list {
  label: "appointments_list"
  description: "Retrieve or search appointment or breaks.\n<b>Note:</b> Either `since`, `date` or `date_range` parameter must be specified.\n            "
  provider: drchrono
  method: GET
  path: "/api/appointments"
  encoding: json
  input: {
    type: "object"
    properties: {
      cursor: {
        type: "string"
        description: "The pagination cursor value."
      }
      date: {
        type: "string"
      }
      date_range: {
        type: "string"
      }
      doctor: {
        type: "integer"
      }
      office: {
        type: "integer"
      }
      page_size: {
        type: "integer"
        description: "Number of results to return per page."
      }
      patient: {
        type: "integer"
      }
      since: {
        type: "string"
      }
      status: {
        type: "string"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Paginated Result"
    properties: {
      data: {
        type: "array"
        description: "result data"
        items: {
          type: "object"
          required: ["doctor", "exam_room", "office", "patient", "scheduled_time"]
          properties: {
            allow_overlapping: {
              type: "boolean"
              description: "Bypass overlap check."
            }
            appt_is_break: {
              type: "boolean"
            }
            base_recurring_appointment: {
              type: "string"
              description: "ID of base appointment of a recurrign series"
            }
            billing_notes: {
              type: "array"
              description: "Billing notes of the appointment. For writing, check `/api/claim_billing_notes`"
              items: {
                type: "object"
                description: "Structure of a billing note"
                properties: {
                  appointment: {
                    type: "integer"
                  }
                  created_at: {
                    type: "string"
                  }
                  created_by: {
                    type: "string"
                  }
                  id: {
                    type: "integer"
                    description: "ID of the billing note"
                  }
                  text: {
                    type: "string"
                    description: "Content of the note"
                  }
                }
              }
            }
            billing_provider: {
              type: "string"
            }
            billing_status: {
              type: "string"
              description: "Should be one of `Auto Accident Claim`, `Balance Due`, `Bill Insurance`, `Bill Secondary Insurance`, `Durable Medical Equipment Claim`, `Internal Review`, `Paid In Full`, `Settled`, `Worker's Comp Claim` or one of the custom billing status"
            }
            clinical_note: {
              type: "object"
              description: "Associated clinical note object"
              properties: {
                locked: {
                  type: "boolean"
                }
                pdf: {
                  type: "string"
                }
                updated_at: {
                  type: "string"
                }
              }
            }
            cloned_from: {
              type: "integer"
              description: "ID of the original appointment which this appointment cloned from. Will be null if the appointment is not cloned."
            }
            color: {
              type: "string"
            }
            created_at: {
              type: "string"
            }
            custom_fields: {
              type: "array"
              description: "Custom appointment fields"
              items: {
                type: "object"
                properties: {
                  created_at: {
                    type: "string"
                  }
                  field_type: {
                    type: "integer"
                  }
                  field_value: {
                    type: "string"
                  }
                  updated_at: {
                    type: "string"
                  }
                }
              }
            }
            custom_vitals: {
              type: "array"
              description: "Custom vitals associated with this appointment."
              items: {
                type: "object"
                properties: {
                  value: {
                    type: "string"
                  }
                  vital_type: {
                    type: "integer"
                  }
                }
              }
            }
            deleted_flag: {
              type: "boolean"
              description: "Whether the appointmetn is deleted."
            }
            doctor: {
              type: "integer"
              description: "Doctor ID"
            }
            duration: {
              type: "integer"
              description: "Length of the appointment in minutes. Optional if `profile` is provided."
            }
            exam_room: {
              type: "integer"
              description: "Index of the exam room that this appointment occurs in. See `/api/offices`"
            }
            extended_updated_at: {
              type: "string"
              description: "The most recent update time among appointment itself, its vitals and its custom vitals"
            }
            first_billed_date: {
              type: "string"
            }
            icd10_codes: {
              type: "array"
              items: {
                type: "string"
              }
            }
            icd9_codes: {
              type: "array"
              items: {
                type: "string"
              }
            }
            id: {
              type: "string"
              description: "Unique identifier. Usually numeric, but not always"
            }
            ins1_status: {
              type: "string"
              description: "Billing status of primary insurer"
              enum: ["", "Incomplete Information", "In Process Emdeon", "Rejected Emdeon", "Rejected Jopari", "In Process Payor", "Rejected Waystar Professional", "Rejected Waystar Institutional", "In Process Payer", "Payer Acknowledged", "Rejected Payor", "Rejected Payer", "Paid in Full", "Partially Paid", "Coordination of Benefits", "ERA Received", "ERA Denied", "HCFA Form Faxed"]
            }
            ins2_status: {
              type: "string"
              description: "Billing status of secondary insurer"
              enum: ["", "Incomplete Information", "In Process Emdeon", "Rejected Emdeon", "Rejected Jopari", "In Process Payor", "Rejected Waystar Professional", "Rejected Waystar Institutional", "In Process Payer", "Payer Acknowledged", "Rejected Payor", "Rejected Payer", "Paid in Full", "Partially Paid", "Coordination of Benefits", "ERA Received", "ERA Denied", "HCFA Form Faxed"]
            }
            is_virtual_base: {
              type: "boolean"
            }
            is_walk_in: {
              type: "boolean"
              description: "Whether the appointment is a walk-in appointment"
            }
            last_billed_date: {
              type: "string"
            }
            notes: {
              type: "string"
            }
            office: {
              type: "integer"
              description: "Office ID"
            }
            patient: {
              type: "integer"
              description: "ID of this appointment's patient. Breaks have a null patient field."
            }
            primary_insurance_id_number: {
              type: "string"
            }
            primary_insurer_name: {
              type: "string"
            }
            primary_insurer_payer_id: {
              type: "string"
            }
            profile: {
              type: "integer"
              description: "ID of an `/api/appointment_profiles` instance. The profile sets default values for `color`, `duration`, and `reason` on creation, which can be overriden by setting these values explicitly."
            }
            reason: {
              type: "string"
              description: "Default to `\"\"`"
            }
            recurring_appointment: {
              type: "boolean"
              description: "Whether the appointment is a recurring appointment or not"
            }
            reminder_profile: {
              type: "string"
              description: "Write-only. ID of an `/api/reminder_profiles` instance. Set this to apply a reminder profile to the appointment. Cannot be applied to an appointment with reminders."
            }
            reminders: {
              type: "array"
              description: "Scheduled reminders of the appointment"
              items: {
                type: "object"
                properties: {
                  id: {
                    type: "integer"
                  }
                  scheduled_time: {
                    type: "string"
                  }
                  type: {
                    type: "string"
                    enum: ["email", "sms", "phone", "auto_call"]
                  }
                }
              }
            }
            scheduled_time: {
              type: "string"
              description: "The starting time of the appointment"
            }
            secondary_insurance_id_number: {
              type: "string"
            }
            secondary_insurer_name: {
              type: "string"
            }
            secondary_insurer_payer_id: {
              type: "string"
            }
            status: {
              type: "string"
              description: "One of ``, `Arrived`, `Checked In`, `In Room`, `Cancelled`, `Complete`, `Confirmed`, `In Session`, `No Show`, `Not Confirmed`, or `Rescheduled`. Or one of the custom statuses."
              enum: ["", "Arrived", "Checked In", "Checked In Online", "In Room", "In Session", "Complete", "Confirmed", "Not Confirmed", "Rescheduled", "Cancelled", "No Show"]
            }
            status_transitions: {
              type: "array"
              items: {
                type: "object"
                properties: {
                  appointment: {
                    type: "string"
                  }
                  datetime: {
                    type: "string"
                  }
                  from_status: {
                    type: "string"
                  }
                  to_status: {
                    type: "string"
                  }
                }
              }
            }
            supervising_provider: {
              type: "string"
              description: "Supervising provider of appointment if set."
            }
            updated_at: {
              type: "string"
            }
            vitals: {
              type: "object"
              description: "Clinical vitals associated with the appointment"
              properties: {
                blood_pressure_1: {
                  type: "integer"
                }
                blood_pressure_2: {
                  type: "integer"
                }
                bmi: {
                  type: "string"
                }
                head_circumference: {
                  type: "number"
                }
                head_circumference_units: {
                  type: "string"
                }
                height: {
                  type: "number"
                }
                height_units: {
                  type: "string"
                }
                oxygen_saturation: {
                  type: "number"
                }
                pain: {
                  type: "string"
                  description: "1-10 pain scale."
                }
                pulse: {
                  type: "integer"
                  description: "Beats per minute."
                }
                respiratory_rate: {
                  type: "integer"
                  description: "Breathes per minute."
                }
                smoking_status: {
                  type: "string"
                  enum: ["blank", "449868002", "428041000124106", "8517006", "266919005", "77176002", "266927001", "428071000124103", "428061000124105"]
                }
                temperature: {
                  type: "number"
                }
                temperature_units: {
                  type: "string"
                }
                weight: {
                  type: "number"
                }
                weight_units: {
                  type: "string"
                }
              }
            }
          }
        }
      }
      next: {
        type: "string"
        description: "Next Paginated page"
      }
      previous: {
        type: "string"
        description: "Previous paginated page"
      }
    }
  }
}