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

    Interface GetPatientStateResponse

    GET /v1/patients/state response — the whole patient-facing picture in one call.

    Render straight from this: if telehealthConsult is present the patient is in a call or waiting for one; else if asyncConsult is present a human clinician owns the conversation (or is about to); else the agent chat is the surface. agentCursor is the cursor to start polling GET /v1/agent/messages from if you want only what's new.

    interface GetPatientStateResponse {
        patient: PatientResource;
        asyncConsult?: AsyncConsultResource;
        telehealthConsult?: TelehealthConsultResource;
        agentCursor?: string;
        capabilities: TenantCapabilities;
    }
    Index
    patient asyncConsult? telehealthConsult? agentCursor? capabilities
    patient: PatientResource

    The patient record.

    asyncConsult?: AsyncConsultResource

    The patient's OPEN async consult, if any (never a closed one).

    telehealthConsult?: TelehealthConsultResource

    The patient's OPEN telehealth consult, if any — i.e. one still invited, waiting, or in_progress.

    agentCursor?: string

    Cursor for the END of the agent conversation as of this read. Absent when the patient has no conversation yet.

    capabilities: TenantCapabilities

    What this tenant can offer.

    Settings
    Member Visibility

    On This Page
    Properties