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

    Interface TelehealthRingingData

    Payload of telehealth.ringing — a physician has been reserved for the waiting patient and their client is being asked to confirm it is still there. Not yet a call: an unanswered ring returns the consult to waiting (no event of its own — the next telehealth.in_progress or a later ring tells you what happened). Useful for a partner portal that wants to show "Dr. Chen is connecting…" before the video starts.

    interface TelehealthRingingData {
        consult: TelehealthConsultResource;
        practitionerId: string;
    }

    Hierarchy (View Summary)

    Index

    The consult after the transition the event reports.

    practitionerId: string

    Our id of the physician being rung for (= consult.practitioner.id).