Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build International flag

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

Resource Profile: ICR Delivery Unit (Household / Community)

Official URL: https://icr.healthcampaigns.org/StructureDefinition/ICRDeliveryUnit Version: 0.1.0
Draft as of 2026-08-07 Computable Name: ICRDeliveryUnit

The actual Group of people a campaign Task acts on — a household (Type B house-to-house), a community (Type C MDA), or a school cohort (school-based delivery), distinguished by the required group-kind code. 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. Type A's delivery unit is a site, which is a Location, not a Group (working doc 3.2, 3.2,

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:groupLocation S 1..1 Reference(ICR Location) Residence/base, not service point: the dwelling (household), settlement/community point (community), or school (school-cohort)
URL: https://icr.healthcampaigns.org/StructureDefinition/group-location
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... actual ΣC 1..1 boolean Descriptive or actual
Required Pattern: true
... code SΣ 1..1 CodeableConcept household | community | school-cohort
Binding: ICR Group Kind (required)
... quantity SΣ 0..1 unsignedInt Head-count fallback where individuals are not enumerated (register-level MDA); coexists with an enumerated member list
... member SC 0..* BackboneElement Who or what is in group
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The enumerated individuals — the mainline capture mode for community-and-household campaigns; never a sub-Group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required ICR Group Kind 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:groupLocation S 1..1 Reference(ICR Location) Residence/base, not service point: the dwelling (household), settlement/community point (community), or school (school-cohort)
URL: https://icr.healthcampaigns.org/StructureDefinition/group-location
... type 1..1 code person | animal | practitioner | device | medication | substance
Required Pattern: person
... actual 1..1 boolean Descriptive or actual
Required Pattern: true
... quantity S 0..1 unsignedInt Head-count fallback where individuals are not enumerated (register-level MDA); coexists with an enumerated member list
... member S 0..* BackboneElement Who or what is in group
.... entity 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The enumerated individuals — the mainline capture mode for community-and-household campaigns; never a sub-Group

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.code Base required ICR Group Kind 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:groupLocation S 1..1 Reference(ICR Location) Residence/base, not service point: the dwelling (household), settlement/community point (community), or school (school-cohort)
URL: https://icr.healthcampaigns.org/StructureDefinition/group-location
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique id
... active Σ 0..1 boolean Whether this group's record is in active use
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person
... actual ΣC 1..1 boolean Descriptive or actual
Required Pattern: true
... code SΣ 1..1 CodeableConcept household | community | school-cohort
Binding: ICR Group Kind (required)
... name Σ 0..1 string Label for Group
... quantity SΣ 0..1 unsignedInt Head-count fallback where individuals are not enumerated (register-level MDA); coexists with an enumerated member list
... managingEntity Σ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
... characteristic 0..* BackboneElement Include / Exclude group members by Trait
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
.... value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude 1..1 boolean Group includes or excludes
.... period 0..1 Period Period over which characteristic is tested
... member SC 0..* BackboneElement Who or what is in group
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The enumerated individuals — the mainline capture mode for community-and-household campaigns; never a sub-Group
.... period 0..1 Period Period member belonged to the group
.... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required ICR Group Kind 📦0.1.0 This IG
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

This structure is derived from Group

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:groupLocation S 1..1 Reference(ICR Location) Residence/base, not service point: the dwelling (household), settlement/community point (community), or school (school-cohort)
URL: https://icr.healthcampaigns.org/StructureDefinition/group-location
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... actual ΣC 1..1 boolean Descriptive or actual
Required Pattern: true
... code SΣ 1..1 CodeableConcept household | community | school-cohort
Binding: ICR Group Kind (required)
... quantity SΣ 0..1 unsignedInt Head-count fallback where individuals are not enumerated (register-level MDA); coexists with an enumerated member list
... member SC 0..* BackboneElement Who or what is in group
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The enumerated individuals — the mainline capture mode for community-and-household campaigns; never a sub-Group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required ICR Group Kind 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:groupLocation S 1..1 Reference(ICR Location) Residence/base, not service point: the dwelling (household), settlement/community point (community), or school (school-cohort)
URL: https://icr.healthcampaigns.org/StructureDefinition/group-location
... type 1..1 code person | animal | practitioner | device | medication | substance
Required Pattern: person
... actual 1..1 boolean Descriptive or actual
Required Pattern: true
... quantity S 0..1 unsignedInt Head-count fallback where individuals are not enumerated (register-level MDA); coexists with an enumerated member list
... member S 0..* BackboneElement Who or what is in group
.... entity 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The enumerated individuals — the mainline capture mode for community-and-household campaigns; never a sub-Group

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.code Base required ICR Group Kind 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:groupLocation S 1..1 Reference(ICR Location) Residence/base, not service point: the dwelling (household), settlement/community point (community), or school (school-cohort)
URL: https://icr.healthcampaigns.org/StructureDefinition/group-location
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Unique id
... active Σ 0..1 boolean Whether this group's record is in active use
... type Σ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person
... actual ΣC 1..1 boolean Descriptive or actual
Required Pattern: true
... code SΣ 1..1 CodeableConcept household | community | school-cohort
Binding: ICR Group Kind (required)
... name Σ 0..1 string Label for Group
... quantity SΣ 0..1 unsignedInt Head-count fallback where individuals are not enumerated (register-level MDA); coexists with an enumerated member list
... managingEntity Σ 0..1 Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) Entity that is the custodian of the Group's definition
... characteristic 0..* BackboneElement Include / Exclude group members by Trait
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
.... value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude 1..1 boolean Group includes or excludes
.... period 0..1 Period Period over which characteristic is tested
... member SC 0..* BackboneElement Who or what is in group
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The enumerated individuals — the mainline capture mode for community-and-household campaigns; never a sub-Group
.... period 0..1 Period Period member belonged to the group
.... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required ICR Group Kind 📦0.1.0 This IG
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

This structure is derived from Group

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron