Circle V2 API Docs
    Preparing search index...

    Type Alias UtilizationEvent

    One Kipu group session for one patient, reduced to what the Utilization pages read. Sessions the patient missed are kept (present: false) so absences can be counted; callers wanting delivered care filter on present. durationMinutes is null when no complete start/end pair exists — the session still counts as an instance, it just contributes no hours. sessionStartedAt is the instant the session is dated by (the group's start, else the patient's), which is the SQL roll-ups' rule; startedAt is where the patient's own attended window begins.

    type UtilizationEvent = {
        billable: boolean;
        billingCode: { code: string; kind: BillingCodeKind } | null;
        durationMinutes: number | null;
        endedAt: string | null;
        externalId: string;
        leaderName: string | null;
        patientChartId: PatientChartId;
        present: boolean;
        serviceType: UtilizationServiceType;
        sessionStartedAt: string;
        startedAt: string;
        status: string | null;
        title: string | null;
        topic: string | null;
    }
    Index

    Properties

    billable billingCode durationMinutes endedAt externalId leaderName patientChartId present serviceType sessionStartedAt startedAt status title topic

    Properties

    billable: boolean
    billingCode: { code: string; kind: BillingCodeKind } | null
    durationMinutes: number | null
    endedAt: string | null
    externalId: string
    leaderName: string | null
    patientChartId: PatientChartId
    present: boolean
    serviceType: UtilizationServiceType
    sessionStartedAt: string
    startedAt: string
    status: string | null
    title: string | null
    topic: string | null

    Settings

    Member Visibility

    On This Page

    Properties