Circle V2 API Docs
    Preparing search index...

    Type Alias EnqueueChartReviewRunsParams

    type EnqueueChartReviewRunsParams = {
        auditTemplateIds: AuditTemplateId[];
        createdBy: UserId;
        extraParams?: { sessionId?: SessionId; [key: string]: unknown };
        jobbable: ChartReviewEnqueuer;
        patientChartIds?: PatientChartId[];
        patientId: PatientId;
        settings?: LegacyChartReviewSettings;
        treatmentEpisodeId?: TreatmentEpisodeId | null;
    }
    Index

    Properties

    auditTemplateIds createdBy extraParams? jobbable patientChartIds? patientId settings? treatmentEpisodeId?

    Properties

    auditTemplateIds: AuditTemplateId[]
    createdBy: UserId
    extraParams?: { sessionId?: SessionId; [key: string]: unknown }

    Extra job params merged into every enqueued job (e.g. sessionId / sessionNoteContext for the session-note jobbable). The receiving jobbable validates its own schema on dequeue.

    jobbable: ChartReviewEnqueuer

    The jobbable to enqueue per template (encodes runner + queue topic).

    patientChartIds?: PatientChartId[]

    Reviewer-selected charts the run is narrowed to, if any. Forwarded onto each enqueued job, and stamped onto audit_runs.run_context.scopedCharts.

    patientId: PatientId
    settings?: LegacyChartReviewSettings
    treatmentEpisodeId?: TreatmentEpisodeId | null

    Episode the run is scoped to, if any — stamped onto each audit_runs row.

    Settings

    Member Visibility

    On This Page

    Properties