Circle V2 API Docs
    Preparing search index...

    Type Alias RuleFindingDto

    type RuleFindingDto = {
        band: RuleFindingBand;
        conceptId: DictionaryConceptId | null;
        documentLabel: string | null;
        documentType: string;
        dueAt: string | null;
        evaluatedAt: string;
        evaluator: RuleEvaluator;
        indeterminateReason: RuleIndeterminateReason | null;
        kind: RuleKind;
        periodEnd: string | null;
        periodStart: string | null;
        programStayId: ProgramStayId | null;
        quantifier: RuleQuantifier;
        ruleId: RuleId;
        ruleVersionId: RuleVersionId;
        sections: RuleFindingSectionDto[];
        spec: RuleSpec;
        status: CanonicalStatus;
        targetKey: string;
        targetKind: RuleTargetKind;
        window: RuleWindow;
    }
    Index

    Properties

    band conceptId documentLabel documentType dueAt evaluatedAt evaluator indeterminateReason kind periodEnd periodStart programStayId quantifier ruleId ruleVersionId sections spec status targetKey targetKind window

    Properties

    band: RuleFindingBand
    conceptId: DictionaryConceptId | null
    documentLabel: string | null

    A document target's own citation label, so its row names the document. PHI: carries the title.

    documentType: string
    dueAt: string | null
    evaluatedAt: string
    evaluator: RuleEvaluator
    indeterminateReason: RuleIndeterminateReason | null
    kind: RuleKind
    periodEnd: string | null
    periodStart: string | null
    programStayId: ProgramStayId | null
    quantifier: RuleQuantifier
    ruleId: RuleId
    ruleVersionId: RuleVersionId
    sections: RuleFindingSectionDto[]

    The drill-down, or an empty list for an evaluation written without one. PHI: never log it.

    spec: RuleSpec

    What the rule claims and when, free of any one period — the row's title, which sections is not.

    status: CanonicalStatus
    targetKey: string

    Which instance of the rule's frame this answers. Keys are read, never rendered.

    targetKind: RuleTargetKind
    window: RuleWindow

    Settings

    Member Visibility

    On This Page

    Properties