Circle V2 API Docs
    Preparing search index...

    Type Alias CreateFormRunParams

    type CreateFormRunParams = {
        createdBy?: UserId | null;
        formId: FormId;
        patientId?: PatientId | null;
        retrievalScope?: FormRunRetrievalScope | null;
        templateSnapshot: TemplateSnapshot;
    }
    Index

    Properties

    createdBy? formId patientId? retrievalScope? templateSnapshot

    Properties

    createdBy?: UserId | null
    formId: FormId
    patientId?: PatientId | null
    retrievalScope?: FormRunRetrievalScope | null

    What the kickoff bounded retrieval to. Null where the caller passed no scope — the executor's defaults then apply, exactly as they did before the column existed, and a re-run of such a run pre-fills from nothing rather than from a guess.

    templateSnapshot: TemplateSnapshot

    Frozen at kickoff: the versioned contract the executor re-reads.

    Settings

    Member Visibility

    On This Page

    Properties