NPHCDA Immunization FHIR IG
0.9.0 - ci-build Nigeria flag

NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.9.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nigeria-FHIR-Community/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions

Resource Profile: NG-Imm Measure

Official URL: https://nphcda.gov.ng/ig/StructureDefinition/ngimm-measure Version: 0.9.0
Draft as of 2026-10-07 Computable Name: NgImmMeasure

A profile on the Measure resource used to define immunization indicators within Nigeria's routine immunization program.

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: doco
Measure C 0..* Measure A quality measure definition
Constraints: mea-0, mea-1
Measure.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Measure.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Measure.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Additional identifier for the measure
Measure.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Measure.identifier.value This element is included in summaries. 1..1 string A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage).
Example General: 123456
Measure.name This element must be supported. This element is included in summaries. C 1..1 string A machine-friendly name for the measure (e.g., DropoutRate).
Measure.title This element must be supported. This element is included in summaries. 1..1 string A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate').
Measure.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code Indicates the status of the measure (e.g., draft, active, retired).
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Measure.date This element must be supported. This element is included in summaries. 1..1 dateTime The date this measure profile or version was published.
Measure.publisher This element must be supported. This element is included in summaries. 0..1 string The organization or person responsible for publishing the measure.
Measure.description This element must be supported. This element is included in summaries. 1..1 markdown Detailed description of what this measure represents.
Measure.purpose This element must be supported. 0..1 markdown Explains the reason this measure exists and what it is intended to support.
Measure.topic This element must be supported. 0..1 CodeableConcept A code or text indicating the domain/topic of the measure (e.g., Immunization Coverage).
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Measure.library This element must be supported. 0..1 canonical(Library) Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure.
Measure.scoring This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the measure is scored (e.g., proportion, ratio, continuous-variable).
Binding: MeasureScoring (extensible): The scoring type of the measure.
Measure.improvementNotation This element must be supported. This element is included in summaries. 0..1 CodeableConcept Indicates whether an increase or decrease in the score is desirable.
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.
Measure.group This element must be supported. 0..10 BackboneElement Population criteria group
Measure.group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.population This element must be supported. 0..10 BackboneElement Population criteria
Measure.group.population.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.population.code 0..1 CodeableConcept The type of population for the measure (e.g., numerator, denominator, initial-population).
Binding: MeasurePopulationType (extensible): The type of population.
Measure.group.population.description This element must be supported. 0..1 string Description of the population involved in the indicator.
Measure.group.population.criteria This element must be supported. 1..1 Expression Description of the population involved in the indicator.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Measure.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Measure.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Measure.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Measure.scoring Base extensible MeasureScoring 📍4.0.1 FHIR Std.
Measure.improvementNotation Base required MeasureImprovementNotation 📍4.0.1 FHIR Std.
Measure.group.population.​code Base extensible MeasurePopulationType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Measure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Measure 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 Measure 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 Measure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Measure 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()
mea-0 warning Measure Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
mea-1 error Measure Stratifier SHALL be either a single criteria or a set of criteria components group.stratifier.all((code | description | criteria).exists() xor component.exists())

This structure is derived from Measure

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Measure Measure
Measure.identifier This element must be supported. 1..1 Identifier Additional identifier for the measure
Measure.identifier.value 1..1 string A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage).
Measure.name This element must be supported. 1..1 string A machine-friendly name for the measure (e.g., DropoutRate).
Measure.title This element must be supported. 1..1 string A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate').
Measure.date This element must be supported. 1..1 dateTime The date this measure profile or version was published.
Measure.publisher This element must be supported. 0..1 string The organization or person responsible for publishing the measure.
Measure.description This element must be supported. 1..1 markdown Detailed description of what this measure represents.
Measure.purpose This element must be supported. 0..1 markdown Explains the reason this measure exists and what it is intended to support.
Measure.topic This element must be supported. 0..1 CodeableConcept A code or text indicating the domain/topic of the measure (e.g., Immunization Coverage).
Measure.library This element must be supported. 0..1 canonical(Library) Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure.
Measure.scoring This element must be supported. 1..1 CodeableConcept How the measure is scored (e.g., proportion, ratio, continuous-variable).
Measure.improvementNotation This element must be supported. 0..1 CodeableConcept Indicates whether an increase or decrease in the score is desirable.
Measure.group This element must be supported. 0..10 BackboneElement Population criteria group
Measure.group.population This element must be supported. 0..10 BackboneElement Population criteria
Measure.group.population.code 0..1 CodeableConcept The type of population for the measure (e.g., numerator, denominator, initial-population).
Measure.group.population.description This element must be supported. 0..1 string Description of the population involved in the indicator.
Measure.group.population.criteria This element must be supported. 1..1 Expression Description of the population involved in the indicator.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Measure C 0..* Measure A quality measure definition
Constraints: mea-0, mea-1
Measure.id This element is included in summaries. 0..1 id Logical id of this artifact
Measure.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Measure.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Measure.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Measure.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
Measure.contained 0..* Resource Contained, inline Resources
Measure.extension 0..* Extension Additional content defined by implementations
Measure.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Measure.url This element is included in summaries. 0..1 uri Canonical identifier for this measure, represented as a URI (globally unique)
Measure.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Additional identifier for the measure
Measure.identifier.id 0..1 string Unique id for inter-element referencing
Measure.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Measure.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Measure.identifier.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Measure.identifier.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Measure.identifier.value This element is included in summaries. 1..1 string A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage).
Example General: 123456
Measure.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Measure.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Measure.version This element is included in summaries. 0..1 string Business version of the measure
Measure.name This element must be supported. This element is included in summaries. C 1..1 string A machine-friendly name for the measure (e.g., DropoutRate).
Measure.title This element must be supported. This element is included in summaries. 1..1 string A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate').
Measure.subtitle 0..1 string Subordinate title of the measure
Measure.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code Indicates the status of the measure (e.g., draft, active, retired).
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Measure.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Measure.subject[x] 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).
Measure.subject[x].subjectCodeableConcept CodeableConcept
Measure.subject[x].subjectReference Reference(Group)
Measure.date This element must be supported. This element is included in summaries. 1..1 dateTime The date this measure profile or version was published.
Measure.publisher This element must be supported. This element is included in summaries. 0..1 string The organization or person responsible for publishing the measure.
Measure.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Measure.description This element must be supported. This element is included in summaries. 1..1 markdown Detailed description of what this measure represents.
Measure.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Measure.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for measure (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Measure.purpose This element must be supported. 0..1 markdown Explains the reason this measure exists and what it is intended to support.
Measure.usage 0..1 string Describes the clinical usage of the measure
Measure.copyright 0..1 markdown Use and/or publishing restrictions
Measure.approvalDate 0..1 date When the measure was approved by publisher
Measure.lastReviewDate 0..1 date When the measure was last reviewed
Measure.effectivePeriod This element is included in summaries. 0..1 Period When the measure is expected to be used
Measure.topic This element must be supported. 0..1 CodeableConcept A code or text indicating the domain/topic of the measure (e.g., Immunization Coverage).
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Measure.author 0..* ContactDetail Who authored the content
Measure.editor 0..* ContactDetail Who edited the content
Measure.reviewer 0..* ContactDetail Who reviewed the content
Measure.endorser 0..* ContactDetail Who endorsed the content
Measure.relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
Measure.library This element must be supported. 0..1 canonical(Library) Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure.
Measure.disclaimer This element is included in summaries. 0..1 markdown Disclaimer for use of the measure or its referenced content
Measure.scoring This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the measure is scored (e.g., proportion, ratio, continuous-variable).
Binding: MeasureScoring (extensible): The scoring type of the measure.
Measure.compositeScoring This element is included in summaries. 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted
Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure.
Measure.type This element is included in summaries. 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType (extensible): The type of measure (includes codes from 2.16.840.1.113883.1.11.20368).
Measure.riskAdjustment This element is included in summaries. 0..1 string How risk adjustment is applied for this measure
Measure.rateAggregation This element is included in summaries. 0..1 string How is rate aggregation performed for this measure
Measure.rationale This element is included in summaries. 0..1 markdown Detailed description of why the measure exists
Measure.clinicalRecommendationStatement This element is included in summaries. 0..1 markdown Summary of clinical guidelines
Measure.improvementNotation This element must be supported. This element is included in summaries. 0..1 CodeableConcept Indicates whether an increase or decrease in the score is desirable.
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.
Measure.definition This element is included in summaries. 0..* markdown Defined terms used in the measure documentation
Measure.guidance This element is included in summaries. 0..1 markdown Additional guidance for implementers
Measure.group This element must be supported. 0..10 BackboneElement Population criteria group
Measure.group.id 0..1 string Unique id for inter-element referencing
Measure.group.extension 0..* Extension Additional content defined by implementations
Measure.group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.code 0..1 CodeableConcept Meaning of the group
Measure.group.description 0..1 string Summary description
Measure.group.population This element must be supported. 0..10 BackboneElement Population criteria
Measure.group.population.id 0..1 string Unique id for inter-element referencing
Measure.group.population.extension 0..* Extension Additional content defined by implementations
Measure.group.population.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.population.code 0..1 CodeableConcept The type of population for the measure (e.g., numerator, denominator, initial-population).
Binding: MeasurePopulationType (extensible): The type of population.
Measure.group.population.description This element must be supported. 0..1 string Description of the population involved in the indicator.
Measure.group.population.criteria This element must be supported. 1..1 Expression Description of the population involved in the indicator.
Measure.group.stratifier 0..* BackboneElement Stratifier criteria for the measure
Measure.group.stratifier.id 0..1 string Unique id for inter-element referencing
Measure.group.stratifier.extension 0..* Extension Additional content defined by implementations
Measure.group.stratifier.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.stratifier.code 0..1 CodeableConcept Meaning of the stratifier
Measure.group.stratifier.description 0..1 string The human readable description of this stratifier
Measure.group.stratifier.criteria 0..1 Expression How the measure should be stratified
Measure.group.stratifier.component 0..* BackboneElement Stratifier criteria component for the measure
Measure.group.stratifier.component.id 0..1 string Unique id for inter-element referencing
Measure.group.stratifier.component.extension 0..* Extension Additional content defined by implementations
Measure.group.stratifier.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.stratifier.component.code 0..1 CodeableConcept Meaning of the stratifier component
Measure.group.stratifier.component.description 0..1 string The human readable description of this stratifier component
Measure.group.stratifier.component.criteria 1..1 Expression Component of how the measure should be stratified
Measure.supplementalData 0..* BackboneElement What other data should be reported with the measure
Measure.supplementalData.id 0..1 string Unique id for inter-element referencing
Measure.supplementalData.extension 0..* Extension Additional content defined by implementations
Measure.supplementalData.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.supplementalData.code 0..1 CodeableConcept Meaning of the supplemental data
Measure.supplementalData.usage 0..* CodeableConcept supplemental-data | risk-adjustment-factor
Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure.
Measure.supplementalData.description 0..1 string The human readable description of this supplemental data
Measure.supplementalData.criteria 1..1 Expression Expression describing additional data to be reported

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Measure.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Measure.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Measure.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Measure.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Measure.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Measure.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Measure.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Measure.scoring Base extensible MeasureScoring 📍4.0.1 FHIR Std.
Measure.compositeScoring Base extensible CompositeMeasureScoring 📍4.0.1 FHIR Std.
Measure.type Base extensible MeasureType 📍4.0.1 FHIR Std.
Measure.improvementNotation Base required MeasureImprovementNotation 📍4.0.1 FHIR Std.
Measure.group.population.​code Base extensible MeasurePopulationType 📍4.0.1 FHIR Std.
Measure.supplementalData.​usage Base extensible MeasureDataUsage 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Measure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Measure 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 Measure 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 Measure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Measure 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()
mea-0 warning Measure Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
mea-1 error Measure Stratifier SHALL be either a single criteria or a set of criteria components group.stratifier.all((code | description | criteria).exists() xor component.exists())

This structure is derived from Measure

Summary

Mandatory: 7 elements
Must-Support: 16 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Measure C 0..* Measure A quality measure definition
Constraints: mea-0, mea-1
Measure.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Measure.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Measure.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Additional identifier for the measure
Measure.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Measure.identifier.value This element is included in summaries. 1..1 string A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage).
Example General: 123456
Measure.name This element must be supported. This element is included in summaries. C 1..1 string A machine-friendly name for the measure (e.g., DropoutRate).
Measure.title This element must be supported. This element is included in summaries. 1..1 string A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate').
Measure.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code Indicates the status of the measure (e.g., draft, active, retired).
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Measure.date This element must be supported. This element is included in summaries. 1..1 dateTime The date this measure profile or version was published.
Measure.publisher This element must be supported. This element is included in summaries. 0..1 string The organization or person responsible for publishing the measure.
Measure.description This element must be supported. This element is included in summaries. 1..1 markdown Detailed description of what this measure represents.
Measure.purpose This element must be supported. 0..1 markdown Explains the reason this measure exists and what it is intended to support.
Measure.topic This element must be supported. 0..1 CodeableConcept A code or text indicating the domain/topic of the measure (e.g., Immunization Coverage).
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Measure.library This element must be supported. 0..1 canonical(Library) Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure.
Measure.scoring This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the measure is scored (e.g., proportion, ratio, continuous-variable).
Binding: MeasureScoring (extensible): The scoring type of the measure.
Measure.improvementNotation This element must be supported. This element is included in summaries. 0..1 CodeableConcept Indicates whether an increase or decrease in the score is desirable.
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.
Measure.group This element must be supported. 0..10 BackboneElement Population criteria group
Measure.group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.population This element must be supported. 0..10 BackboneElement Population criteria
Measure.group.population.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.population.code 0..1 CodeableConcept The type of population for the measure (e.g., numerator, denominator, initial-population).
Binding: MeasurePopulationType (extensible): The type of population.
Measure.group.population.description This element must be supported. 0..1 string Description of the population involved in the indicator.
Measure.group.population.criteria This element must be supported. 1..1 Expression Description of the population involved in the indicator.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Measure.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Measure.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Measure.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Measure.scoring Base extensible MeasureScoring 📍4.0.1 FHIR Std.
Measure.improvementNotation Base required MeasureImprovementNotation 📍4.0.1 FHIR Std.
Measure.group.population.​code Base extensible MeasurePopulationType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Measure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Measure 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 Measure 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 Measure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Measure 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()
mea-0 warning Measure Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
mea-1 error Measure Stratifier SHALL be either a single criteria or a set of criteria components group.stratifier.all((code | description | criteria).exists() xor component.exists())

Differential View

This structure is derived from Measure

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Measure Measure
Measure.identifier This element must be supported. 1..1 Identifier Additional identifier for the measure
Measure.identifier.value 1..1 string A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage).
Measure.name This element must be supported. 1..1 string A machine-friendly name for the measure (e.g., DropoutRate).
Measure.title This element must be supported. 1..1 string A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate').
Measure.status This element must be supported. 1..1 code Indicates the status of the measure (e.g., draft, active, retired).
Measure.date This element must be supported. 1..1 dateTime The date this measure profile or version was published.
Measure.publisher This element must be supported. 0..1 string The organization or person responsible for publishing the measure.
Measure.description This element must be supported. 1..1 markdown Detailed description of what this measure represents.
Measure.purpose This element must be supported. 0..1 markdown Explains the reason this measure exists and what it is intended to support.
Measure.topic This element must be supported. 0..1 CodeableConcept A code or text indicating the domain/topic of the measure (e.g., Immunization Coverage).
Measure.library This element must be supported. 0..1 canonical(Library) Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure.
Measure.scoring This element must be supported. 1..1 CodeableConcept How the measure is scored (e.g., proportion, ratio, continuous-variable).
Measure.improvementNotation This element must be supported. 0..1 CodeableConcept Indicates whether an increase or decrease in the score is desirable.
Measure.group This element must be supported. 0..10 BackboneElement Population criteria group
Measure.group.population This element must be supported. 0..10 BackboneElement Population criteria
Measure.group.population.code 0..1 CodeableConcept The type of population for the measure (e.g., numerator, denominator, initial-population).
Measure.group.population.description This element must be supported. 0..1 string Description of the population involved in the indicator.
Measure.group.population.criteria This element must be supported. 1..1 Expression Description of the population involved in the indicator.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Measure C 0..* Measure A quality measure definition
Constraints: mea-0, mea-1
Measure.id This element is included in summaries. 0..1 id Logical id of this artifact
Measure.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Measure.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Measure.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Measure.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
Measure.contained 0..* Resource Contained, inline Resources
Measure.extension 0..* Extension Additional content defined by implementations
Measure.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Measure.url This element is included in summaries. 0..1 uri Canonical identifier for this measure, represented as a URI (globally unique)
Measure.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Additional identifier for the measure
Measure.identifier.id 0..1 string Unique id for inter-element referencing
Measure.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Measure.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Measure.identifier.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Measure.identifier.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Measure.identifier.value This element is included in summaries. 1..1 string A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage).
Example General: 123456
Measure.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Measure.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Measure.version This element is included in summaries. 0..1 string Business version of the measure
Measure.name This element must be supported. This element is included in summaries. C 1..1 string A machine-friendly name for the measure (e.g., DropoutRate).
Measure.title This element must be supported. This element is included in summaries. 1..1 string A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate').
Measure.subtitle 0..1 string Subordinate title of the measure
Measure.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code Indicates the status of the measure (e.g., draft, active, retired).
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Measure.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Measure.subject[x] 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).
Measure.subject[x].subjectCodeableConcept CodeableConcept
Measure.subject[x].subjectReference Reference(Group)
Measure.date This element must be supported. This element is included in summaries. 1..1 dateTime The date this measure profile or version was published.
Measure.publisher This element must be supported. This element is included in summaries. 0..1 string The organization or person responsible for publishing the measure.
Measure.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Measure.description This element must be supported. This element is included in summaries. 1..1 markdown Detailed description of what this measure represents.
Measure.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Measure.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for measure (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Measure.purpose This element must be supported. 0..1 markdown Explains the reason this measure exists and what it is intended to support.
Measure.usage 0..1 string Describes the clinical usage of the measure
Measure.copyright 0..1 markdown Use and/or publishing restrictions
Measure.approvalDate 0..1 date When the measure was approved by publisher
Measure.lastReviewDate 0..1 date When the measure was last reviewed
Measure.effectivePeriod This element is included in summaries. 0..1 Period When the measure is expected to be used
Measure.topic This element must be supported. 0..1 CodeableConcept A code or text indicating the domain/topic of the measure (e.g., Immunization Coverage).
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Measure.author 0..* ContactDetail Who authored the content
Measure.editor 0..* ContactDetail Who edited the content
Measure.reviewer 0..* ContactDetail Who reviewed the content
Measure.endorser 0..* ContactDetail Who endorsed the content
Measure.relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
Measure.library This element must be supported. 0..1 canonical(Library) Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure.
Measure.disclaimer This element is included in summaries. 0..1 markdown Disclaimer for use of the measure or its referenced content
Measure.scoring This element must be supported. This element is included in summaries. 1..1 CodeableConcept How the measure is scored (e.g., proportion, ratio, continuous-variable).
Binding: MeasureScoring (extensible): The scoring type of the measure.
Measure.compositeScoring This element is included in summaries. 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted
Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure.
Measure.type This element is included in summaries. 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType (extensible): The type of measure (includes codes from 2.16.840.1.113883.1.11.20368).
Measure.riskAdjustment This element is included in summaries. 0..1 string How risk adjustment is applied for this measure
Measure.rateAggregation This element is included in summaries. 0..1 string How is rate aggregation performed for this measure
Measure.rationale This element is included in summaries. 0..1 markdown Detailed description of why the measure exists
Measure.clinicalRecommendationStatement This element is included in summaries. 0..1 markdown Summary of clinical guidelines
Measure.improvementNotation This element must be supported. This element is included in summaries. 0..1 CodeableConcept Indicates whether an increase or decrease in the score is desirable.
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.
Measure.definition This element is included in summaries. 0..* markdown Defined terms used in the measure documentation
Measure.guidance This element is included in summaries. 0..1 markdown Additional guidance for implementers
Measure.group This element must be supported. 0..10 BackboneElement Population criteria group
Measure.group.id 0..1 string Unique id for inter-element referencing
Measure.group.extension 0..* Extension Additional content defined by implementations
Measure.group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.code 0..1 CodeableConcept Meaning of the group
Measure.group.description 0..1 string Summary description
Measure.group.population This element must be supported. 0..10 BackboneElement Population criteria
Measure.group.population.id 0..1 string Unique id for inter-element referencing
Measure.group.population.extension 0..* Extension Additional content defined by implementations
Measure.group.population.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.population.code 0..1 CodeableConcept The type of population for the measure (e.g., numerator, denominator, initial-population).
Binding: MeasurePopulationType (extensible): The type of population.
Measure.group.population.description This element must be supported. 0..1 string Description of the population involved in the indicator.
Measure.group.population.criteria This element must be supported. 1..1 Expression Description of the population involved in the indicator.
Measure.group.stratifier 0..* BackboneElement Stratifier criteria for the measure
Measure.group.stratifier.id 0..1 string Unique id for inter-element referencing
Measure.group.stratifier.extension 0..* Extension Additional content defined by implementations
Measure.group.stratifier.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.stratifier.code 0..1 CodeableConcept Meaning of the stratifier
Measure.group.stratifier.description 0..1 string The human readable description of this stratifier
Measure.group.stratifier.criteria 0..1 Expression How the measure should be stratified
Measure.group.stratifier.component 0..* BackboneElement Stratifier criteria component for the measure
Measure.group.stratifier.component.id 0..1 string Unique id for inter-element referencing
Measure.group.stratifier.component.extension 0..* Extension Additional content defined by implementations
Measure.group.stratifier.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.group.stratifier.component.code 0..1 CodeableConcept Meaning of the stratifier component
Measure.group.stratifier.component.description 0..1 string The human readable description of this stratifier component
Measure.group.stratifier.component.criteria 1..1 Expression Component of how the measure should be stratified
Measure.supplementalData 0..* BackboneElement What other data should be reported with the measure
Measure.supplementalData.id 0..1 string Unique id for inter-element referencing
Measure.supplementalData.extension 0..* Extension Additional content defined by implementations
Measure.supplementalData.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Measure.supplementalData.code 0..1 CodeableConcept Meaning of the supplemental data
Measure.supplementalData.usage 0..* CodeableConcept supplemental-data | risk-adjustment-factor
Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure.
Measure.supplementalData.description 0..1 string The human readable description of this supplemental data
Measure.supplementalData.criteria 1..1 Expression Expression describing additional data to be reported

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Measure.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Measure.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Measure.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Measure.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Measure.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Measure.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Measure.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
Measure.scoring Base extensible MeasureScoring 📍4.0.1 FHIR Std.
Measure.compositeScoring Base extensible CompositeMeasureScoring 📍4.0.1 FHIR Std.
Measure.type Base extensible MeasureType 📍4.0.1 FHIR Std.
Measure.improvementNotation Base required MeasureImprovementNotation 📍4.0.1 FHIR Std.
Measure.group.population.​code Base extensible MeasurePopulationType 📍4.0.1 FHIR Std.
Measure.supplementalData.​usage Base extensible MeasureDataUsage 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Measure If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Measure 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 Measure 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 Measure If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Measure 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()
mea-0 warning Measure Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
mea-1 error Measure Stratifier SHALL be either a single criteria or a set of criteria components group.stratifier.all((code | description | criteria).exists() xor component.exists())

This structure is derived from Measure

Summary

Mandatory: 7 elements
Must-Support: 16 elements

 

Other representations of profile: CSV, Excel, Schematron