Circle V2 API Docs
    Preparing search index...

    Type Alias EnqueueInsyncRpaTriggerParams

    type EnqueueInsyncRpaTriggerParams = {
        dryRun: boolean;
        episodeEndDate?: string | null;
        episodeStartDate?: string | null;
        patientId: PatientId;
        syncType: InsyncRpaSyncType;
        treatmentEpisodeId?: TreatmentEpisodeId | null;
        triggeredBy: UserId;
    }
    Index

    Properties

    dryRun episodeEndDate? episodeStartDate? patientId syncType treatmentEpisodeId? triggeredBy

    Properties

    dryRun: boolean
    episodeEndDate?: string | null
    episodeStartDate?: string | null

    episode_docs date bounds (MM/DD/YYYY, facility-local); null = unfiltered download.

    patientId: PatientId
    syncType: InsyncRpaSyncType
    treatmentEpisodeId?: TreatmentEpisodeId | null

    The episode an episode_docs run is scoped to (its bounds are that episode's stay window), so the returned documents can be stamped with it as provenance at ingest. Null for unbounded pulls — those span multiple episodes and must fall back to date-of-service attribution.

    triggeredBy: UserId

    Settings

    Member Visibility

    On This Page

    Properties