Skip to content

Main content

Case Definition Version Match Pair Tool

Calculate case definition version match pair from explicit caller-supplied inputs.

Loading tool…

Description

Compare caseVersion and requestedVersion literally, and test caseDate against the inclusive interval [validFrom,validThrough].

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.

Compare caseVersion and requestedVersion literally, and test caseDate against the inclusive interval [validFrom,validThrough].

When to use this tool

Use Case Definition Version Match Pair when checking a stated rule, its known components or its supplied version interval.

How to use the tool and how it works

  1. Enter caseVersion, requestedVersion, caseDate, validFrom, validThrough. 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 versionMatches, dateValid, compatible. Inspect versionMatches, dateValid, compatible before interpreting the associated values.

Require validThrough >= validFrom. Compare caseVersion and requestedVersion literally, and test caseDate against the inclusive interval [validFrom,validThrough]. Return versionMatches, dateValid and compatible, where compatible requires both comparisons to pass.1

Input fieldMeaning and unitsAccepted input
caseVersionCase VersionRequired. Text; maximum UTF-16 length 8192.
requestedVersionRequested VersionRequired. Text; maximum UTF-16 length 8192.
caseDateCase DateRequired. Safe integer.
validFromValid FromRequired. Safe integer.
validThroughValid ThroughRequired. Safe integer.
Output fieldInterpretationReturned shape
versionMatchesVersion MatchesRequired. Boolean.
dateValidDate ValidRequired. Boolean.
compatibleCompatibleRequired. Boolean.
json
{
  "input": {
    "caseVersion": "v2",
    "requestedVersion": "v2",
    "caseDate": 20,
    "validFrom": 10,
    "validThrough": 30
  },
  "output": {
    "versionMatches": true,
    "dateValid": true,
    "compatible": true
  }
}

Limitations and assumptions

  • Dates are numeric coordinates on a caller-defined common basis. No text normalization, document lookup, clinical criteria assessment or authoritative version validity is performed.
  • 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.
  • Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Numeric signed-zero results are exported as zero.

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-version-match-pair — tool.io

Similar or alternative tools

  • Case Source Precision Gap

    Among selected records return cases, coarserCases where sourceQuantum > referenceQuantum, and maximumExcessQuantum = max(0, selected quantum-referenceQuantum).

  • Surveillance Case Definition Label

    Attach an explicit surveillance definition source and version without classifying a case.