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

    Interface TelehealthAppointment

    A booked appointment, as every surface renders it. The instants are absolute; the four zone fields say whose clock to show them on.

    interface TelehealthAppointment {
        consultId: string;
        startsAt: string;
        endsAt: string;
        practitionerId?: string | null;
        practitionerName?: string | null;
        status: TelehealthStatus;
        waitingRoomOpensAt: string;
        cancellableUntil: string;
        timezone: string;
        clinicTimezone: string;
        physicianTimezone: string | null;
        patientTimezone: string | null;
    }
    Index
    consultId startsAt endsAt practitionerId? practitionerName? status waitingRoomOpensAt cancellableUntil timezone clinicTimezone physicianTimezone patientTimezone
    consultId: string
    startsAt: string
    endsAt: string
    practitionerId?: string | null
    practitionerName?: string | null
    status: TelehealthStatus
    waitingRoomOpensAt: string

    Both sides may enter the waiting room from this instant.

    cancellableUntil: string

    Past this instant the PATIENT may no longer cancel; the clinic still can.

    timezone: string

    The VIEWER's zone — the timezone (or patientTimezone) the request carried, else the clinic's. Render startsAt in this one and label it; an unlabelled appointment time is a support call.

    clinicTimezone: string

    The clinic's zone.

    physicianTimezone: string | null

    The physician's calendar zone, once a physician is assigned; null before. When its offset at startsAt differs from timezone's, show the physician's clock as a second line ("08:00 CEST for Dr Morin") — the confirmation notices do the same.

    patientTimezone: string | null

    The zone the PATIENT booked from (patientTimezone on the booking call, or the device zone of the booking surface), or null when none was sent — notices then fall back to the clinic's zone.

    Settings
    Member Visibility

    On This Page
    Properties