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

    Interface TelehealthQueueEntry

    One patient in the tenant's live telehealth queue, as the clinician's board shows them — position order, oldest wait first. A projection of the waiting consult plus the numbers a queue row needs precomputed, so a board of forty patients is forty rows, not forty clock subtractions.

    interface TelehealthQueueEntry {
        consultId: string;
        position: number;
        enqueuedAt: string;
        waitedSeconds: number;
        specialty?: string;
        patientState?: string;
        patientLang?: PatientLang;
        patient: PatientSummary;
        context?: string;
    }
    Index
    consultId position enqueuedAt waitedSeconds specialty? patientState? patientLang? patient context?
    consultId: string

    The waiting consult — the id /room will take once it is matched to you.

    position: number

    1-based place in the queue.

    enqueuedAt: string

    When the patient entered the queue.

    waitedSeconds: number

    Seconds waited so far, as of the workspace's generatedAt.

    specialty?: string

    The tenant specialty slug the consult was routed to, if any.

    patientState?: string

    The patient's jurisdiction (ISO 3166-2 subdivision), if recorded.

    patientLang?: PatientLang

    The patient's locale frozen on the consult at mint — what the matcher ranks the ready physicians against, so a board can badge the rows a French speaker is preferred for. See TelehealthConsultResource.patientLang.

    patient: PatientSummary

    Who is waiting.

    context?: string

    The handoff summary supplied at creation, if any.

    Settings
    Member Visibility

    On This Page
    Properties