Circle V2 API Docs
    Preparing search index...

    Execute one form-fill run: snapshot -> deterministic answers -> AI answers -> PDF -> storage -> chart row -> status. Crash safety is the write order: answers before the document, chart row ready before completed, so a crash leaves a non-terminal run for the janitor and never a completed run with no document. A retry only adds: terminal runs are skipped, settled fields are not re-asked, and the upload replaces its own run-derived key.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    serviceName: "ExecuteFormFillRun"

    Stable, human-readable name for the service. Must be set explicitly on each subclass because this.constructor.name gets mangled by minification in production builds, which breaks tracing/observability span names.

    Accessors

    • get logger(): BaseLogger

      Returns BaseLogger

    • get name(): string

      Returns string

    Methods

    • Optional hook for subclasses to attach extra non-PII span attributes derived from params. The returned attributes appear on the service.${serviceName} span (and, for jobs, on job.enqueue.* and job.run.* spans too).

      Safe ID-like keys on params (e.g. patientId, templateIds, limit, cursor) are already auto-extracted via toSpanAttributes("service.input", params) — you don't need to enumerate them here. Use this hook for derived/computed attributes (counts, flags, computed names) or for fields you've explicitly verified safe but that aren't in the global allowlist. Hook output overrides auto-extracted attributes on key collision.

      Safe by default: returns {} when not overridden. Only declare keys you've confirmed are non-PII. Never include emails, names, dob, free-text, etc.

      Parameters

      Returns {
          "service.input.chosenContactCount": number;
          "service.input.includeEmr": boolean;
          "service.input.runId": FormRunId;
          "service.input.selectedDocumentCount": number;
          "service.input.selectedSessionCount": number;
      }

    • Optional hook for subclasses to attach extra non-PII span attributes derived from the successful service result. Only called when run resolves successfully; on error, the span is marked via markSpanError instead.

      Safe by default: returns {} when not overridden. Only declare keys you've confirmed are non-PII (e.g. counts, status flags, computed summaries). Never include emails, names, dob, free-text, etc.

      Parameters

      Returns Attributes