Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build
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
| Draft as of 2026-10-29 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
<http://hl7.org/fhir/CodeSystem/icr-task-output-type-cs> a fhir:CodeSystem ;
fhir:nodeRole fhir:treeRoot ;
fhir:Resource.id [ fhir:value "icr-task-output-type-cs"] ;
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "generated" ] ;
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem icr-task-output-type-cs</b></p><a name=\"icr-task-output-type-cs\"> </a><a name=\"hcicr-task-output-type-cs\"> </a><p>This case-sensitive code system <code>https://icr.healthcampaigns.org/CodeSystem/icr-task-output-type-cs</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">treated-count<a name=\"icr-task-output-type-cs-treated-count\"> </a></td><td>Persons treated / vaccinated (scalar tally)</td><td>The visit's scalar result tally: persons treated or vaccinated.</td></tr><tr><td style=\"white-space:nowrap\">houses-visited<a name=\"icr-task-output-type-cs-houses-visited\"> </a></td><td>Houses visited</td><td>Number of houses visited — house-to-house tasks at area/team-day granularity.</td></tr><tr><td style=\"white-space:nowrap\">eligible-present<a name=\"icr-task-output-type-cs-eligible-present\"> </a></td><td>Eligible persons present</td><td>Number of eligible persons (per the protocol's target definition) present at the visit(s). Program-neutral.</td></tr><tr><td style=\"white-space:nowrap\">eligible-absent<a name=\"icr-task-output-type-cs-eligible-absent\"> </a></td><td>Eligible persons absent</td><td>Number of eligible persons absent at the visit(s) — feeds same-day mop-up lists.</td></tr><tr><td style=\"white-space:nowrap\">children-already-marked<a name=\"icr-task-output-type-cs-children-already-marked\"> </a></td><td>Children already finger-marked</td><td>Number of children found already finger-marked (already covered this round) on arrival — house-to-house campaigns.</td></tr><tr><td style=\"white-space:nowrap\">missed-reason<a name=\"icr-task-output-type-cs-missed-reason\"> </a></td><td>Missed reason</td><td>Why eligible person(s) were missed at this visit — person-level (absent, sleeping) and area-level (insecurity, shortage, access) causes.</td></tr><tr><td style=\"white-space:nowrap\">noncompliance-reason<a name=\"icr-task-output-type-cs-noncompliance-reason\"> </a></td><td>Refusal reason</td><td>Why the household/caregiver refused the intervention (WHO IDHC 'intervention refusal') — drives social mobilization and mop-up targeting.</td></tr><tr><td style=\"white-space:nowrap\">exclusion-reason<a name=\"icr-task-output-type-cs-exclusion-reason\"> </a></td><td>Exclusion reason</td><td>Why a present, age-eligible person was clinically excluded this round (under dose-pole height/age, pregnant, breastfeeding, acutely ill).</td></tr><tr><td style=\"white-space:nowrap\">revisit-outcome<a name=\"icr-task-output-type-cs-revisit-outcome\"> </a></td><td>Revisit outcome</td><td>Outcome of a person-targeted follow-up revisit: already-vaccinated | vaccinated-on-revisit | still-missing.</td></tr><tr><td style=\"white-space:nowrap\">delivery-event<a name=\"icr-task-output-type-cs-delivery-event\"> </a></td><td>Delivery event reference</td><td>Reference to an Immunization / MedicationAdministration / supply event captured inside the visit workflow.</td></tr><tr><td style=\"white-space:nowrap\">coverage-report<a name=\"icr-task-output-type-cs-coverage-report\"> </a></td><td>Coverage report reference</td><td>Reference to the stratified MeasureReport that disaggregates this visit's tally.</td></tr><tr><td style=\"white-space:nowrap\">referred-count<a name=\"icr-task-output-type-cs-referred-count\"> </a></td><td>Persons referred</td><td>Number of people referred at this visit (each referral is an ICRReferral), so visit tallies need not count ServiceRequests and count-only capture can still report referrals.</td></tr><tr><td style=\"white-space:nowrap\">registered-count<a name=\"icr-task-output-type-cs-registered-count\"> </a></td><td>Persons registered</td><td>Number of people registered into the campaign at this visit — on a separate registration visit or during a delivery visit alike.</td></tr><tr><td style=\"white-space:nowrap\">registered-household<a name=\"icr-task-output-type-cs-registered-household\"> </a></td><td>Household registered</td><td>A household (ICRDeliveryUnit) registered into the campaign at this visit: on a household visit the Task's own household, on a site session each household registered there. A household can be registered without any new person being registered. Households registered in a round = the distinct registered-household references.</td></tr><tr><td style=\"white-space:nowrap\">voucher<a name=\"icr-task-output-type-cs-voucher\"> </a></td><td>Voucher issued</td><td>The voucher or QR code issued at registration, as an Identifier with one system per campaign round. The distribution that redeems it carries the same system and value as an identifier of type voucher.</td></tr><tr><td style=\"white-space:nowrap\">entitlement<a name=\"icr-task-output-type-cs-entitlement\"> </a></td><td>Entitlement</td><td>What the registered household is due, as a Quantity (for example 3 LLINs).</td></tr></table></div>"
] ;
fhir:CodeSystem.url [ fhir:value "https://icr.healthcampaigns.org/CodeSystem/icr-task-output-type-cs"] ;
fhir:CodeSystem.version [ fhir:value "0.1.0"] ;
fhir:CodeSystem.name [ fhir:value "ICRTaskOutputTypeCS"] ;
fhir:CodeSystem.title [ fhir:value "ICR Task Output Type"] ;
fhir:CodeSystem.status [ fhir:value "draft"] ;
fhir:CodeSystem.experimental [ fhir:value "false"^^xsd:boolean] ;
fhir:CodeSystem.date [ fhir:value "2026-10-29T03:03:58+00:00"^^xsd:dateTime] ;
fhir:CodeSystem.publisher [ fhir:value "UNICEF"] ;
fhir:CodeSystem.contact [
fhir:index 0 ;
fhir:ContactDetail.name [ fhir:value "UNICEF" ] ;
fhir:ContactDetail.telecom [
fhir:index 0 ;
fhir:ContactPoint.system [ fhir:value "url" ] ;
fhir:ContactPoint.value [ fhir:value "https://www.unicef.org" ]
]
] ;
fhir:CodeSystem.description [ fhir:value "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)."] ;
fhir:CodeSystem.jurisdiction [
fhir:index 0 ;
fhir:CodeableConcept.coding [
fhir:index 0 ;
fhir:Coding.system [ fhir:value "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:Coding.code [ fhir:value "001" ] ;
fhir:Coding.display [ fhir:value "World" ]
]
] ;
fhir:CodeSystem.caseSensitive [ fhir:value "true"^^xsd:boolean] ;
fhir:CodeSystem.content [ fhir:value "complete"] ;
fhir:CodeSystem.count [ fhir:value "16"^^xsd:nonNegativeInteger] ;
fhir:CodeSystem.concept [
fhir:index 0 ;
fhir:CodeSystem.concept.code [ fhir:value "treated-count" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Persons treated / vaccinated (scalar tally)" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "The visit's scalar result tally: persons treated or vaccinated." ]
], [
fhir:index 1 ;
fhir:CodeSystem.concept.code [ fhir:value "houses-visited" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Houses visited" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Number of houses visited — house-to-house tasks at area/team-day granularity." ]
], [
fhir:index 2 ;
fhir:CodeSystem.concept.code [ fhir:value "eligible-present" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Eligible persons present" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Number of eligible persons (per the protocol's target definition) present at the visit(s). Program-neutral." ]
], [
fhir:index 3 ;
fhir:CodeSystem.concept.code [ fhir:value "eligible-absent" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Eligible persons absent" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Number of eligible persons absent at the visit(s) — feeds same-day mop-up lists." ]
], [
fhir:index 4 ;
fhir:CodeSystem.concept.code [ fhir:value "children-already-marked" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Children already finger-marked" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Number of children found already finger-marked (already covered this round) on arrival — house-to-house campaigns." ]
], [
fhir:index 5 ;
fhir:CodeSystem.concept.code [ fhir:value "missed-reason" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Missed reason" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Why eligible person(s) were missed at this visit — person-level (absent, sleeping) and area-level (insecurity, shortage, access) causes." ]
], [
fhir:index 6 ;
fhir:CodeSystem.concept.code [ fhir:value "noncompliance-reason" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Refusal reason" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Why the household/caregiver refused the intervention (WHO IDHC 'intervention refusal') — drives social mobilization and mop-up targeting." ]
], [
fhir:index 7 ;
fhir:CodeSystem.concept.code [ fhir:value "exclusion-reason" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Exclusion reason" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Why a present, age-eligible person was clinically excluded this round (under dose-pole height/age, pregnant, breastfeeding, acutely ill)." ]
], [
fhir:index 8 ;
fhir:CodeSystem.concept.code [ fhir:value "revisit-outcome" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Revisit outcome" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Outcome of a person-targeted follow-up revisit: already-vaccinated | vaccinated-on-revisit | still-missing." ]
], [
fhir:index 9 ;
fhir:CodeSystem.concept.code [ fhir:value "delivery-event" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Delivery event reference" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Reference to an Immunization / MedicationAdministration / supply event captured inside the visit workflow." ]
], [
fhir:index 10 ;
fhir:CodeSystem.concept.code [ fhir:value "coverage-report" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Coverage report reference" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Reference to the stratified MeasureReport that disaggregates this visit's tally." ]
], [
fhir:index 11 ;
fhir:CodeSystem.concept.code [ fhir:value "referred-count" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Persons referred" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Number of people referred at this visit (each referral is an ICRReferral), so visit tallies need not count ServiceRequests and count-only capture can still report referrals." ]
], [
fhir:index 12 ;
fhir:CodeSystem.concept.code [ fhir:value "registered-count" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Persons registered" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Number of people registered into the campaign at this visit — on a separate registration visit or during a delivery visit alike." ]
], [
fhir:index 13 ;
fhir:CodeSystem.concept.code [ fhir:value "registered-household" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Household registered" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "A household (ICRDeliveryUnit) registered into the campaign at this visit: on a household visit the Task's own household, on a site session each household registered there. A household can be registered without any new person being registered. Households registered in a round = the distinct registered-household references." ]
], [
fhir:index 14 ;
fhir:CodeSystem.concept.code [ fhir:value "voucher" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Voucher issued" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "The voucher or QR code issued at registration, as an Identifier with one system per campaign round. The distribution that redeems it carries the same system and value as an identifier of type voucher." ]
], [
fhir:index 15 ;
fhir:CodeSystem.concept.code [ fhir:value "entitlement" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Entitlement" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "What the registered household is due, as a Quantity (for example 3 LLINs)." ]
] .
# - ontology header ------------------------------------------------------------
<http://hl7.org/fhir/CodeSystem/icr-task-output-type-cs.ttl> a owl:Ontology ;
owl:imports fhir:fhir.ttl ;
owl:versionIRI <http://build.fhir.org/CodeSystem/icr-task-output-type-cs.ttl> .
IG © 2026+ UNICEF. Package unicef.fhir.icr#0.1.0 based on FHIR 4.0.1. Generated 2026-10-29
Links: Table of Contents |
QA Report