cohort_figures
How many people, and by what means somebody counted. Enrollment counts, modelled prevalence rates and member months, each served separately with its measurement class, its case definition and its source attached. Use this for "how many Medicare beneficiaries are in this county", "what is the modelled diabetes prevalence here" or "how many member months did this state's Medicaid programme run". THIS TOOL MULTIPLIES NOTHING, and that is the design rather than a gap. A prevalence and an enrollment count are both "how many people", both published per geography, and both plausible in the same slot. Multiplying them cancels the units into something that looks like a headcount and is not one, unless both describe the same people over the same span, which this world does not check. Forming the product is yours to do and its units are yours to keep visible. MEASUREMENT CLASS IS PART OF THE FIGURE. `administrative` means a programme counted its own enrollees: exact for what it counts, and what it counts is eligibility rather than disease. `modelled` means a statistical model predicted a small-area rate from a survey conducted elsewhere, so the value is a model output for the geography rather than an observation in it, and its published interval is part of the figure. Every served figure carries its class, what that class means in the register's own words, its `prevalence_basis` in the exact vocabulary `screening_yield` requires, its `unit`, its `denominator`, its `is_not`, and its source. A call that spans more than one class says so on the payload. THERE IS NO CORRECTION BETWEEN THE CLASSES. Administrative and epidemiological prevalence diverge in both directions by amounts that depend on the condition and the algorithm. This register records which class a figure came from and holds no factor for converting between them, so a call asking for one is refused rather than approximated. NAME `fields` AND `geography`. `fields` is an array of one to four field names; a name outside the served vocabulary refuses the whole call rather than being quietly dropped, because a caller forming a product out of some of the figures they asked for is the failure this register exists to prevent. Omitting `geography` switches this tool into declaration mode, which returns what each field would mean and carries no number at all. National is "US", a state is its two-letter abbreviation, a county is its FIPS code with its leading zero kept. Name `period` as a string, or as an object keyed by field name when the fields in one call do not share a period vocabulary; it may be omitted only when every field asked for has exactly one period built. A WITHHELD CELL IS NOT A ZERO AND CARRIES NO NUMBER FIELD. Where a publisher declined to publish a value it declined for a reason of its own, usually a small count, and the answer carries the publisher's own marker and a sentence saying so, with nowhere a figure could be written. Where every figure asked for was withheld at that geography the call is refused outright. A field this register declares and does not serve is refused by name, so a caller learns it exists and is blocked rather than that it does not exist, and the reason says whether the register blocked it or the source has no table to read. Every figure is read from a register this world holds, so the basis is measured for an administrative count and cited for a modelled rate, and a call mixing them composes to the weaker of the two. The register's own vintage is its own clock, separate from this world's assembly date, from the rate extract's month and from the NCCI quarter.
Use this form for new arguments. Follow concrete links for known values. Fetch-only readers may be unable to submit new URLs.
Exact input contract
{
"additionalProperties": false,
"properties": {
"fields": {
"description": "The figures to read, by field name. Call this tool without a `geography` first to see every field this register serves, what each one means, which geography levels and which periods were built for it, and which declared fields are blocked. A name outside the served vocabulary refuses the whole call and the refusal lists both vocabularies.",
"items": {
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"type": "array"
},
"geography": {
"description": "Where. National is \"US\", a state is its two-letter postal abbreviation, a county is its FIPS code with its leading zero kept. Omit this argument entirely to get the declaration for each field instead of a figure; naming a geography is what turns a declaration into a number.",
"type": "string"
},
"period": {
"description": "When, in the period vocabulary of the field being read, which differs by source. Either one period name as a string applying to every field, or an object keyed by field name when the fields in one call do not share a vocabulary. May be omitted only when every field asked for has exactly one period built; this world ships no default, because choosing one silently would date a figure as of a span nobody named.",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": {
"type": "string"
},
"type": "object"
}
]
}
},
"required": [
"fields"
],
"type": "object"
}