Circle V2 API Docs
    Preparing search index...

    Type Alias PatientSyncStatus

    type PatientSyncStatus = {
        botStep: string | null;
        canViewRecording: boolean;
        completedAt: string | null;
        documents: {
            completed: number;
            failed: number;
            items: {
                failureReason: string | null;
                fileName: string | null;
                isFailed: boolean;
                status: ExtendRunStatus;
            }[];
            processing: number;
            total: number;
        };
        dryRun: boolean;
        failureReason: string
        | null;
        isTerminal: boolean;
        liveViewUrl: string | null;
        rpaStatus: RpaRunStatus;
        stage: PatientSyncStage;
        steps: RpaRunStep[];
        syncType: string | null;
        triggeredAt: string;
    }
    Index

    Properties

    botStep canViewRecording completedAt documents dryRun failureReason isTerminal liveViewUrl rpaStatus stage steps syncType triggeredAt

    Properties

    botStep: string | null

    Live bot step (e.g. "Enter patient MRN"); only meaningful while pulling.

    canViewRecording: boolean

    A screen recording of the settled run exists (fetch it via getPatientRunRecording).

    completedAt: string | null
    documents: {
        completed: number;
        failed: number;
        items: {
            failureReason: string | null;
            fileName: string | null;
            isFailed: boolean;
            status: ExtendRunStatus;
        }[];
        processing: number;
        total: number;
    }
    dryRun: boolean
    failureReason: string | null

    Headline reason when the sync failed (pull-level, or the first failed document); null otherwise.

    isTerminal: boolean
    liveViewUrl: string | null

    Live browser-session view; non-null only while pulling — the provider's live view dies the moment the run ends.

    rpaStatus: RpaRunStatus
    stage: PatientSyncStage
    steps: RpaRunStep[]

    Append-only bot step log (oldest first); grows while pulling, frozen once the run settles.

    syncType: string | null
    triggeredAt: string

    Settings

    Member Visibility

    On This Page

    Properties