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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define measures as part of content in this implementation guide.
| ICR Administrative Coverage Measure |
Doses/treatments delivered ÷ planning denominator, from tallies. Disaggregable by sex, age band, delivery strategy and geography. |
||||
| ICR Campaign Readiness Measure |
|
||||
| ICR Geographic Coverage Measure |
Implementation-unit coverage: settlements/areas treated ÷ total targeted (coverage-unit = implementation-units). The ESPEN supervision-form 'villages treated / total' figure, with non-treatment reasons as a stratifier. |
||||
| ICR MDA Treatment Coverage Measure |
PC-NTD treatment coverage: persons treated ÷ at-risk/eligible population, disaggregated by sex, age band and treatment disposition (treated vs not-treated reason). The Measure behind the ESPEN treatment-form tally. |
||||
| ICR Survey Coverage Measure |
Independently-measured coverage (cluster survey / LQAS / RCM). A separately-sourced measure of the same quantity as administrative coverage; the two routinely diverge and must never be merged. |
||||
| ICR Zero-dose Coverage Measure |
Zero-dose children reached in the round ÷ children reached, disaggregated by prior-dose status (dose-history). Turns the polio SIA tally's never/previously/no-recall split into a first-class measure of how many zero-dose children a campaign reaches — the equity signal behind zero-dose reduction. Placeholder CQL pending executable logic (forms-v1 / jul3-form-analysis §Aggregate #1). |
These define forms used by systems conforming to this implementation guide to capture or expose data to end users.
| ICR Campaign Readiness Checklist |
Structured pre-campaign readiness/preparedness validation at operational level (UNICEF Preparedness Validation form), grouped: microplan, cold chain & logistics, social mobilization, trainings. Representative items, not the full instrument; countries extend (forms-v1). |
| ICR MDA Supervision Checklist |
Structured supervision checklist for community-directed MDA (ESPEN Forms 5 & 6), grouped: supplies, CDD observation, stock & wastage, social mobilization. |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| ICR Administrative Coverage |
Administrative coverage: doses/treatments delivered ÷ planning denominator, computed from tallies. Carries denominator provenance and is permanently marked source=administrative. |
| ICR Adverse Event |
An adverse event following a campaign intervention — vaccine (AEFI) or MDA drug (pharmacovigilance) alike. The suspected product/event is referenced via suspectEntity; causality uses the WHO/CIOMS classification; seriousness/severity carry the minor-vs-serious distinction the field forms collect. Carries the required campaign-vs-routine record origin. Intervention-neutral so it serves both the immunization and MDA arms (working doc §17.2 C1). |
| ICR Campaign |
A specific campaign execution — the keystone resource. Begins life as a microplan (intent=plan) and evolves into the execution record as Tasks complete and coverage accumulates. Rounds are sibling ICRCampaigns under an umbrella campaign via partOf (working doc 7.2, 7.2, |
| ICR Campaign Activity |
A discrete work type within a campaign — 'administer albendazole to children 5–14', 'distribute ITNs to households' — instantiated as ICRCampaignTask resources (working doc §7.3). Activities form a shared catalog, not children of any one protocol: the reference runs PlanDefinition.action.definitionCanonical → ActivityDefinition, so the same activity is reusable across any number of protocols. topic tags the catalog by campaign type for menu filtering; the tag is advisory and never restricts which protocols may reference the activity. Eligibility criteria (age bands etc.) also do not live here — base ActivityDefinition has no eligibility element; they belong on the protocol (ICRCampaignProtocol.subject). |
| ICR Campaign Form Response |
A filled-in campaign form — ONE generic profile for every structured form submission in a campaign: supervision visits (ESPEN Forms 5 health-facility and 6 CDD-observation via the icr-mda-supervision-checklist), pre-campaign readiness validations (icr-campaign-readiness-checklist), monitoring checks, and country-authored forms. The canonical Questionnaire a response answers is the TYPE DISCRIMINATOR — 'all supervision reports' is a query on the questionnaire canonical, and analytics key on the form's coded linkIds — so new form types cost a Questionnaire, never a new profile. basedOn ties every submission to its campaign (round); subject is the delivery unit or place the form is about; author is the individual (Practitioner/PractitionerRole) or Organization who filed it — R4 QuestionnaireResponse.author cannot reference a CareTeam. Replaces the form-specific ICRSupervisionReport (working doc 17.3, 17.3, |
| ICR Campaign Protocol |
The reusable, version-controlled template for a campaign type — what a measles SIA is (products, age bands, activity sequence, coverage goals), instantiated by every execution in every country (working doc §7.1). |
| ICR Campaign Task |
The assignable, trackable operational unit of work — one Task per site-session (for = the site Location) or per household, community, or school-cohort visit (for = the delivery-unit Group). Every Task points at its campaign via basedOn (the CarePlan is never updated as tasks are created). Tasks may be pre-planned from the microplan or field-registered on discovery (the required task-origin code records which). Whether Tasks are assigned at village or household level is a configuration choice (working doc §7.4). |
| ICR Care Team |
The campaign delivery team — the vaccinators/CDDs who do the work and the supervisor who oversees them and typically files the report. Referenced from ICRCampaign.careTeam (the roster) and Task.owner/Task.performer (the team that worked a Task); the supervisor surfaces again as the MeasureReport.reporter on rolled-up coverage and often owns the supervisory-area Location via the oversees-area extension. With workload-target it carries the microplan workload assigned to the team (working doc 5.5, 5.5, |
| ICR Consent (Person-Data Governance) |
Records the permission governing collection, storage, and cross-border sharing of a registered individual's (or a household's) campaign data. A v1 starting point: ICR holds named people (ICRPatient, §6.4), so a privacy/sharing permission and its scope are first-class. The grantor is typically the head of household or caregiver; the subject is the ICRPatient the data is about. |
| ICR Delivery Unit (Household / Community / School Cohort) |
The actual Group of people a campaign Task acts on — a household (house-to-house delivery), a community (MDA), or a school cohort (school-based delivery), distinguished by the required group-kind code. Households, communities, and school cohorts are groups: they have members and an associated Location. The validated Group + Location pattern, generalized: the Group is who, the Location (group-location extension) is where it lives or is based — the dwelling for a household, the settlement or community point for a community, the school for a school cohort — with the Location carrying the Overture GERS ID for stable cross-campaign identity. A delivery unit without members is a Location, not a Group: a structure under IRS, a church or market serving as a temporary service point (people are not members of the site, and the next campaign may use a different one), or an area target (settlement, ward, district) that persons are registered to when their dwellings are unknown (working doc 3.2, 3.2, |
| ICR Facility Organization |
The accountable facility entity — the mCSD-style pairing partner of a facility ICRLocation. A health facility is two things: an Organization (the conceptual/legal entity that owns registry codes, classification, and accountability) and a Location (the physical place where care happens), linked Location.managingOrganization → Organization. Organization.type is the source of truth for the national facility classification (ICRFacilityTypeVS) and ownership (ICROwnershipVS) alongside the generic 'prov' provider coding; Location.type carries the generic 'facility' functional code and MAY additionally carry copies of the classification codings — the mCSD-sanctioned duplication for consumers that only query Locations (geospatial exports, map layers). On any disagreement the Organization is authoritative. Organization.partOf carries the administrative reporting hierarchy (facility → LGA/district health office → state agency), which is deliberately distinct from — and need not mirror — the geographic hierarchy on Location.partOf: a facility can report to one authority while sitting in territory that authority does not govern. Per the georegistry rule this profile still holds only identify/classify/contact data (working doc 5.3, 5.3, |
| ICR Immunization Event |
A vaccination delivery event: CVX-coded, with lot accountability and the required campaign-vs-routine record origin. |
| ICR Location |
The most-customized ICR resource — the ICR's georegistry layer, covering the WHO IDHC administrative boundary, health facility and school master lists: a single partOf containment tree (6+ levels in campaign countries) holding admin units and operational geography alike, distinguished by type — not tree position; GeoJSON boundaries; and multi-system geospatial identity — Overture Maps GERS IDs (building / place / division) as the preferred cross-campaign join key, with P-codes and national codes as coequal aliases. Per the IDHC georegistry rule, this layer holds only identify/classify/locate/contact data; programmatic data references it but never lives in it (working doc 7.7, 7.7, |
| ICR Location Status |
A time-varying, provenance-carrying property assertion about a place — endemicity ('this district is LF-endemic, under MDA') first, with future axes such as access/security status or elimination milestones. The location-scoped analogue of the denominator discipline (working doc §7.6): assertions are revisable, sources can disagree, and every assertion carries who asserted it, when, by what method, and from what evidence. That is why it is an Observation JOINED to the Location rather than a field inside it — per the georegistry rule, Location carries durable identity only; revisable epidemiological state lives beside it. Semantics: an assertion applies to the location's entire partOf subtree unless a lower-level assertion overrides it, and consumers read the newest final/amended assertion per (subject, code). Properties are pre-coordinated codes (ICRLocationStatusVS): a new location property is a new code, not a new profile. Counts and rates are NOT this profile — they stay MeasureReport; durable identity classifications (settlement-type) stay on Location. |
| ICR Medication Administration |
An MDA treatment event: ATC-coded preventive chemotherapy with directly-observed consumption, dosage derived from a dose-pole height Observation, and the required record origin. |
| ICR Patient (Beneficiary / Registered Individual) |
A beneficiary — an individual registered in a campaign, a household, community, or school-cohort member, and the subject of every person-level delivery event. This is the WHO IDHC 'beneficiary list' master registry entry; the resource is FHIR Patient by necessity, but human-facing text (forms, reports, training material) should say 'beneficiary' or 'individual', never 'patient'. Person registration is a mainline capture mode in community-and-household campaigns, not an exception. Base R4 Patient aligned to WHO IMMZ.Patient (required gender/birthDate; MS name/phone/address), with a sliced cross-campaign identifier (national ID preferred, registry-assigned ID as fallback) so the same individual is rejoinable across rounds. A beneficiary need not belong to any Group: they may be a household, community, or school-cohort member, or simply the subject of a standalone event. The caregiver is a RelatedPerson (WHO IMMZ.Caregiver), not an ICRPatient (working doc §6.4). |
| ICR Supply Distribution |
Last-mile distribution of a commodity to the people it serves — ITNs to a household, consumables handed to a community. The COVERAGE-bearing supply event: per-capita measures (1 net per 2 household members) join its quantity to the recipient delivery unit's size. Distinct from ICRSupplyMovement (node-to-node logistics, stock-bearing) — the split keeps coverage CQL from double-counting stock movements. Deliberately carries no stock-accountability ledger: a distribution is not a stock event. Structure-applied consumables (IRS insecticide) are NOT distributions — the spray Task is the event (§6.4) and consumption rides the movement ledger. |
| ICR Supply Movement |
A commodity movement between supply-chain nodes — receipt at a facility, issue to a distribution post or field team, return of unused stock. The STOCK-bearing supply event: carries the stock-accountability ledger (received/used/remaining/not-usable/returned, concordance, VVM) and never counts toward coverage. Chains via partOf → the upstream movement (central store → district → post → team). v1 scope is campaign-tied movements only; routine inter-warehouse logistics is out of scope (OpenLMIS territory). |
| ICR Survey Coverage |
Independently-measured coverage — post-campaign cluster survey, LQAS, or RCM — with method, sample design, and date. A separately-sourced, first-class measure of the same quantity as administrative coverage: the two routinely diverge (Cuamba, Mozambique: ~99% admin vs ~76% survey) and must never be collapsed. |
| ICR Target Population |
A target-population denominator: a conceptual cohort (actual=false) with a count, eligibility characteristics, and — critically — source and date provenance. Multiple competing estimates per geography are retained; exactly one is flagged as the planning denominator (working doc 7.6, 7.6, |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Campaign |
The campaign round — the ICRCampaign CarePlan — this record belongs to. The uniform record→campaign join: delivery events (Immunization, MedicationAdministration, SupplyDelivery) and coverage reports (MeasureReport) all point AT their campaign, in the same direction as Task.basedOn — the CarePlan itself is never rewritten as records accumulate. Replaces the core event-basedOn extension previously used on the delivery profiles: its R4 context is Condition-only, so every use on a delivery resource was context-invalid, and MeasureReport needs the same link (a coverage report otherwise has no computable path back to its campaign). |
||||
| Campaign Round |
Round number of this campaign execution. Each round is its own CarePlan instantiating the same protocol, linked to an umbrella campaign via CarePlan.partOf (working doc §6.3). |
||||
| Coverage Source |
The measurement lineage of this coverage report: administrative vs survey/LQAS/RCM. The two lineages routinely diverge (Cuamba: ~99% admin vs ~76% survey) and must never be merged (working doc §4.1). |
||||
| Coverage Unit |
What the coverage figure counts: people, or implementation units (villages/areas = geographic coverage). Absent ⇒ people (espen-v3 / §17.2 B1). |
||||
| Delivery Strategy |
How this activity/task reaches its target population. First-class and coded because a single campaign routinely mixes strategies, and the strategy governs which data elements exist. The protocol lists the options (1..*), the Task records the choice (1..1), the activity is an optional pin — the strategy is campaign programme state and deliberately does NOT live on Location: per the georegistry rule a site's durable kind is Location.type (facility, temporary-post, school…), and which strategy a site serves in a given campaign belongs to that campaign's Tasks (working doc §3). |
||||
| Denominator Source |
The method/source behind this population estimate (census, microcensus, WorldPop, GRID3…). Reuse is only safe with provenance (working doc 2.3, 2.3, |
||||
| Denominator Type |
Whether the denominator is the TOTAL population or the AT-RISK/eligible subset — programme vs epidemiological coverage in NTD MDA. On a coverage MeasureReport it qualifies the figure; on an ICRTargetPopulation it labels the estimate (espen-v3 / §17.2 B1). |
||||
| Directly Observed Consumption |
Whether the community drug distributor physically observed the individual swallow the medication (MDA DOC protocol). |
||||
| Distribution Recipient |
Who received a distributed commodity — the delivery-unit Group (household, community, school cohort) or a registered person. R4 SupplyDelivery.patient targets only Patient, but ICR's usual recipient is the household; this extension supplies the Group join that per-capita coverage (e.g. 1 net per 2 household members: quantity ÷ Group.quantity) computes against (supply-split round). |
||||
| Dose-pole Band |
The measured dose-pole height band that determined the tablet count for a PC-NTD treatment — makes the height-band → dose logic machine-readable rather than buried in dosage.text. Bands are drug-specific and carried as text or local codings; deliberately unbound — no universal band ValueSet exists (espen-v3 minor-issue). |
||||
| Estimate Confidence |
Free-text or coded confidence qualifier on a population estimate. |
||||
| Estimate Date |
When this population estimate was made. Denominators decay fast (1–3 years); a stale denominator silently reused produces confident, wrong coverage. |
||||
| Group Location |
The physical Location of a delivery-unit Group — the validated Ona pattern: Group (who) + Location (where). For a household the Location is the dwelling (carrying the GERS building ID); for a community it is the settlement or community point; for a school cohort it is the school. This is the group's RESIDENCE/BASE, not its service point: where service actually happened is Task.location and the delivery event's own location — a household served at a village distribution center keeps its dwelling here unchanged (working doc 7.5, 7.5, |
||||
| Is Calculated |
True when this estimate was computed by aggregating other estimates — ward figures summed to a district, or a share apportioned from a parent figure — rather than sourced independently; denominator-source then describes the method of the underlying inputs. A calculated figure is not independent evidence for its inputs (comparing it against them is not corroboration) and goes stale when any input is revised. Absent = not known to be calculated. A future derived-from reference list may carry the actual input estimates; its presence would imply this flag (reviewer proposal, working doc §5.2 c10). |
||||
| Is Planning Denominator |
True when this estimate is the one flagged as the campaign's planning denominator among competing estimates for the same geography. |
||||
| Issued To Team |
The CareTeam a supply movement was issued to. R4 SupplyDelivery.receiver targets only individual practitioners — the same gap (and same fix) as MeasureReport.reporter → reporter-team. One issuance per team per day, with its stock-accountability ledger, is the field-team daily-stock pattern (supply-split round). |
||||
| Location Boundary (GeoJSON) |
Boundary geometry for a Location — district polygons, settlement areas, catchment zones — as a GeoJSON attachment. R4 extension mirroring the R5 standard boundary extension; alignment path is working doc §10 question 6. |
||||
| Oversees Area |
The supervisory/operational-area Location(s) a CareTeam's supervisor covers — ties the team to operational geography (working doc 5.5, 5.5, |
||||
| Planning Denominator |
The target-population Group flagged as this campaign's planning denominator. Multiple competing estimates may exist per geography; exactly one is the planning denominator (working doc §4.2). |
||||
| Prior-dose Status (Zero-dose) |
The person's prior-dose status for this antigen at the time of the campaign contact: zero-dose (never received before), previously-received, or no-recall. The per-event carrier of the polio SIA tally's never/previously/no-recall split; aggregates to the dose-history coverage stratifier and feeds zero-dose reach / dropout measures. Distinct from Immunization.protocolApplied.doseNumber, which counts this series' doses, not prior status of the antigen (forms-v1 / jul3-form-analysis §Aggregate #1). |
||||
| Real-time vs Reconciled |
Data lineage of this record: the real-time operational stream or the post-campaign reconciled stream. One structure serves both; consumers filter by lineage — dashboards read realtime, JAP exports read reconciled (working doc §4.3). Default semantics: ABSENT MEANS REALTIME — live-stream records may omit the flag, but reconciled records must carry it, and coverage MeasureReports always carry it (1..1 on both coverage profiles). |
||||
| Record Origin |
Whether this delivery event was recorded during a campaign or a routine facility visit. REQUIRED on all ICR delivery-event profiles — without it, SIA doses contaminate routine coverage analytics (working doc §4.4). Also valid on AdverseEvent so a campaign-context AEFI/side-effect stays separable from routine pharmacovigilance (v0.19.0). |
||||
| Reporter Team |
|
||||
| Sample Design |
Sample design / method detail of an independently-measured coverage estimate — e.g. 'WHO 30×10 cluster survey, district-representative', LQAS lot definition, RCM site-selection note. Survey coverage without its design is uninterpretable (working doc §4.1). |
||||
| Serious-Event Criteria |
Why an adverse event is serious — the WHO/CIOMS criterion/criteria behind AdverseEvent.seriousness = serious (death, life-threatening, hospitalization, disability, congenital anomaly, other medically important) (espen-v4 / §17.2 C1). |
||||
| Settlement / Special-population Type |
The settlement or special-population classification of a place (urban / rural / slum / refugee-IDP / nomad-pastoralist / security-compromised / hard-to-reach / cross-border / immigrant) — the recurring 'type of settlement' axis on the polio SIA monitoring/tally forms. A vulnerability/equity attribute of a Location that drives hard-to-reach-area targeting and equity disaggregation (forms-v1 / jul3-form-analysis §Aggregate #5). |
||||
| Social Mobilization |
Demand-generation for a campaign/round: whether the population was informed beforehand and the channels used (ESPEN supervision Form 5). The demand axis of §17.3 (espen-v4). |
||||
| Stock Accountability |
Vial/commodity accountability and wastage on a supply event — received / used / remaining / not-usable (expired/damaged) / returned, plus physical-vs-theoretical concordance and (vaccines) the VVM stage. Reusable for vaccines, drugs and ITNs; the ESPEN supervision Form 5 stock block (espen-v4 / §17.2 C2). |
||||
| Target Geography |
The geography (admin unit or operational area) this campaign targets. |
||||
| Task Origin |
Whether this Task was generated in advance from the microplan or registered in the field on discovery. REQUIRED on ICRCampaignTask — field-registered counts per area measure how incomplete the microplan's enumeration was, feeding the next round's denominators (working doc §10 q1). |
||||
| Workload Target |
The microplan workload assigned to a CareTeam — the area(s) it covers and the expected volume (population / households / days). With oversees-area, makes the CareTeam the typed team-area-workload unit of the microplan (the ICRCampaign with intent=plan is the microplan itself) (espen-v4 / §17.3). |
These define sets of codes used by systems conforming to this implementation guide.
| ICR Adverse Event Causality |
WHO/CIOMS causality categories. Binding: extensible on ICRAdverseEvent causality assessment. |
| ICR Adverse Event Seriousness |
Serious vs non-serious. Binding: extensible on ICRAdverseEvent.seriousness — uses the HL7 adverse-event-seriousness code system. |
| ICR Campaign Type |
Campaign types by delivery model. Binding: required on ICRCampaignProtocol.type and ICRCampaign.category. |
| ICR Communication Channel |
Social-mobilization channels. Binding: extensible on the social-mobilization extension's channel. |
| ICR Coverage Source |
All coverage measurement lineages. |
| ICR Coverage Stratifier |
Standard coverage disaggregation axes. Binding: extensible on the Measure/MeasureReport stratifier code (espen-v3 / §17.2 B1). |
| ICR Coverage Unit |
People vs implementation-units (geographic coverage). Binding: required on the coverage-unit extension. |
| ICR Data Lineage |
Real-time vs reconciled lineage. Binding: required on the realtime-vs-reconciled extension. |
| ICR Delivery Strategy |
Delivery strategies. Binding: required on the delivery-strategy extension. |
| ICR Denominator Source |
Sources of population denominators. Binding: extensible. |
| ICR Denominator Type |
Total-population vs at-risk/eligible denominator. Binding: required on the denominator-type extension. |
| ICR Dose History / Zero-dose Status |
Prior-dose status (zero-dose / previously-received / no-recall). Binding: required on the prior-dose-status extension; also the value space of the dose-history coverage stratifier (forms-v1). |
| ICR Endemicity Status |
The JRSM-aligned endemicity ladder. Binding: extensible (not required) on ICRLocationStatus.valueCodeableConcept, because future non-endemicity property codes carry their own value vocabularies. |
| ICR Exclusion Reason |
Reasons a present, age-eligible person was clinically excluded from treatment (under-height/age, pregnant, breastfeeding, acutely ill). Binding: extensible — countries may add local codes. |
| ICR Facility Ownership |
Facility ownership / managing authority, on the facility Organization's type. Binding: extensible — countries add local ownership categories. |
| ICR Facility Type |
National facility-classification tiers, on the facility Organization's type. Binding: extensible — countries add their national facility kinds. |
| ICR Group Kind |
Delivery-unit Group kinds (household / community). Binding: required on ICRDeliveryUnit.code. |
| ICR Independent Coverage Source |
Independently-measured coverage lineages only (survey / LQAS / RCM) — the ICRSurveyCoverage binding. |
| ICR Location Status |
Location-scoped property codes. Binding: extensible on ICRLocationStatus.code, so country-specific location properties stay legal. |
| ICR Location Type |
Campaign-relevant location types, including operational geography. Binding: extensible on ICRLocation.type — countries may add local types. |
| ICR MDA Medication |
WHO ATC-coded preventive-chemotherapy medications. Binding: extensible — local formulary codes map back via ConceptMap. Includes the full ATC system; typical PC-NTD codes are albendazole P02CA03, ivermectin P02CA01, praziquantel P02BA01, azithromycin J01FA10, diethylcarbamazine P02CB02. Restricting to a PC-NTD subtree is deferred until country formularies are reviewed. |
| ICR MDA Medicine Package |
MDA medicine packages, single and combined (espen-forms). |
| ICR Missed Reason |
Reasons an eligible person/household was missed. Binding: extensible — countries may add local codes. |
| ICR NTD Disease |
Diseases covered by an MDA campaign (espen-forms). |
| ICR Record Origin |
Campaign vs routine record origin. Binding: required on the record-origin extension. |
| ICR Refusal Reason |
Reasons for intervention refusal (WHO IDHC term; ESPEN forms say noncompliance). Binding: extensible — countries may add local codes. |
| ICR Revisit Outcome |
Outcome of a follow-up revisit (already-vaccinated / vaccinated-on-revisit / still-missing). Binding: extensible on the revisit-outcome extension (forms-v1). |
| ICR Serious-Event Criteria |
WHO/CIOMS serious-event criteria. Binding: extensible on the serious-criteria extension. |
| ICR Settlement / Special-population Type |
Settlement / special-population classification of a Location. Binding: extensible on the settlement-type extension — countries add local codes (forms-v1). |
| ICR Supplied Item |
Coded products carried by the supply profiles (ICRSupplyDistribution, ICRSupplyMovement). Binding: extensible. Drug commodities (MDA receipts/distribution, vitamin A) use WHO ATC — added v0.18.0 (espen.md rec 3) so a drug receipt → administration → reconciliation share one ATC code. Physical commodities use the ICR commodity class (llin, irs-insecticide, rdt) as the analytics-stable coding, optionally alongside a GS1 GTIN coding for the specific product (GTINs are per-manufacturer and cannot be enumerated here); text as fallback (supply-split round). |
| ICR Task Origin |
Pre-planned vs field-registered task origin. Binding: required on the task-origin extension. |
| ICR Task Output Type |
The standard Task.output axes. Binding: extensible on ICRCampaignTask.output.type, so campaign-specific output types (e.g. 'rooms treated' under IRS) stay legal as custom codes or text. |
| ICR Team Role |
Campaign CareTeam member roles. Binding: extensible on ICRCareTeam.participant.role. |
These define new code systems used by systems conforming to this implementation guide.
| ICR Adverse Event Causality |
WHO/CIOMS causality classification of an adverse event following an intervention — intervention-neutral: covers AEFI (immunization) and MDA drug pharmacovigilance alike. Top-level WHO categories; immunization implementations may use WHO IMMZ.AdverseEvent's finer A1–A4 subtypes (espen-v3 / §17.2 C1). |
| ICR Campaign Type |
The type of public health campaign, grouped by delivery model rather than disease (working doc §3). |
| ICR Commodity Class |
Analytics-stable classes for physical campaign commodities. GS1 GTINs identify a specific manufacturer's product and cannot be enumerated in a value set; the class code is what measures count ('how many nets'), while a GTIN coding may sit alongside it in the same CodeableConcept ('which net'). Drug commodities do not live here — they stay WHO ATC (supply-split round). |
| ICR Communication Channel |
Social-mobilization / demand-generation channels used to inform the population ahead of and during a campaign (ESPEN supervision Form 5). Bound extensible (espen-v4 / §17.3). |
| ICR Coverage Source |
The measurement lineage of a coverage figure. Administrative and independently-measured coverage are separately-sourced, first-class measures of the same conceptual quantity and must never be collapsed (working doc §4.1). |
| ICR Coverage Stratifier |
The standard disaggregation axes a coverage MeasureReport stratifies by (and a Measure declares). Formalises the v0.18.0 stratified-tally pattern into a named contract (espen-v3 / §17.2 B1). |
| ICR Coverage Unit |
What is being counted in a coverage figure: people, or implementation units. Implementation-unit coverage is geographic coverage — villages/areas treated ÷ total (ESPEN supervision Form 5; espen-v3 / §17.2 B1). |
| ICR Data Lineage |
Whether a record belongs to the real-time operational stream or the post-campaign reconciled stream. One structure serves both; consumers filter by lineage (working doc §4.3). |
| ICR Delivery Strategy |
How a campaign activity reaches its target population. A first-class, coded attribute of every campaign activity, site, and task — campaigns routinely mix strategies, and the available data elements change with the strategy (working doc §3). |
| ICR Denominator Source |
The method/source behind a target-population estimate. Every estimate carries its source and date — the denominator is the dominant source of error in campaign analytics (working doc §4.2). |
| ICR Denominator Type |
Whether a coverage figure (or a target-population estimate) is measured against the TOTAL population or the AT-RISK/eligible subset — the difference between programme coverage and epidemiological coverage in NTD MDA (espen-v3 / §17.2 B1). |
| ICR Dose History / Zero-dose Status |
A person's prior-dose status for the campaign antigen, at the time of a campaign contact — the polio SIA tally's core split (never received / previously received / no recall) and the zero-dose vs not-zero-dose axis. Carried per event by the prior-dose-status extension and aggregated as the dose-history coverage stratifier; feeds zero-dose reach and the proposed dropout/fully-immunized measures (forms-v1 / jul3-form-analysis §Aggregate #1). |
| ICR Endemicity Status |
The endemicity classification ladder for a location, aligned with the WHO JRSM district-level endemicity categories — the value side of the ICRLocationStatus endemicity property codes. |
| ICR Exclusion Reason |
Why a PRESENT, age-eligible person was not treated because they are clinically ineligible/contraindicated for the intervention this round — as opposed to being MISSED (not reached, ICRMissedReasonCS) or DECLINING (ICRNoncomplianceReasonCS). The MDA case (ESPEN treatment Form 3): under the dose-pole minimum, pregnant, breastfeeding, acutely ill. Added v0.18.0 (espen.md rec 2 / §17.4 NTD specifics). |
| ICR Facility Ownership |
Ownership / managing-authority classification for the facility Organization — a second Organization.type axis (base FHIR Organization has no ownership element; carrying it as a type coding is the mCSD/OpenHIE convention). The governmental tier detail (local/state/federal) travels as display/text or a country localization. |
| ICR Facility Type |
National facility-classification tiers for the mCSD-style facility Organization (working doc §5.3 facility pairing). The authoritative classification axis lives on Organization.type — not Location.type — because facility level is an administrative designation (funding, staffing norms, reporting), which is an Organization concern. Codes are the broad tiers shared across national MFLs; the country-specific kind (e.g. Nigeria NHFR 'Primary Health Center' vs 'Health Post') travels as the coding display/text or a country localization system. |
| ICR Group Characteristic |
Characteristic codes for ICR Group profiles — the geographic-scope characteristic that links a target-population estimate to its Location, making estimates computably joinable to the location hierarchy (working doc §7.6), plus the age-band characteristic used to scope age-specific denominator Groups (espen-forms). |
| ICR Group Kind |
The kind of delivery-unit Group a campaign Task acts on. Households, communities, and school cohorts are groups: they have members and an associated Location, and share the same Group + Location pattern; this code distinguishes them. A delivery unit without members (a structure under IRS, a temporary service point, an area target) is a Location, not a Group (working doc 3.2, 3.2, |
| ICR Location Status |
Pre-coordinated property codes for location-scoped status assertions (ICRLocationStatus): WHAT is being asserted about a place. One code per property × disease — the same pre-coordination pattern as the campaign-type and stratifier vocabularies — so 'which districts are LF-endemic' is a single-code query. A new location property is a new code here, not a new profile. |
| ICR Location Type |
Campaign-relevant location types. Type — not tree position — is what distinguishes official administrative units from operational geography: every Location lives in the single partOf containment tree, and administrative rollups filter on type = admin-unit (working doc §9). |
| ICR MDA Medicine Package |
The medicine package distributed in an MDA round — single drugs and the standard co-administration combinations (ESPEN medicine list, espen-forms). |
| ICR Missed Reason |
Why an eligible person or household was not reached during a campaign visit. |
| ICR NTD Disease |
The preventive-chemotherapy NTDs an MDA campaign addresses — the disease-scope axis of the ESPEN MDA instruments (espen-forms). |
| ICR Project Tag |
Project/programme provenance tags applied as meta.tag on example instances, so the example gallery can be filtered by the source project or instrument set (espen-forms). |
| ICR Record Origin |
Whether a delivery event originated in a campaign or a routine facility visit. Required on every ICR delivery event so SIA doses never contaminate routine coverage analytics, and routine history observed during campaigns stays analyzable (working doc §4.4). |
| ICR Refusal Reason |
Why a household or caregiver refused the intervention (WHO IDHC: 'intervention refusal'; ESPEN forms say noncompliance) — drives social-mobilization targeting and mop-up planning. |
| ICR Revisit Outcome |
The outcome of a follow-up visit to a household/person previously missed — the 'outcome of the revisit' block of the missed-children recording forms. Carried on the follow-up Task via the revisit-outcome extension (forms-v1 / jul3-form-analysis §Aggregate #4). |
| ICR Serious-Event Criteria |
WHO/CIOMS criteria that make an adverse event SERIOUS — the reason behind AdverseEvent.seriousness = serious. Intervention-neutral (AEFI and MDA pharmacovigilance) (espen-v4 / §17.2 C1). |
| ICR Settlement / Special-population Type |
The settlement or special-population classification of a place — the recurring 'type of settlement' axis on the polio SIA monitoring/tally forms (urban / rural / slum / refugee-IDP / nomad-pastoralist / security-compromised / hard-to-reach / cross-border / immigrant). A vulnerability/equity attribute of a Location, carried by the settlement-type extension; drives hard-to-reach-area (HTRA) targeting and equity disaggregation (forms-v1 / jul3-form-analysis §Aggregate #5). Bound extensible — countries add local codes. |
| ICR Task Origin |
Whether a campaign Task was generated in advance from the microplan or registered in the field on discovery. Field-registered counts per area measure how incomplete the microplan's enumeration was — input to the next round's denominators (working doc §10 q1). |
| ICR Task Output Type |
The standard axes of what a campaign visit produced — the coded vocabulary of Task.output.type (task-outputs round). Parameters of the work (delivery strategy, task origin) stay Task extensions; RESULTS of executing the visit are coded outputs. A new tally axis is a new code here, not a new extension. The house-to-house axes (houses-visited, eligible-present, eligible-absent, children-already-marked) have no meaning at a fixed post — strategy determines which outputs exist (icr-task-h2h-outputs). |
| ICR Team Role |
Role of a member within a campaign CareTeam — the front-line delivery and supervision roles (working doc §5.5). Bound extensible: countries add local roles. Supervisor level (national/regional/district/partner/health-facility, ESPEN Forms 5/6) is carried by managingOrganization or the overseen area, not multiplied into roles. |
These define transformations to convert between codes by systems conforming with this implementation guide.
| ICR ↔ WHO IMMZ AEFI Causality |
Maps ICRAdverseEventCausalityCS (WHO/CIOMS A/B/C/D) to the WHO SMART Immunizations AEFI causality categories. Provisional — target codes to be confirmed against the published IMMZ IG (§18.3). |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.