Circle V2 API Docs
    Preparing search index...

    Type Alias ExecuteFormFillRunParams

    type ExecuteFormFillRunParams = {
        aiBatchSize?: number;
        chosenContacts?: Readonly<Record<string, string>>;
        includeEmr?: boolean;
        resumeRunningRun?: boolean;
        runId: FormRunId;
        runnerConfig?: FormFillingConfigOverrides;
        selectedDocumentIds?: readonly PatientChartId[];
        selectedSessionIds?: readonly SessionId[];
        treatmentEpisodeId?: TreatmentEpisodeId;
    }
    Index

    Properties

    aiBatchSize? chosenContacts? includeEmr? resumeRunningRun? runId runnerConfig? selectedDocumentIds? selectedSessionIds? treatmentEpisodeId?

    Properties

    aiBatchSize?: number

    Fields per runner invocation, each batch persisted before the next starts. Omitted, DEFAULT_AI_BATCH_SIZE.

    chosenContacts?: Readonly<Record<string, string>>

    contact_type_id -> contact_id chosen at kickoff; unknown types resolve to no_answer, never an error.

    includeEmr?: boolean

    Also open the patient's EMR namespace to retrieval.

    resumeRunningRun?: boolean

    Take over a running run. Off by default so a redelivered message cannot start a second execution; only RunFormFillJobbable sets it, after its atomic claimRun. The check here is read-then-write.

    runId: FormRunId
    runnerConfig?: FormFillingConfigOverrides

    Runner levers, passed in because the caller owns the flag provider and @repo/ai-agents never reads flags.

    selectedDocumentIds?: readonly PatientChartId[]

    The patient_charts the AI lane may read; recorded on the generated form's chart row as its sources.

    selectedSessionIds?: readonly SessionId[]

    The patient's completed session notes the AI lane may quote; recorded beside the documents as sources.sessions.

    treatmentEpisodeId?: TreatmentEpisodeId

    Scopes patient-context resolution to one episode.

    Settings

    Member Visibility

    On This Page

    Properties