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 | Version: 0.1.0 | |||
| Draft as of 2026-08-20 | Computable Name: 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).
Context of Use
This extension may be used on the following element(s)
Immunization
MedicationAdministration
SupplyDelivery
MeasureReport
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 | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/campaign" | |
  value[x] |
0..1 | Reference(ICR Campaign) | Value of extension | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Campaign | |
 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" | |
| value[x] |
0..1 | Reference(ICR Campaign) | Value of extension | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type Reference: 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).
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Campaign | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/campaign" | |
| value[x] |
0..1 | Reference(ICR Campaign) | Value of extension | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Campaign | |
| 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" | |
| value[x] |
0..1 | Reference(ICR Campaign) | Value of extension | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type Reference: 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).
Other representations of profile: CSV, Excel, Schematron
| Id | Grade | Path(s) | Description | Expression |