DHIN 2025Connectathon FHIR IG
0.1.0 - draft

DHIN 2025Connectathon FHIR IG, published by DHIN. This guide is not an authorized publication; it is the continuous build for version 0.1.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/2025Connectathon/ and changes regularly. See the Directory of published versions

Resource Profile: NG Measure

Official URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-measure Version: 0.1.0
Draft as of 2025-10-21 Computable Name: NgMeasure

A profile on the Measure resource used to define indicators within prescription 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: Filtersdoco
.. Measure C 0..* Measure A quality measure definition
Constraints: mea-0, mea-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Additional identifier for the measure
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... value Σ 1..1 string A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage).
Example General: 123456
... title SΣ 1..1 string A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate').
... status ?!SΣ 1..1 code Indicates the status of the measure (e.g., draft, active, retired).
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... date SΣ 1..1 dateTime The date this measure profile or version was published.
... publisher SΣ 0..1 string The organization or person responsible for publishing the measure.
... description SΣ 1..1 markdown Detailed description of what this measure represents.
... purpose S 0..1 markdown Explains the reason this measure exists and what it is intended to support.
... topic S 0..* 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.
... library S 0..1 canonical(Library) Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure.
... scoring SΣ 1..1 CodeableConcept How the measure is scored (e.g., proportion, ratio, continuous-variable).
Binding: MeasureScoring (extensible): The scoring type of the measure.
... improvementNotation SΣ 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.
... group S 0..* BackboneElement Population criteria group
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... population S 0..* BackboneElement Population criteria
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 CodeableConcept The type of population for the measure (e.g., numerator, denominator, initial-population).
Binding: MeasurePopulationType (extensible): The type of population.
..... description S 0..1 string Description of the population involved in the indicator.
..... criteria 1..1 Expression The criteria that defines this population

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

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Measure C 0..* Measure A quality measure definition
Constraints: mea-0, mea-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Additional identifier for the measure
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... value Σ 1..1 string A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage).
Example General: 123456
... title SΣ 1..1 string A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate').
... status ?!SΣ 1..1 code Indicates the status of the measure (e.g., draft, active, retired).
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... date SΣ 1..1 dateTime The date this measure profile or version was published.
... publisher SΣ 0..1 string The organization or person responsible for publishing the measure.
... description SΣ 1..1 markdown Detailed description of what this measure represents.
... purpose S 0..1 markdown Explains the reason this measure exists and what it is intended to support.
... topic S 0..* 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.
... library S 0..1 canonical(Library) Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure.
... scoring SΣ 1..1 CodeableConcept How the measure is scored (e.g., proportion, ratio, continuous-variable).
Binding: MeasureScoring (extensible): The scoring type of the measure.
... improvementNotation SΣ 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.
... group S 0..* BackboneElement Population criteria group
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... population S 0..* BackboneElement Population criteria
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 CodeableConcept The type of population for the measure (e.g., numerator, denominator, initial-population).
Binding: MeasurePopulationType (extensible): The type of population.
..... description S 0..1 string Description of the population involved in the indicator.
..... criteria 1..1 Expression The criteria that defines this population

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

doco Documentation for this format

Snapshot View

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

 

Other representations of profile: CSV, Excel, Schematron