Description
Preserve a caller-coded residence-pattern record with its source codebook.
Anthropological records preserve source language, translation status, community terms, household reference dates, kinship labels and permission context. A reciprocal-term display is not a verified kinship rule, while a pseudonym collision differs from identity verification. Display masks and public-access labels do not establish adequate protection or valid consent.
Preserve a caller-coded residence-pattern record with its source codebook.
When to use this tool
Use Household Residence Pattern Source Code when you already have householdCode, residencePatternCode, codebook and need to preserve a caller-coded residence-pattern record with its source codebook.
How to use the tool and how it works
- Enter householdCode, residencePatternCode, codebook. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read token. Use the output convention below.
Enter householdCode, residencePatternCode, codebook using the field constraints below. Encode these values, in exactly that order, as a JSON array and return the serialized array as text in token. String values are preserved without trimming or external terminology lookup.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| householdCode | Household Code | Required. Text; minimum UTF-16 length 1; maximum UTF-16 length 8192. |
| residencePatternCode | Residence Pattern Code | Required. Text; minimum UTF-16 length 1; maximum UTF-16 length 8192. |
| codebook | Codebook | Required. Text; minimum UTF-16 length 1; maximum UTF-16 length 8192. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| token | Token | Required. Text; maximum UTF-16 length 8192. |
{
"input": {
"householdCode": "H17",
"residencePatternCode": "RP3",
"codebook": "codebook-v2"
},
"output": {
"token": "[\"H17\",\"RP3\",\"codebook-v2\"]"
}
}Limitations and assumptions
- The result records supplied values without inferring household relationships. Sources and asserted relationships are not independently authenticated.
- 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
Consult the original field records, community-provided terms, translation sources and permission instructions for actual interpretation or reuse. Apply protection to underlying records and evaluate the full research context; local keys and status labels do not perform those tasks.
References
Similar or alternative tools
- Ethnographic Source Consent Scope Token
Preserve explicit ethnographic source consent-scope metadata.
- Public Artifact Caption Source Credit
Preserve an explicit public artifact caption and supplied source credit.