Skip to content

Main content

Case Definition Component Flag Tool

Evaluate supplied research classification component flags under explicit all/any logic, preserving unresolved components; no diagnosis or case definition is selected.

Loading tool…

Description

In requireAll mode, a known false component resolves the rule as false and all known true components resolve it as true; otherwise it remains unknown.

Case-definition records combine criteria, knowledge flags, document versions and date applicability. A component can be unknown rather than false, and literal agreement with supplied rules is separate from independent clinical classification.

In requireAll mode, a known false component resolves the rule as false and all known true components resolve it as true; otherwise it remains unknown.

When to use this tool

Use Case Definition Component Flag when checking a stated rule, its known components or its supplied version interval.

How to use the tool and how it works

  1. Enter componentSatisfied, componentKnown, requireAll. Keep parallel arrays aligned. Use the units and conventions below.
  2. Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
  3. Read definitionKnown, meetsRule. Inspect definitionKnown, meetsRule before interpreting the associated values.

Require equally long, nonempty componentSatisfied and componentKnown arrays. In requireAll mode, a known false component resolves the rule as false and all known true components resolve it as true; otherwise it remains unknown. In any-component mode, one known true resolves true, all known false resolves false, and other cases remain unknown. Return definitionKnown and meetsRule; meetsRule is false whenever the rule remains unknown.1

Input fieldMeaning and unitsAccepted input
componentSatisfiedComponent SatisfiedRequired. Array of boolean; maximum items 256.
componentKnownComponent KnownRequired. Array of boolean; maximum items 256.
requireAllRequire AllRequired. Boolean.
Output fieldInterpretationReturned shape
definitionKnownWhether known components determine the requested all/any rule.Required. Boolean.
meetsRuleRule result when determined; false placeholder when definitionKnown is false.Required. Boolean.
json
{
  "input": {
    "componentSatisfied": [
      true,
      false
    ],
    "componentKnown": [
      true,
      false
    ],
    "requireAll": true
  },
  "output": {
    "definitionKnown": false,
    "meetsRule": false
  }
}

Limitations and assumptions

  • A false meetsRule must be interpreted with definitionKnown. Unknown components do not become negative observations. These boolean rules do not select clinical criteria, establish case status independently or handle weighted definitions.
  • Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.

Alternative or Complementary methods

Review the authoritative case definition and original records; local boolean or version checks cannot establish the completeness or suitability of the definition.

References

  1. Calculation and input contract: epidemiology/case-definition-component-flag — tool.io

Similar or alternative tools