Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build
Integrated Campaign Registry (ICR) Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
{
"resourceType": "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition",
"url": "https://icr.healthcampaigns.org/ViewDefinition/IcrTargetPopulation",
"title": "ICR target populations",
"description": "One row per target-population estimate (ICRTargetPopulation Group): the\n**denominators** — how many people a campaign plans to reach, where, for which\nage band, from which source. Joined to the campaign calendar on\n`denominator_id` this gives \"people targeted\"; joined to coverage reports it\ngives the denominator side of coverage.\n\n`location_id` is the geography characteristic; `age_low` / `age_high` are the\nage-band characteristic (units in `age_unit`, months or years); competing\nestimates for the same geography are distinguished by `source`, `estimate_date`\nand `is_planning`. `denominator_type` separates an all-ages figure\n(`total-population`, e.g. a WorldPop grid summed over the boundary) from an\neligible subset (`at-risk`); `is_calculated` marks a rollup or interpolation\nrather than an independently sourced count. Two total-population rows for the\nsame `location_id` and `estimate_date` from different `source`s are the\ncomparison the Campaign Targeting dashboard draws.",
"name": "IcrTargetPopulation",
"status": "draft",
"fhirVersion": [
"4.0.1"
],
"resource": "Group",
"where": [
{
"path": "actual = false and quantity.exists()",
"description": "Definitional cohorts with a count — the ICRTargetPopulation profile; excludes households and other actual groups and the count-less eligibility definitions"
}
],
"select": [
{
"column": [
{
"name": "group_id",
"path": "getResourceKey()",
"type": "id"
},
{
"name": "name",
"path": "name",
"type": "string"
},
{
"name": "quantity",
"path": "quantity",
"type": "unsignedInt",
"description": "The denominator count"
},
{
"name": "location_id",
"path": "characteristic.where(code.coding.code = 'geography').first().value.ofType(Reference).getReferenceKey(Location)",
"type": "string"
},
{
"name": "age_low",
"path": "characteristic.where(code.coding.code = 'age-band').first().value.ofType(Range).low.value",
"type": "decimal"
},
{
"name": "age_high",
"path": "characteristic.where(code.coding.code = 'age-band').first().value.ofType(Range).high.value",
"type": "decimal"
},
{
"name": "age_unit",
"path": "characteristic.where(code.coding.code = 'age-band').first().value.ofType(Range).low.code",
"type": "code",
"description": "UCUM: mo | a"
},
{
"name": "source",
"path": "extension('https://icr.healthcampaigns.org/StructureDefinition/denominator-source').value.ofType(CodeableConcept).coding.first().code",
"type": "code",
"description": "census | census-projection | worldpop | grid3 | microcensus | hmis | govt-estimate | …"
},
{
"name": "estimate_date",
"path": "extension('https://icr.healthcampaigns.org/StructureDefinition/estimate-date').value.ofType(date)",
"type": "date"
},
{
"name": "is_planning",
"path": "extension('https://icr.healthcampaigns.org/StructureDefinition/is-planning-denominator').value.ofType(boolean)",
"type": "boolean"
},
{
"name": "denominator_type",
"path": "extension('https://icr.healthcampaigns.org/StructureDefinition/denominator-type').value.ofType(code)",
"type": "code",
"description": "total-population | at-risk; null on older Groups that predate the extension"
},
{
"name": "is_calculated",
"path": "extension('https://icr.healthcampaigns.org/StructureDefinition/is-calculated').value.ofType(boolean)",
"type": "boolean",
"description": "True for a rollup or interpolation rather than an independently sourced count"
}
]
}
]
}