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
| Official URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-activity | Version: 0.1.0 | |||
| Draft as of 2026-10-29 | Computable Name: CampaignActivity | |||
The activity of an integrated campaign that this record belongs to: the ICRCampaignActivity a CarePlan.activity.detail of the campaign instantiates. On a coverage report, the report's denominator is then that activity's planning denominator and its numerator counts only that activity's doses or treatments; absent on a report for a single-intervention campaign, or for a campaign as a whole. On a delivery event (Immunization, MedicationAdministration, SupplyDelivery), the activity the dose, treatment or handover was for: per-activity results count events by this link, not by product code. An event must carry it whenever its visit Task has no instantiatesCanonical and its campaign lists more than one activity (a conformance rule stated in the IG text, since an event cannot see its Task). On a Task output, the activity a per-activity tally (treated-count) is for, on a visit that delivers several activities.
Context of Use
This extension may be used on the following element(s)
MeasureReport
Immunization
MedicationAdministration
SupplyDelivery
Task.output
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Campaign Activity | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/campaign-activity" | |
  value[x] |
0..1 | canonical(ICR Campaign Activity) | Value of extension | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Campaign Activity | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/campaign-activity" | |
| value[x] |
0..1 | canonical(ICR Campaign Activity) | Value of extension | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type canonical: The activity of an integrated campaign that this record belongs to: the ICRCampaignActivity a CarePlan.activity.detail of the campaign instantiates. On a coverage report, the report's denominator is then that activity's planning denominator and its numerator counts only that activity's doses or treatments; absent on a report for a single-intervention campaign, or for a campaign as a whole. On a delivery event (Immunization, MedicationAdministration, SupplyDelivery), the activity the dose, treatment or handover was for: per-activity results count events by this link, not by product code. An event must carry it whenever its visit Task has no instantiatesCanonical and its campaign lists more than one activity (a conformance rule stated in the IG text, since an event cannot see its Task). On a Task output, the activity a per-activity tally (treated-count) is for, on a visit that delivers several activities.
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Campaign Activity | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/campaign-activity" | |
| value[x] |
0..1 | canonical(ICR Campaign Activity) | Value of extension | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Campaign Activity | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/campaign-activity" | |
| value[x] |
0..1 | canonical(ICR Campaign Activity) | Value of extension | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type canonical: The activity of an integrated campaign that this record belongs to: the ICRCampaignActivity a CarePlan.activity.detail of the campaign instantiates. On a coverage report, the report's denominator is then that activity's planning denominator and its numerator counts only that activity's doses or treatments; absent on a report for a single-intervention campaign, or for a campaign as a whole. On a delivery event (Immunization, MedicationAdministration, SupplyDelivery), the activity the dose, treatment or handover was for: per-activity results count events by this link, not by product code. An event must carry it whenever its visit Task has no instantiatesCanonical and its campaign lists more than one activity (a conformance rule stated in the IG text, since an event cannot see its Task). On a Task output, the activity a per-activity tally (treated-count) is for, on a visit that delivers several activities.
Other representations of profile: CSV, Excel, Schematron
| Id | Grade | Path(s) | Description | Expression |