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 Administrative Coverage

Official URL: https://icr.healthcampaigns.org/StructureDefinition/ICRAdministrativeCoverage Version: 0.1.0
Draft as of 2026-08-07 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

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MeasureReport C 0..* MeasureReport Results of a measure evaluation
Constraints: mrp-1, mrp-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:coverageSource S 1..1 (Complex) Coverage Source
URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://icr.healthcampaigns.org/StructureDefinition/coverage-source"
..... value[x] 0..1 code Value of extension
Binding: ICR Coverage Source (required)
Required Pattern: administrative
.... extension:denominatorSource S 0..1 CodeableConcept Denominator Source
URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source
Binding: ICR Denominator Source (extensible)
.... extension:denominatorType 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)
.... extension:coverageUnit 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)
.... extension:dataLineage 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)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type SΣC 1..1 code individual | subject-list | summary | data-collection
Binding: MeasureReportType (required): The type of the measure report.
... measure SΣ 1..1 canonical(Measure) The canonical ICR coverage Measure this report instances — declares the populations and standard stratifiers (§8, v0.19.0)
... reporter SΣ 1..1 Reference(Practitioner | PractitionerRole | Location | Organization) Required (v0.20.0, §15 #7-bis): who reported this figure — typically the supervisor's ICRCareTeam / their organization
... period SΣ 1..1 Period What period the report covers
... improvementNotation ?!Σ 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.
... group SC 0..* BackboneElement Measure results for each group
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... stratifier 0..* BackboneElement Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — ICRCoverageStratifierVS (v0.19.0)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MeasureReport If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MeasureReport 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 MeasureReport 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 MeasureReport If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MeasureReport 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()
mrp-1 error MeasureReport Measure Reports used for data collection SHALL NOT communicate group and score information (type != 'data-collection') or group.exists().not()
mrp-2 error MeasureReport Stratifiers SHALL be either a single criteria or a set of criteria components group.stratifier.stratum.all(value.exists() xor component.exists())

This structure is derived from MeasureReport

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MeasureReport 0..* MeasureReport Results of a measure evaluation
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:coverageSource S 1..1 (Complex) Coverage Source
URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source
..... value[x] 0..1 code Value of extension
Required Pattern: administrative
.... extension:denominatorSource S 0..1 CodeableConcept Denominator Source
URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source
Binding: ICR Denominator Source (extensible)
.... extension:denominatorType 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)
.... extension:coverageUnit 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)
.... extension:dataLineage 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)
... status S 1..1 code complete | pending | error
... type S 1..1 code individual | subject-list | summary | data-collection
... reporter S 1..1 Reference(Practitioner | PractitionerRole | Location | Organization) Required (v0.20.0, §15 #7-bis): who reported this figure — typically the supervisor's ICRCareTeam / their organization
... period S 1..1 Period What period the report covers
... group S 0..* BackboneElement Measure results for each group
.... stratifier 0..* BackboneElement Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — ICRCoverageStratifierVS (v0.19.0)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MeasureReport C 0..* MeasureReport Results of a measure evaluation
Constraints: mrp-1, mrp-2
... 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 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:coverageSource S 1..1 (Complex) Coverage Source
URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source
..... 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/coverage-source"
..... value[x] 0..1 code Value of extension
Binding: ICR Coverage Source (required)
Required Pattern: administrative
.... extension:denominatorSource S 0..1 CodeableConcept Denominator Source
URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source
Binding: ICR Denominator Source (extensible)
.... extension:denominatorType 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)
.... extension:coverageUnit 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)
.... extension:dataLineage 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)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Additional identifier for the MeasureReport
... status ?!SΣ 1..1 code complete | pending | error
Binding: MeasureReportStatus (required): The status of the measure report.
... type SΣC 1..1 code individual | subject-list | summary | data-collection
Binding: MeasureReportType (required): The type of the measure report.
... measure SΣ 1..1 canonical(Measure) The canonical ICR coverage Measure this report instances — declares the populations and standard stratifiers (§8, v0.19.0)
... subject Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | Location | Device | RelatedPerson | Group) What individual(s) the report is for
... date Σ 0..1 dateTime When the report was generated
... reporter SΣ 1..1 Reference(Practitioner | PractitionerRole | Location | Organization) Required (v0.20.0, §15 #7-bis): who reported this figure — typically the supervisor's ICRCareTeam / their organization
... period SΣ 1..1 Period What period the report covers
... improvementNotation ?!Σ 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.
... group SC 0..* BackboneElement Measure results for each 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
.... code Σ 0..1 CodeableConcept Meaning of the group
.... population 0..* BackboneElement The populations in the 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
..... code Σ 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.).
..... count 0..1 integer Size of the population
..... subjectResults 0..1 Reference(List) For subject-list reports, the subject results in this population
.... measureScore Σ 0..1 Quantity What score this group achieved
.... stratifier 0..* BackboneElement Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — ICRCoverageStratifierVS (v0.19.0)
..... 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 0..* CodeableConcept What stratifier of the group
..... stratum 0..* BackboneElement Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components
...... 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
...... value 0..1 CodeableConcept The stratum value, e.g. male
...... component 0..* BackboneElement Stratifier component values
....... 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 What stratifier component of the group
....... value 1..1 CodeableConcept The stratum component value, e.g. male
...... population 0..* BackboneElement Population results in this stratum
....... 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 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.).
....... count 0..1 integer Size of the population
....... subjectResults 0..1 Reference(List) For subject-list reports, the subject results in this population
...... measureScore 0..1 Quantity What score this stratum achieved
... evaluatedResource 0..* Reference(Resource) What data was used to calculate the measure score

doco Documentation for this format

Terminology Bindings

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.stratum.population.​code Base extensible MeasurePopulationType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MeasureReport If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MeasureReport 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 MeasureReport 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 MeasureReport If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MeasureReport 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()
mrp-1 error MeasureReport Measure Reports used for data collection SHALL NOT communicate group and score information (type != 'data-collection') or group.exists().not()
mrp-2 error MeasureReport Stratifiers SHALL be either a single criteria or a set of criteria components group.stratifier.stratum.all(value.exists() xor component.exists())

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MeasureReport C 0..* MeasureReport Results of a measure evaluation
Constraints: mrp-1, mrp-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:coverageSource S 1..1 (Complex) Coverage Source
URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://icr.healthcampaigns.org/StructureDefinition/coverage-source"
..... value[x] 0..1 code Value of extension
Binding: ICR Coverage Source (required)
Required Pattern: administrative
.... extension:denominatorSource S 0..1 CodeableConcept Denominator Source
URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source
Binding: ICR Denominator Source (extensible)
.... extension:denominatorType 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)
.... extension:coverageUnit 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)
.... extension:dataLineage 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)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type SΣC 1..1 code individual | subject-list | summary | data-collection
Binding: MeasureReportType (required): The type of the measure report.
... measure SΣ 1..1 canonical(Measure) The canonical ICR coverage Measure this report instances — declares the populations and standard stratifiers (§8, v0.19.0)
... reporter SΣ 1..1 Reference(Practitioner | PractitionerRole | Location | Organization) Required (v0.20.0, §15 #7-bis): who reported this figure — typically the supervisor's ICRCareTeam / their organization
... period SΣ 1..1 Period What period the report covers
... improvementNotation ?!Σ 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.
... group SC 0..* BackboneElement Measure results for each group
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... stratifier 0..* BackboneElement Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — ICRCoverageStratifierVS (v0.19.0)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

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.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MeasureReport If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MeasureReport 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 MeasureReport 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 MeasureReport If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MeasureReport 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()
mrp-1 error MeasureReport Measure Reports used for data collection SHALL NOT communicate group and score information (type != 'data-collection') or group.exists().not()
mrp-2 error MeasureReport Stratifiers SHALL be either a single criteria or a set of criteria components group.stratifier.stratum.all(value.exists() xor component.exists())

Differential View

This structure is derived from MeasureReport

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MeasureReport 0..* MeasureReport Results of a measure evaluation
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:coverageSource S 1..1 (Complex) Coverage Source
URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source
..... value[x] 0..1 code Value of extension
Required Pattern: administrative
.... extension:denominatorSource S 0..1 CodeableConcept Denominator Source
URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source
Binding: ICR Denominator Source (extensible)
.... extension:denominatorType 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)
.... extension:coverageUnit 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)
.... extension:dataLineage 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)
... status S 1..1 code complete | pending | error
... type S 1..1 code individual | subject-list | summary | data-collection
... reporter S 1..1 Reference(Practitioner | PractitionerRole | Location | Organization) Required (v0.20.0, §15 #7-bis): who reported this figure — typically the supervisor's ICRCareTeam / their organization
... period S 1..1 Period What period the report covers
... group S 0..* BackboneElement Measure results for each group
.... stratifier 0..* BackboneElement Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — ICRCoverageStratifierVS (v0.19.0)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MeasureReport C 0..* MeasureReport Results of a measure evaluation
Constraints: mrp-1, mrp-2
... 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 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:coverageSource S 1..1 (Complex) Coverage Source
URL: https://icr.healthcampaigns.org/StructureDefinition/coverage-source
..... 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/coverage-source"
..... value[x] 0..1 code Value of extension
Binding: ICR Coverage Source (required)
Required Pattern: administrative
.... extension:denominatorSource S 0..1 CodeableConcept Denominator Source
URL: https://icr.healthcampaigns.org/StructureDefinition/denominator-source
Binding: ICR Denominator Source (extensible)
.... extension:denominatorType 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)
.... extension:coverageUnit 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)
.... extension:dataLineage 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)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Additional identifier for the MeasureReport
... status ?!SΣ 1..1 code complete | pending | error
Binding: MeasureReportStatus (required): The status of the measure report.
... type SΣC 1..1 code individual | subject-list | summary | data-collection
Binding: MeasureReportType (required): The type of the measure report.
... measure SΣ 1..1 canonical(Measure) The canonical ICR coverage Measure this report instances — declares the populations and standard stratifiers (§8, v0.19.0)
... subject Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | Location | Device | RelatedPerson | Group) What individual(s) the report is for
... date Σ 0..1 dateTime When the report was generated
... reporter SΣ 1..1 Reference(Practitioner | PractitionerRole | Location | Organization) Required (v0.20.0, §15 #7-bis): who reported this figure — typically the supervisor's ICRCareTeam / their organization
... period SΣ 1..1 Period What period the report covers
... improvementNotation ?!Σ 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.
... group SC 0..* BackboneElement Measure results for each 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
.... code Σ 0..1 CodeableConcept Meaning of the group
.... population 0..* BackboneElement The populations in the 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
..... code Σ 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.).
..... count 0..1 integer Size of the population
..... subjectResults 0..1 Reference(List) For subject-list reports, the subject results in this population
.... measureScore Σ 0..1 Quantity What score this group achieved
.... stratifier 0..* BackboneElement Disaggregation by the standard axes (sex, age-band, delivery-strategy, disposition, geography) the Measure declares — ICRCoverageStratifierVS (v0.19.0)
..... 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 0..* CodeableConcept What stratifier of the group
..... stratum 0..* BackboneElement Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components
...... 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
...... value 0..1 CodeableConcept The stratum value, e.g. male
...... component 0..* BackboneElement Stratifier component values
....... 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 What stratifier component of the group
....... value 1..1 CodeableConcept The stratum component value, e.g. male
...... population 0..* BackboneElement Population results in this stratum
....... 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 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.).
....... count 0..1 integer Size of the population
....... subjectResults 0..1 Reference(List) For subject-list reports, the subject results in this population
...... measureScore 0..1 Quantity What score this stratum achieved
... evaluatedResource 0..* Reference(Resource) What data was used to calculate the measure score

doco Documentation for this format

Terminology Bindings

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.stratum.population.​code Base extensible MeasurePopulationType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MeasureReport If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MeasureReport 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 MeasureReport 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 MeasureReport If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MeasureReport 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()
mrp-1 error MeasureReport Measure Reports used for data collection SHALL NOT communicate group and score information (type != 'data-collection') or group.exists().not()
mrp-2 error MeasureReport Stratifiers SHALL be either a single criteria or a set of criteria components group.stratifier.stratum.all(value.exists() xor component.exists())

 

Other representations of profile: CSV, Excel, Schematron