Description
Normalize a household member index to zero-based form under a supplied input convention.
Epidemiological reporting depends on case-definition versions, observation windows, censoring, person/test denominators and time-bin boundaries. Missing and indeterminate results differ, while multiple tests can belong to one person. Local record arithmetic does not diagnose infection, establish transmission or select a public-health rule.
Normalize a household member index to zero-based form under a supplied input convention.
When to use this tool
Use Outbreak Household Member Index when checking the stated benign surveillance record, time, exposure or denominator convention.
How to use the tool and how it works
- Enter householdCode, memberIndex, oneBasedInput. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read memberToken, zeroBasedIndex. Use the output convention below.
Require nonempty household code and whole memberIndex at least one for oneBasedInput, otherwise at least zero. Subtract the selected origin and return zeroBasedIndex plus JSON [household,index].1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| householdCode | Household Code | Required. Text; minimum UTF-16 length 1; maximum UTF-16 length 8192. |
| memberIndex | Member Index | Required. Safe integer; minimum 0. |
| oneBasedInput | One Based Input | Required. Boolean. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| memberToken | Member Token | Required. Text; maximum UTF-16 length 8192. |
| zeroBasedIndex | memberIndex minus one only when oneBasedInput=true. | Required. Safe integer. |
{
"input": {
"householdCode": "HH17",
"memberIndex": 3,
"oneBasedInput": true
},
"output": {
"memberToken": "[\"HH17\",2]",
"zeroBasedIndex": 2
}
}Limitations and assumptions
- No household membership, identity, uniqueness or actual outbreak relationship is verified.
- 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
Use verified source records, current authoritative definitions and appropriate complete epidemiological/statistical methods with qualified public-health interpretation for actual decisions.
References
Similar or alternative tools
- Surveillance Case Definition Label
Identify a surveillance case definition by its code and source.
- Case Link Evidence Source Label
Record the source of an asserted epidemiological case link.