Circle V2 API Docs
    Preparing search index...

    Type Alias StartFormFillRunParams

    type StartFormFillRunParams = {
        chosenContacts?: Readonly<Record<string, string>>;
        createdBy: UserId;
        entityId: EntityId;
        formId: FormId;
        includeEmr?: boolean;
        patientId: PatientId;
        selectedDocumentIds?: readonly PatientChartId[];
        selectedSessionIds?: readonly SessionId[];
        treatmentEpisodeId?: TreatmentEpisodeId;
    }
    Index

    Properties

    chosenContacts? createdBy entityId formId includeEmr? patientId selectedDocumentIds? selectedSessionIds? treatmentEpisodeId?

    Properties

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

    contact_type_id -> contact_id, as the user chose; every entry is authorized here before a run exists.

    createdBy: UserId

    The acting user: form visibility is per-user, so this is half the authorization key.

    entityId: EntityId

    The caller's organization from authentication: the authorization boundary, never the request body.

    formId: FormId
    includeEmr?: boolean

    Also open the patient's EMR namespace to retrieval.

    patientId: PatientId
    selectedDocumentIds?: readonly PatientChartId[]

    The patient's charts the AI lane may read. Empty means EMR-only (or nothing).

    selectedSessionIds?: readonly SessionId[]

    The patient's completed session notes the AI lane may quote, inlined whole. Empty means none.

    treatmentEpisodeId?: TreatmentEpisodeId

    Scopes patient-context resolution to one episode.

    Settings

    Member Visibility

    On This Page

    Properties