Natzar Partner API Reference - v1.0.0
    Preparing search index...

    Type Alias TelehealthStatus

    TelehealthStatus:
        | "invited"
        | "scheduled"
        | "waiting"
        | "ringing"
        | "in_progress"
        | "completed"
        | "cancelled"
        | "no_show"

    Lifecycle of a live (video) telehealth consult. Mirrors the ConsultStatus enum in amplify/data/resource.ts.

    • invited — consult created; the patient hasn't opened the embed yet.
    • scheduled — a mode: 'scheduled' consult with a booked time (scheduledAt) whose waiting room has not opened yet.
    • waiting — the patient is in the waiting room (embed open, presence heartbeating).
    • ringing — a physician has been reserved; the patient's client is confirming it is still there.
    • in_progress — a physician claimed it; the video call is live.
    • completed — the call ended. A recording/transcript may follow (telehealth.recording_ready webhook).
    • cancelled — cancelled via the API or the patient left the queue.
    • no_show — invited but the patient never joined.

    Type Declaration

    • "invited"
    • "scheduled"

      Booked, not yet due: a scheduled-mode consult holding a slot. It moves to waiting when either side enters the waiting room (which opens waitingRoomOpensMinutes before scheduledAt), and is what a physician's upcoming appointments read until then.

    • "waiting"
    • "ringing"

      A physician has been reserved and the patient's client is being asked to confirm it is still there. The call has not started and the physician has not been sent in; an unanswered ring returns the consult to waiting and frees the physician for the next patient.

    • "in_progress"
    • "completed"
    • "cancelled"
    • "no_show"