Circle V2 API Docs
    Preparing search index...

    Type Alias NewRuleEvaluation

    type NewRuleEvaluation = {
        countedTowardVerdict: boolean;
        entityId: EntityId;
        evaluatedAt: DbDate;
        evaluator: RuleEvaluator;
        evidenceVersion: string;
        indeterminateReason: RuleIndeterminateReason | null;
        patientChartId: PatientChartId | null;
        patientId: PatientId;
        periodEnd: DbDate | null;
        periodStart: DbDate | null;
        programStayId: ProgramStayId | null;
        result: RuleEvaluationResult;
        ruleId: RuleId;
        ruleVersionId: RuleVersionId;
        status: CanonicalStatus;
        targetKey: string;
        targetKind: RuleTargetKind;
        treatmentEpisodeId: TreatmentEpisodeId | null;
        triggeredBy: UserId | null;
    }
    Index

    Properties

    countedTowardVerdict entityId evaluatedAt evaluator evidenceVersion indeterminateReason patientChartId patientId periodEnd periodStart programStayId result ruleId ruleVersionId status targetKey targetKind treatmentEpisodeId triggeredBy

    Properties

    countedTowardVerdict: boolean
    entityId: EntityId
    evaluatedAt: DbDate

    One instant for the whole run: the reader shows only a rule's newest run, so every row of it must share this.

    evaluator: RuleEvaluator
    evidenceVersion: string
    indeterminateReason: RuleIndeterminateReason | null
    patientChartId: PatientChartId | null
    patientId: PatientId
    periodEnd: DbDate | null
    periodStart: DbDate | null

    The target's own span. Null where the frame has no bound — an open episode, a removed one.

    programStayId: ProgramStayId | null
    result: RuleEvaluationResult

    PHI: section 2 is a quotation from the record. Never log it, never safeParseWithLog it.

    ruleId: RuleId
    ruleVersionId: RuleVersionId
    status: CanonicalStatus
    targetKey: string
    targetKind: RuleTargetKind
    treatmentEpisodeId: TreatmentEpisodeId | null
    triggeredBy: UserId | null

    Settings

    Member Visibility

    On This Page

    Properties