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/ICRAdministrativeCoverage | Version: 0.1.0 | |||
| Draft as of 2026-08-19 | Computable Name: ICRAdministrativeCoverage | |||
Administrative coverage: doses/treatments delivered ÷ planning denominator, computed from tallies. Carries denominator provenance and is permanently marked source=administrative.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | MeasureReport | Results of a measure evaluation Constraints: mrp-1, mrp-2 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Campaign) | The campaign (round) this coverage figure reports against — the direct MeasureReport→ICRCampaign join (same extension as the delivery events). Expected on every campaign coverage report; only transiently absent on form-extracted reports before ingestion enrichment assigns the round URL: https://icr.healthcampaigns.org/StructureDefinition/campaign |
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Care Team) | Reporter Team URL: https://icr.healthcampaigns.org/StructureDefinition/reporter-team |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Coverage Source URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/coverage-source" | |
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: ICR Coverage Source (required) Required Pattern: administrative | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Denominator Source URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source Binding: ICR Denominator Source (extensible) |
![]() ![]() ![]() |
S | 0..1 | code | total-population vs at-risk/eligible (programme vs epidemiological coverage) URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-type Binding: ICR Denominator Type (required) |
![]() ![]() ![]() |
S | 0..1 | code | people vs implementation-units (geographic coverage); absent ⇒ people URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-unit Binding: ICR Coverage Unit (required) |
![]() ![]() ![]() |
S | 1..1 | code | Required on coverage reports: preliminary in-campaign figures (realtime) vs final close-out figures (reconciled) must be distinguishable URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled Binding: ICR Data Lineage (required) |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | complete | pending | error Binding: MeasureReportStatus (required): The status of the measure report. |
![]() ![]() |
SΣC | 1..1 | code | individual | subject-list | summary | data-collection Binding: MeasureReportType (required): The type of the measure report. |
![]() ![]() |
SΣ | 1..1 | canonical(Measure) | The canonical ICR coverage Measure this report instances — declares the populations and standard stratifiers (§8, v0.19.0) |
![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Location | Organization) | Required (v0.20.0, §15 #7-bis): who reported this figure — the accountable supervisor (Practitioner/PractitionerRole) or their organization (the R4 reporter targets; CareTeam is not one — the team join rides extension[reporterTeam]) |
![]() ![]() |
SΣ | 1..1 | Period | What period the report covers |
![]() ![]() |
?!Σ | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. |
![]() ![]() |
SC | 0..* | BackboneElement | Measure results for each group |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — extensible binding to ICRCoverageStratifierVS, so custom country axes stay legal (v0.19.0) |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What stratifier of the group Binding: ICR Coverage Stratifier (extensible) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MeasureReport.extension:coverageSource.value[x] | Base | required | ICR Coverage Source | 📦0.1.0 | This IG |
| MeasureReport.status | Base | required | MeasureReportStatus | 📍4.0.1 | FHIR Std. |
| MeasureReport.type | Base | required | MeasureReportType | 📍4.0.1 | FHIR Std. |
| MeasureReport.improvementNotation | Base | required | MeasureImprovementNotation | 📍4.0.1 | FHIR Std. |
| MeasureReport.group.stratifier.code | Base | extensible | ICR Coverage Stratifier | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from MeasureReport
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MeasureReport | Results of a measure evaluation | |
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Campaign) | The campaign (round) this coverage figure reports against — the direct MeasureReport→ICRCampaign join (same extension as the delivery events). Expected on every campaign coverage report; only transiently absent on form-extracted reports before ingestion enrichment assigns the round URL: https://icr.healthcampaigns.org/StructureDefinition/campaign |
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Care Team) | Reporter Team URL: https://icr.healthcampaigns.org/StructureDefinition/reporter-team |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Coverage Source URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source |
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Required Pattern: administrative | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Denominator Source URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source Binding: ICR Denominator Source (extensible) |
![]() ![]() ![]() |
S | 0..1 | code | total-population vs at-risk/eligible (programme vs epidemiological coverage) URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-type Binding: ICR Denominator Type (required) |
![]() ![]() ![]() |
S | 0..1 | code | people vs implementation-units (geographic coverage); absent ⇒ people URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-unit Binding: ICR Coverage Unit (required) |
![]() ![]() ![]() |
S | 1..1 | code | Required on coverage reports: preliminary in-campaign figures (realtime) vs final close-out figures (reconciled) must be distinguishable URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled Binding: ICR Data Lineage (required) |
![]() ![]() |
S | 1..1 | code | complete | pending | error |
![]() ![]() |
S | 1..1 | code | individual | subject-list | summary | data-collection |
![]() ![]() |
S | 1..1 | canonical(Measure) | The canonical ICR coverage Measure this report instances — declares the populations and standard stratifiers (§8, v0.19.0) |
![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Location | Organization) | Required (v0.20.0, §15 #7-bis): who reported this figure — the accountable supervisor (Practitioner/PractitionerRole) or their organization (the R4 reporter targets; CareTeam is not one — the team join rides extension[reporterTeam]) |
![]() ![]() |
S | 1..1 | Period | What period the report covers |
![]() ![]() |
S | 0..* | BackboneElement | Measure results for each group |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — extensible binding to ICRCoverageStratifierVS, so custom country axes stay legal (v0.19.0) |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What stratifier of the group Binding: ICR Coverage Stratifier (extensible) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MeasureReport.group.stratifier.code | Base | extensible | ICR Coverage Stratifier | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | MeasureReport | Results of a measure evaluation Constraints: mrp-1, mrp-2 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Campaign) | The campaign (round) this coverage figure reports against — the direct MeasureReport→ICRCampaign join (same extension as the delivery events). Expected on every campaign coverage report; only transiently absent on form-extracted reports before ingestion enrichment assigns the round URL: https://icr.healthcampaigns.org/StructureDefinition/campaign | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Care Team) | Reporter Team URL: https://icr.healthcampaigns.org/StructureDefinition/reporter-team | ||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | Coverage Source URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/coverage-source" | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: ICR Coverage Source (required) Required Pattern: administrative | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Denominator Source URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source Binding: ICR Denominator Source (extensible) | ||||
![]() ![]() ![]() |
S | 0..1 | code | total-population vs at-risk/eligible (programme vs epidemiological coverage) URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-type Binding: ICR Denominator Type (required) | ||||
![]() ![]() ![]() |
S | 0..1 | code | people vs implementation-units (geographic coverage); absent ⇒ people URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-unit Binding: ICR Coverage Unit (required) | ||||
![]() ![]() ![]() |
S | 1..1 | code | Required on coverage reports: preliminary in-campaign figures (realtime) vs final close-out figures (reconciled) must be distinguishable URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled Binding: ICR Data Lineage (required) | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the MeasureReport | ||||
![]() ![]() |
?!SΣ | 1..1 | code | complete | pending | error Binding: MeasureReportStatus (required): The status of the measure report. | ||||
![]() ![]() |
SΣC | 1..1 | code | individual | subject-list | summary | data-collection Binding: MeasureReportType (required): The type of the measure report. | ||||
![]() ![]() |
SΣ | 1..1 | canonical(Measure) | The canonical ICR coverage Measure this report instances — declares the populations and standard stratifiers (§8, v0.19.0) | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Location | Device | RelatedPerson | Group) | What individual(s) the report is for | ||||
![]() ![]() |
Σ | 0..1 | dateTime | When the report was generated | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Location | Organization) | Required (v0.20.0, §15 #7-bis): who reported this figure — the accountable supervisor (Practitioner/PractitionerRole) or their organization (the R4 reporter targets; CareTeam is not one — the team join rides extension[reporterTeam]) | ||||
![]() ![]() |
SΣ | 1..1 | Period | What period the report covers | ||||
![]() ![]() |
?!Σ | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. | ||||
![]() ![]() |
SC | 0..* | BackboneElement | Measure results for each group | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Meaning of the group | ||||
![]() ![]() ![]() |
0..* | BackboneElement | The populations in the group | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible): The type of population (e.g. initial, numerator, denominator, etc.). | ||||
![]() ![]() ![]() ![]() |
0..1 | integer | Size of the population | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(List) | For subject-list reports, the subject results in this population | |||||
![]() ![]() ![]() |
Σ | 0..1 | Quantity | What score this group achieved | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — extensible binding to ICRCoverageStratifierVS, so custom country axes stay legal (v0.19.0) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What stratifier of the group Binding: ICR Coverage Stratifier (extensible) | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The stratum value, e.g. male | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Stratifier component values | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | What stratifier component of the group | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The stratum component value, e.g. male | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Population results in this stratum | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible): The type of population (e.g. initial, numerator, denominator, etc.). | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | integer | Size of the population | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(List) | For subject-list reports, the subject results in this population | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Quantity | What score this stratum achieved | |||||
![]() ![]() |
0..* | Reference(Resource) | What data was used to calculate the measure score | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MeasureReport.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MeasureReport.extension:coverageSource.value[x] | Base | required | ICR Coverage Source | 📦0.1.0 | This IG |
| MeasureReport.status | Base | required | MeasureReportStatus | 📍4.0.1 | FHIR Std. |
| MeasureReport.type | Base | required | MeasureReportType | 📍4.0.1 | FHIR Std. |
| MeasureReport.improvementNotation | Base | required | MeasureImprovementNotation | 📍4.0.1 | FHIR Std. |
| MeasureReport.group.population.code | Base | extensible | MeasurePopulationType | 📍4.0.1 | FHIR Std. |
| MeasureReport.group.stratifier.code | Base | extensible | ICR Coverage Stratifier | 📦0.1.0 | This IG |
| MeasureReport.group.stratifier.stratum.population.code | Base | extensible | MeasurePopulationType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from MeasureReport
Summary
Mandatory: 3 elements
Must-Support: 14 elements
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | MeasureReport | Results of a measure evaluation Constraints: mrp-1, mrp-2 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Campaign) | The campaign (round) this coverage figure reports against — the direct MeasureReport→ICRCampaign join (same extension as the delivery events). Expected on every campaign coverage report; only transiently absent on form-extracted reports before ingestion enrichment assigns the round URL: https://icr.healthcampaigns.org/StructureDefinition/campaign |
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Care Team) | Reporter Team URL: https://icr.healthcampaigns.org/StructureDefinition/reporter-team |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Coverage Source URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/coverage-source" | |
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: ICR Coverage Source (required) Required Pattern: administrative | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Denominator Source URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source Binding: ICR Denominator Source (extensible) |
![]() ![]() ![]() |
S | 0..1 | code | total-population vs at-risk/eligible (programme vs epidemiological coverage) URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-type Binding: ICR Denominator Type (required) |
![]() ![]() ![]() |
S | 0..1 | code | people vs implementation-units (geographic coverage); absent ⇒ people URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-unit Binding: ICR Coverage Unit (required) |
![]() ![]() ![]() |
S | 1..1 | code | Required on coverage reports: preliminary in-campaign figures (realtime) vs final close-out figures (reconciled) must be distinguishable URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled Binding: ICR Data Lineage (required) |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | complete | pending | error Binding: MeasureReportStatus (required): The status of the measure report. |
![]() ![]() |
SΣC | 1..1 | code | individual | subject-list | summary | data-collection Binding: MeasureReportType (required): The type of the measure report. |
![]() ![]() |
SΣ | 1..1 | canonical(Measure) | The canonical ICR coverage Measure this report instances — declares the populations and standard stratifiers (§8, v0.19.0) |
![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Location | Organization) | Required (v0.20.0, §15 #7-bis): who reported this figure — the accountable supervisor (Practitioner/PractitionerRole) or their organization (the R4 reporter targets; CareTeam is not one — the team join rides extension[reporterTeam]) |
![]() ![]() |
SΣ | 1..1 | Period | What period the report covers |
![]() ![]() |
?!Σ | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. |
![]() ![]() |
SC | 0..* | BackboneElement | Measure results for each group |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — extensible binding to ICRCoverageStratifierVS, so custom country axes stay legal (v0.19.0) |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What stratifier of the group Binding: ICR Coverage Stratifier (extensible) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MeasureReport.extension:coverageSource.value[x] | Base | required | ICR Coverage Source | 📦0.1.0 | This IG |
| MeasureReport.status | Base | required | MeasureReportStatus | 📍4.0.1 | FHIR Std. |
| MeasureReport.type | Base | required | MeasureReportType | 📍4.0.1 | FHIR Std. |
| MeasureReport.improvementNotation | Base | required | MeasureImprovementNotation | 📍4.0.1 | FHIR Std. |
| MeasureReport.group.stratifier.code | Base | extensible | ICR Coverage Stratifier | 📦0.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from MeasureReport
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MeasureReport | Results of a measure evaluation | |
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Campaign) | The campaign (round) this coverage figure reports against — the direct MeasureReport→ICRCampaign join (same extension as the delivery events). Expected on every campaign coverage report; only transiently absent on form-extracted reports before ingestion enrichment assigns the round URL: https://icr.healthcampaigns.org/StructureDefinition/campaign |
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Care Team) | Reporter Team URL: https://icr.healthcampaigns.org/StructureDefinition/reporter-team |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Coverage Source URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source |
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Required Pattern: administrative | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Denominator Source URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source Binding: ICR Denominator Source (extensible) |
![]() ![]() ![]() |
S | 0..1 | code | total-population vs at-risk/eligible (programme vs epidemiological coverage) URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-type Binding: ICR Denominator Type (required) |
![]() ![]() ![]() |
S | 0..1 | code | people vs implementation-units (geographic coverage); absent ⇒ people URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-unit Binding: ICR Coverage Unit (required) |
![]() ![]() ![]() |
S | 1..1 | code | Required on coverage reports: preliminary in-campaign figures (realtime) vs final close-out figures (reconciled) must be distinguishable URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled Binding: ICR Data Lineage (required) |
![]() ![]() |
S | 1..1 | code | complete | pending | error |
![]() ![]() |
S | 1..1 | code | individual | subject-list | summary | data-collection |
![]() ![]() |
S | 1..1 | canonical(Measure) | The canonical ICR coverage Measure this report instances — declares the populations and standard stratifiers (§8, v0.19.0) |
![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Location | Organization) | Required (v0.20.0, §15 #7-bis): who reported this figure — the accountable supervisor (Practitioner/PractitionerRole) or their organization (the R4 reporter targets; CareTeam is not one — the team join rides extension[reporterTeam]) |
![]() ![]() |
S | 1..1 | Period | What period the report covers |
![]() ![]() |
S | 0..* | BackboneElement | Measure results for each group |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — extensible binding to ICRCoverageStratifierVS, so custom country axes stay legal (v0.19.0) |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What stratifier of the group Binding: ICR Coverage Stratifier (extensible) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MeasureReport.group.stratifier.code | Base | extensible | ICR Coverage Stratifier | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | MeasureReport | Results of a measure evaluation Constraints: mrp-1, mrp-2 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Campaign) | The campaign (round) this coverage figure reports against — the direct MeasureReport→ICRCampaign join (same extension as the delivery events). Expected on every campaign coverage report; only transiently absent on form-extracted reports before ingestion enrichment assigns the round URL: https://icr.healthcampaigns.org/StructureDefinition/campaign | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(ICR Care Team) | Reporter Team URL: https://icr.healthcampaigns.org/StructureDefinition/reporter-team | ||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | Coverage Source URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://icr.healthcampaigns.org/StructureDefinition/coverage-source" | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: ICR Coverage Source (required) Required Pattern: administrative | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Denominator Source URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source Binding: ICR Denominator Source (extensible) | ||||
![]() ![]() ![]() |
S | 0..1 | code | total-population vs at-risk/eligible (programme vs epidemiological coverage) URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-type Binding: ICR Denominator Type (required) | ||||
![]() ![]() ![]() |
S | 0..1 | code | people vs implementation-units (geographic coverage); absent ⇒ people URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-unit Binding: ICR Coverage Unit (required) | ||||
![]() ![]() ![]() |
S | 1..1 | code | Required on coverage reports: preliminary in-campaign figures (realtime) vs final close-out figures (reconciled) must be distinguishable URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled Binding: ICR Data Lineage (required) | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the MeasureReport | ||||
![]() ![]() |
?!SΣ | 1..1 | code | complete | pending | error Binding: MeasureReportStatus (required): The status of the measure report. | ||||
![]() ![]() |
SΣC | 1..1 | code | individual | subject-list | summary | data-collection Binding: MeasureReportType (required): The type of the measure report. | ||||
![]() ![]() |
SΣ | 1..1 | canonical(Measure) | The canonical ICR coverage Measure this report instances — declares the populations and standard stratifiers (§8, v0.19.0) | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Location | Device | RelatedPerson | Group) | What individual(s) the report is for | ||||
![]() ![]() |
Σ | 0..1 | dateTime | When the report was generated | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Location | Organization) | Required (v0.20.0, §15 #7-bis): who reported this figure — the accountable supervisor (Practitioner/PractitionerRole) or their organization (the R4 reporter targets; CareTeam is not one — the team join rides extension[reporterTeam]) | ||||
![]() ![]() |
SΣ | 1..1 | Period | What period the report covers | ||||
![]() ![]() |
?!Σ | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. | ||||
![]() ![]() |
SC | 0..* | BackboneElement | Measure results for each group | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Meaning of the group | ||||
![]() ![]() ![]() |
0..* | BackboneElement | The populations in the group | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible): The type of population (e.g. initial, numerator, denominator, etc.). | ||||
![]() ![]() ![]() ![]() |
0..1 | integer | Size of the population | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(List) | For subject-list reports, the subject results in this population | |||||
![]() ![]() ![]() |
Σ | 0..1 | Quantity | What score this group achieved | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — extensible binding to ICRCoverageStratifierVS, so custom country axes stay legal (v0.19.0) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What stratifier of the group Binding: ICR Coverage Stratifier (extensible) | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The stratum value, e.g. male | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Stratifier component values | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | What stratifier component of the group | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The stratum component value, e.g. male | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Population results in this stratum | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible): The type of population (e.g. initial, numerator, denominator, etc.). | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | integer | Size of the population | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(List) | For subject-list reports, the subject results in this population | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Quantity | What score this stratum achieved | |||||
![]() ![]() |
0..* | Reference(Resource) | What data was used to calculate the measure score | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MeasureReport.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MeasureReport.extension:coverageSource.value[x] | Base | required | ICR Coverage Source | 📦0.1.0 | This IG |
| MeasureReport.status | Base | required | MeasureReportStatus | 📍4.0.1 | FHIR Std. |
| MeasureReport.type | Base | required | MeasureReportType | 📍4.0.1 | FHIR Std. |
| MeasureReport.improvementNotation | Base | required | MeasureImprovementNotation | 📍4.0.1 | FHIR Std. |
| MeasureReport.group.population.code | Base | extensible | MeasurePopulationType | 📍4.0.1 | FHIR Std. |
| MeasureReport.group.stratifier.code | Base | extensible | ICR Coverage Stratifier | 📦0.1.0 | This IG |
| MeasureReport.group.stratifier.stratum.population.code | Base | extensible | MeasurePopulationType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from MeasureReport
Summary
Mandatory: 3 elements
Must-Support: 14 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron