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 Campaign

Official URL: https://icr.healthcampaigns.org/StructureDefinition/ICRCampaign Version: 0.1.0
Draft as of 2026-10-29 Computable Name: ICRCampaign

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,

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
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: icr-campaign-activity-targets
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaignRound S 0..1 positiveInt Campaign Round
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-round
.... extension:targetGeography S 0..* Reference(ICR Location) The Location this campaign targets — searchable as CarePlan?target-geography= (SearchParameter icr-campaign-target-geography): what is planned where, chainable through partof and reverse-includable from a Location subtree (campaign-visibility)
URL: https://icr.healthcampaigns.org/StructureDefinition/target-geography
.... extension:planningDenominator S 0..1 Reference(ICR Target Population) The campaign's target: the ICRTargetPopulation coverage divides by. For an integrated campaign each activity names its own in activity.detail; this one is then optional and applies to activities that name none
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
.... extension:socialMobilization S 0..1 (Complex) Demand generation: population-informed + channels used (v0.20.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/social-mobilization
.... extension:dataLineage S 0..1 code Real-time vs Reconciled
URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled
Binding: ICR Data Lineage (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... partOf Σ 0..* Reference(ICR Campaign) Umbrella campaign this round belongs to (multi-round pattern, working doc §6.3)
... status ?!SΣ 1..1 code Campaign lifecycle: draft → active → completed
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
... intent ?!SΣ 1..1 code plan (microplan) transitioning to order (execution)
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category SΣ 1..* CodeableConcept Type of plan
Binding: ICR Campaign Type (required)
... subject SΣ 1..1 Reference(ICR Target Population) Who the care plan is for
... period SΣ 1..1 Period Campaign / round dates
... careTeam S 0..* Reference(ICR Care Team) The campaign roster: the delivery team(s) and supervisor — same constraint as Task.owner, so 'who ran this campaign' is a real join
... addresses SΣ 0..* Reference(Condition) The disease/condition targeted
... activity SC 0..* BackboneElement The activities this campaign includes, each with its target (detail); optionally also a curated Task list (reference). For tasks the canonical link runs the other way — Task.basedOn points at this campaign — so the CarePlan is never rewritten as tasks are created
Constraints: cpl-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference C 0..1 Reference(ICR Campaign Task) Activity details defined in specific resource
.... detail SC 0..1 BackboneElement One activity of the campaign and its target: required on an integrated campaign (icr-campaign-activity-targets), optional otherwise
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:planningDenominator S 0..* Reference(ICR Target Population) This activity's target: the ICRTargetPopulation its coverage divides by. Repeats when the target is the sum of several estimates; two activities may name the same estimate
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... instantiatesCanonical S 1..1 canonical(ICR Campaign Activity) The activity, as in the protocol's action.definitionCanonical; the tasks that carry it out have the same Task.instantiatesCanonical, and a coverage report names it in campaign-activity
..... status ?!S 1..1 code This activity's progress within the campaign: not-started → in-progress → completed, or cancelled when an intervention is dropped from the round
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] S 0..1 Period This activity's own dates, when they are narrower than the campaign period (e.g. a school-based intervention in one week of the round)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base required ICR Campaign Type 📦0.1.0 This IG
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-campaign-activity-targets warning CarePlan An integrated campaign (category integrated) lists its activities in activity.detail, each with its own planning denominator: one target for the whole campaign cannot serve interventions with different eligible populations. Warning severity: a draft may be stored before every target is known. category.coding.where(code = 'integrated').exists() implies (activity.detail.exists() and activity.detail.all(extension('https://icr.healthcampaigns.org/StructureDefinition/planning-denominator').exists()))

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: icr-campaign-activity-targets
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaignRound S 0..1 positiveInt Campaign Round
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-round
.... extension:targetGeography S 0..* Reference(ICR Location) The Location this campaign targets — searchable as CarePlan?target-geography= (SearchParameter icr-campaign-target-geography): what is planned where, chainable through partof and reverse-includable from a Location subtree (campaign-visibility)
URL: https://icr.healthcampaigns.org/StructureDefinition/target-geography
.... extension:planningDenominator S 0..1 Reference(ICR Target Population) The campaign's target: the ICRTargetPopulation coverage divides by. For an integrated campaign each activity names its own in activity.detail; this one is then optional and applies to activities that name none
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
.... extension:socialMobilization S 0..1 (Complex) Demand generation: population-informed + channels used (v0.20.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/social-mobilization
.... extension:dataLineage S 0..1 code Real-time vs Reconciled
URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled
Binding: ICR Data Lineage (required)
... instantiatesCanonical S 1..1 canonical(ICR Campaign Protocol) Instantiates FHIR protocol or definition
... partOf 0..* Reference(ICR Campaign) Umbrella campaign this round belongs to (multi-round pattern, working doc §6.3)
... intent S 1..1 code plan (microplan) transitioning to order (execution)
... category S 1..* CodeableConcept Type of plan
Binding: ICR Campaign Type (required)
... subject S 1..1 Reference(ICR Target Population) Who the care plan is for
... period S 1..1 Period Campaign / round dates
... careTeam S 0..* Reference(ICR Care Team) The campaign roster: the delivery team(s) and supervisor — same constraint as Task.owner, so 'who ran this campaign' is a real join
... addresses S 0..* Reference(Condition) The disease/condition targeted
... activity S 0..* BackboneElement The activities this campaign includes, each with its target (detail); optionally also a curated Task list (reference). For tasks the canonical link runs the other way — Task.basedOn points at this campaign — so the CarePlan is never rewritten as tasks are created
.... reference 0..1 Reference(ICR Campaign Task) Activity details defined in specific resource
.... detail S 0..1 BackboneElement One activity of the campaign and its target: required on an integrated campaign (icr-campaign-activity-targets), optional otherwise
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:planningDenominator S 0..* Reference(ICR Target Population) This activity's target: the ICRTargetPopulation its coverage divides by. Repeats when the target is the sum of several estimates; two activities may name the same estimate
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
..... instantiatesCanonical S 1..1 canonical(ICR Campaign Activity) The activity, as in the protocol's action.definitionCanonical; the tasks that carry it out have the same Task.instantiatesCanonical, and a coverage report names it in campaign-activity
..... status S 1..1 code This activity's progress within the campaign: not-started → in-progress → completed, or cancelled when an intervention is dropped from the round
..... scheduled[x] S 0..1 Period This activity's own dates, when they are narrower than the campaign period (e.g. a school-based intervention in one week of the round)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CarePlan.category Base required ICR Campaign Type 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
icr-campaign-activity-targets warning CarePlan An integrated campaign (category integrated) lists its activities in activity.detail, each with its own planning denominator: one target for the whole campaign cannot serve interventions with different eligible populations. Warning severity: a draft may be stored before every target is known. category.coding.where(code = 'integrated').exists() implies (activity.detail.exists() and activity.detail.all(extension('https://icr.healthcampaigns.org/StructureDefinition/planning-denominator').exists()))
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: icr-campaign-activity-targets
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaignRound S 0..1 positiveInt Campaign Round
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-round
.... extension:targetGeography S 0..* Reference(ICR Location) The Location this campaign targets — searchable as CarePlan?target-geography= (SearchParameter icr-campaign-target-geography): what is planned where, chainable through partof and reverse-includable from a Location subtree (campaign-visibility)
URL: https://icr.healthcampaigns.org/StructureDefinition/target-geography
.... extension:planningDenominator S 0..1 Reference(ICR Target Population) The campaign's target: the ICRTargetPopulation coverage divides by. For an integrated campaign each activity names its own in activity.detail; this one is then optional and applies to activities that name none
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
.... extension:socialMobilization S 0..1 (Complex) Demand generation: population-informed + channels used (v0.20.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/social-mobilization
.... extension:dataLineage S 0..1 code Real-time vs Reconciled
URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled
Binding: ICR Data Lineage (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this plan
... instantiatesCanonical SΣ 1..1 canonical(ICR Campaign Protocol) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan) Fulfills CarePlan
... replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(ICR Campaign) Umbrella campaign this round belongs to (multi-round pattern, working doc §6.3)
... status ?!SΣ 1..1 code Campaign lifecycle: draft → active → completed
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
... intent ?!SΣ 1..1 code plan (microplan) transitioning to order (execution)
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category SΣ 1..* CodeableConcept Type of plan
Binding: ICR Campaign Type (required)
... title Σ 0..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(ICR Target Population) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... period SΣ 1..1 Period Campaign / round dates
... created Σ 0..1 dateTime Date record was first recorded
... author Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
... contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
... careTeam S 0..* Reference(ICR Care Team) The campaign roster: the delivery team(s) and supervisor — same constraint as Task.owner, so 'who ran this campaign' is a real join
... addresses SΣ 0..* Reference(Condition) The disease/condition targeted
... supportingInfo 0..* Reference(Resource) Information considered as part of plan
... goal 0..* Reference(Goal) Desired outcome of plan
... activity SC 0..* BackboneElement The activities this campaign includes, each with its target (detail); optionally also a curated Task list (reference). For tasks the canonical link runs the other way — Task.basedOn points at this campaign — so the CarePlan is never rewritten as tasks are created
Constraints: cpl-3
.... 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
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
.... outcomeReference 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
.... progress 0..* Annotation Comments about the activity status/progress
.... reference C 0..1 Reference(ICR Campaign Task) Activity details defined in specific resource
.... detail SC 0..1 BackboneElement One activity of the campaign and its target: required on an integrated campaign (icr-campaign-activity-targets), optional otherwise
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:planningDenominator S 0..* Reference(ICR Target Population) This activity's target: the ICRTargetPopulation its coverage divides by. Repeats when the target is the sum of several estimates; two activities may name the same estimate
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
..... instantiatesCanonical S 1..1 canonical(ICR Campaign Activity) The activity, as in the protocol's action.definitionCanonical; the tasks that carry it out have the same Task.instantiatesCanonical, and a coverage report names it in campaign-activity
..... instantiatesUri 0..* uri Instantiates external protocol or definition
..... code 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
..... reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
..... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?!S 1..1 code This activity's progress within the campaign: not-started → in-progress → completed, or cancelled when an intervention is dropped from the round
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] S 0..1 Period This activity's own dates, when they are narrower than the campaign period (e.g. a school-based intervention in one week of the round)
..... location 0..1 Reference(Location) Where it should happen
..... performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
..... product[x] 0..1 What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
...... productCodeableConcept CodeableConcept
...... productReference Reference(Medication | Substance)
..... dailyAmount 0..1 SimpleQuantity(4.0.1) How to consume/day?
..... quantity 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
..... description 0..1 string Extra info describing activity to perform
... note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base required ICR Campaign Type 📦0.1.0 This IG
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-campaign-activity-targets warning CarePlan An integrated campaign (category integrated) lists its activities in activity.detail, each with its own planning denominator: one target for the whole campaign cannot serve interventions with different eligible populations. Warning severity: a draft may be stored before every target is known. category.coding.where(code = 'integrated').exists() implies (activity.detail.exists() and activity.detail.all(extension('https://icr.healthcampaigns.org/StructureDefinition/planning-denominator').exists()))

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: icr-campaign-activity-targets
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaignRound S 0..1 positiveInt Campaign Round
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-round
.... extension:targetGeography S 0..* Reference(ICR Location) The Location this campaign targets — searchable as CarePlan?target-geography= (SearchParameter icr-campaign-target-geography): what is planned where, chainable through partof and reverse-includable from a Location subtree (campaign-visibility)
URL: https://icr.healthcampaigns.org/StructureDefinition/target-geography
.... extension:planningDenominator S 0..1 Reference(ICR Target Population) The campaign's target: the ICRTargetPopulation coverage divides by. For an integrated campaign each activity names its own in activity.detail; this one is then optional and applies to activities that name none
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
.... extension:socialMobilization S 0..1 (Complex) Demand generation: population-informed + channels used (v0.20.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/social-mobilization
.... extension:dataLineage S 0..1 code Real-time vs Reconciled
URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled
Binding: ICR Data Lineage (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... partOf Σ 0..* Reference(ICR Campaign) Umbrella campaign this round belongs to (multi-round pattern, working doc §6.3)
... status ?!SΣ 1..1 code Campaign lifecycle: draft → active → completed
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
... intent ?!SΣ 1..1 code plan (microplan) transitioning to order (execution)
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category SΣ 1..* CodeableConcept Type of plan
Binding: ICR Campaign Type (required)
... subject SΣ 1..1 Reference(ICR Target Population) Who the care plan is for
... period SΣ 1..1 Period Campaign / round dates
... careTeam S 0..* Reference(ICR Care Team) The campaign roster: the delivery team(s) and supervisor — same constraint as Task.owner, so 'who ran this campaign' is a real join
... addresses SΣ 0..* Reference(Condition) The disease/condition targeted
... activity SC 0..* BackboneElement The activities this campaign includes, each with its target (detail); optionally also a curated Task list (reference). For tasks the canonical link runs the other way — Task.basedOn points at this campaign — so the CarePlan is never rewritten as tasks are created
Constraints: cpl-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference C 0..1 Reference(ICR Campaign Task) Activity details defined in specific resource
.... detail SC 0..1 BackboneElement One activity of the campaign and its target: required on an integrated campaign (icr-campaign-activity-targets), optional otherwise
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:planningDenominator S 0..* Reference(ICR Target Population) This activity's target: the ICRTargetPopulation its coverage divides by. Repeats when the target is the sum of several estimates; two activities may name the same estimate
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... instantiatesCanonical S 1..1 canonical(ICR Campaign Activity) The activity, as in the protocol's action.definitionCanonical; the tasks that carry it out have the same Task.instantiatesCanonical, and a coverage report names it in campaign-activity
..... status ?!S 1..1 code This activity's progress within the campaign: not-started → in-progress → completed, or cancelled when an intervention is dropped from the round
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] S 0..1 Period This activity's own dates, when they are narrower than the campaign period (e.g. a school-based intervention in one week of the round)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base required ICR Campaign Type 📦0.1.0 This IG
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-campaign-activity-targets warning CarePlan An integrated campaign (category integrated) lists its activities in activity.detail, each with its own planning denominator: one target for the whole campaign cannot serve interventions with different eligible populations. Warning severity: a draft may be stored before every target is known. category.coding.where(code = 'integrated').exists() implies (activity.detail.exists() and activity.detail.all(extension('https://icr.healthcampaigns.org/StructureDefinition/planning-denominator').exists()))

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: icr-campaign-activity-targets
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaignRound S 0..1 positiveInt Campaign Round
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-round
.... extension:targetGeography S 0..* Reference(ICR Location) The Location this campaign targets — searchable as CarePlan?target-geography= (SearchParameter icr-campaign-target-geography): what is planned where, chainable through partof and reverse-includable from a Location subtree (campaign-visibility)
URL: https://icr.healthcampaigns.org/StructureDefinition/target-geography
.... extension:planningDenominator S 0..1 Reference(ICR Target Population) The campaign's target: the ICRTargetPopulation coverage divides by. For an integrated campaign each activity names its own in activity.detail; this one is then optional and applies to activities that name none
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
.... extension:socialMobilization S 0..1 (Complex) Demand generation: population-informed + channels used (v0.20.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/social-mobilization
.... extension:dataLineage S 0..1 code Real-time vs Reconciled
URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled
Binding: ICR Data Lineage (required)
... instantiatesCanonical S 1..1 canonical(ICR Campaign Protocol) Instantiates FHIR protocol or definition
... partOf 0..* Reference(ICR Campaign) Umbrella campaign this round belongs to (multi-round pattern, working doc §6.3)
... intent S 1..1 code plan (microplan) transitioning to order (execution)
... category S 1..* CodeableConcept Type of plan
Binding: ICR Campaign Type (required)
... subject S 1..1 Reference(ICR Target Population) Who the care plan is for
... period S 1..1 Period Campaign / round dates
... careTeam S 0..* Reference(ICR Care Team) The campaign roster: the delivery team(s) and supervisor — same constraint as Task.owner, so 'who ran this campaign' is a real join
... addresses S 0..* Reference(Condition) The disease/condition targeted
... activity S 0..* BackboneElement The activities this campaign includes, each with its target (detail); optionally also a curated Task list (reference). For tasks the canonical link runs the other way — Task.basedOn points at this campaign — so the CarePlan is never rewritten as tasks are created
.... reference 0..1 Reference(ICR Campaign Task) Activity details defined in specific resource
.... detail S 0..1 BackboneElement One activity of the campaign and its target: required on an integrated campaign (icr-campaign-activity-targets), optional otherwise
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:planningDenominator S 0..* Reference(ICR Target Population) This activity's target: the ICRTargetPopulation its coverage divides by. Repeats when the target is the sum of several estimates; two activities may name the same estimate
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
..... instantiatesCanonical S 1..1 canonical(ICR Campaign Activity) The activity, as in the protocol's action.definitionCanonical; the tasks that carry it out have the same Task.instantiatesCanonical, and a coverage report names it in campaign-activity
..... status S 1..1 code This activity's progress within the campaign: not-started → in-progress → completed, or cancelled when an intervention is dropped from the round
..... scheduled[x] S 0..1 Period This activity's own dates, when they are narrower than the campaign period (e.g. a school-based intervention in one week of the round)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CarePlan.category Base required ICR Campaign Type 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
icr-campaign-activity-targets warning CarePlan An integrated campaign (category integrated) lists its activities in activity.detail, each with its own planning denominator: one target for the whole campaign cannot serve interventions with different eligible populations. Warning severity: a draft may be stored before every target is known. category.coding.where(code = 'integrated').exists() implies (activity.detail.exists() and activity.detail.all(extension('https://icr.healthcampaigns.org/StructureDefinition/planning-denominator').exists()))

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: icr-campaign-activity-targets
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaignRound S 0..1 positiveInt Campaign Round
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-round
.... extension:targetGeography S 0..* Reference(ICR Location) The Location this campaign targets — searchable as CarePlan?target-geography= (SearchParameter icr-campaign-target-geography): what is planned where, chainable through partof and reverse-includable from a Location subtree (campaign-visibility)
URL: https://icr.healthcampaigns.org/StructureDefinition/target-geography
.... extension:planningDenominator S 0..1 Reference(ICR Target Population) The campaign's target: the ICRTargetPopulation coverage divides by. For an integrated campaign each activity names its own in activity.detail; this one is then optional and applies to activities that name none
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
.... extension:socialMobilization S 0..1 (Complex) Demand generation: population-informed + channels used (v0.20.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/social-mobilization
.... extension:dataLineage S 0..1 code Real-time vs Reconciled
URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled
Binding: ICR Data Lineage (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this plan
... instantiatesCanonical SΣ 1..1 canonical(ICR Campaign Protocol) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan) Fulfills CarePlan
... replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(ICR Campaign) Umbrella campaign this round belongs to (multi-round pattern, working doc §6.3)
... status ?!SΣ 1..1 code Campaign lifecycle: draft → active → completed
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
... intent ?!SΣ 1..1 code plan (microplan) transitioning to order (execution)
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category SΣ 1..* CodeableConcept Type of plan
Binding: ICR Campaign Type (required)
... title Σ 0..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(ICR Target Population) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... period SΣ 1..1 Period Campaign / round dates
... created Σ 0..1 dateTime Date record was first recorded
... author Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
... contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
... careTeam S 0..* Reference(ICR Care Team) The campaign roster: the delivery team(s) and supervisor — same constraint as Task.owner, so 'who ran this campaign' is a real join
... addresses SΣ 0..* Reference(Condition) The disease/condition targeted
... supportingInfo 0..* Reference(Resource) Information considered as part of plan
... goal 0..* Reference(Goal) Desired outcome of plan
... activity SC 0..* BackboneElement The activities this campaign includes, each with its target (detail); optionally also a curated Task list (reference). For tasks the canonical link runs the other way — Task.basedOn points at this campaign — so the CarePlan is never rewritten as tasks are created
Constraints: cpl-3
.... 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
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
.... outcomeReference 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
.... progress 0..* Annotation Comments about the activity status/progress
.... reference C 0..1 Reference(ICR Campaign Task) Activity details defined in specific resource
.... detail SC 0..1 BackboneElement One activity of the campaign and its target: required on an integrated campaign (icr-campaign-activity-targets), optional otherwise
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:planningDenominator S 0..* Reference(ICR Target Population) This activity's target: the ICRTargetPopulation its coverage divides by. Repeats when the target is the sum of several estimates; two activities may name the same estimate
URL: https://icr.healthcampaigns.org/StructureDefinition/planning-denominator
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
..... instantiatesCanonical S 1..1 canonical(ICR Campaign Activity) The activity, as in the protocol's action.definitionCanonical; the tasks that carry it out have the same Task.instantiatesCanonical, and a coverage report names it in campaign-activity
..... instantiatesUri 0..* uri Instantiates external protocol or definition
..... code 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
..... reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
..... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?!S 1..1 code This activity's progress within the campaign: not-started → in-progress → completed, or cancelled when an intervention is dropped from the round
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] S 0..1 Period This activity's own dates, when they are narrower than the campaign period (e.g. a school-based intervention in one week of the round)
..... location 0..1 Reference(Location) Where it should happen
..... performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
..... product[x] 0..1 What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
...... productCodeableConcept CodeableConcept
...... productReference Reference(Medication | Substance)
..... dailyAmount 0..1 SimpleQuantity(4.0.1) How to consume/day?
..... quantity 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
..... description 0..1 string Extra info describing activity to perform
... note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base required ICR Campaign Type 📦0.1.0 This IG
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-campaign-activity-targets warning CarePlan An integrated campaign (category integrated) lists its activities in activity.detail, each with its own planning denominator: one target for the whole campaign cannot serve interventions with different eligible populations. Warning severity: a draft may be stored before every target is known. category.coding.where(code = 'integrated').exists() implies (activity.detail.exists() and activity.detail.all(extension('https://icr.healthcampaigns.org/StructureDefinition/planning-denominator').exists()))

 

Other representations of profile: CSV, Excel, Schematron