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
Official URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-measure | Version: 0.1.0 | |||
Draft as of 2025-10-02 | 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Measure | A quality measure definition Constraints: mea-0, mea-1 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the measure |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage). Example General: 123456 |
![]() ![]() ![]() |
SΣC | 1..1 | string | A machine-friendly name for the measure (e.g., DropoutRate). |
![]() ![]() ![]() |
SΣ | 1..1 | string | A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate'). |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | Indicates the status of the measure (e.g., draft, active, retired). Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | The date this measure profile or version was published. |
![]() ![]() ![]() |
SΣ | 0..1 | string | The organization or person responsible for publishing the measure. |
![]() ![]() ![]() |
SΣ | 1..1 | markdown | Detailed description of what this measure represents. |
![]() ![]() ![]() |
S | 0..1 | markdown | Explains the reason this measure exists and what it is intended to support. |
![]() ![]() ![]() |
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. |
![]() ![]() ![]() |
S | 0..1 | canonical(Library) | Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | How the measure is scored (e.g., proportion, ratio, continuous-variable). Binding: MeasureScoring (extensible): The scoring type of the measure. |
![]() ![]() ![]() |
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. |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Population criteria group |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 2..* | BackboneElement | Population criteria |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The type of population for the measure (e.g., numerator, denominator, initial-population). Binding: MeasurePopulationType (extensible): The type of population. | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Description of the population involved in the indicator. |
![]() ![]() ![]() ![]() ![]() |
1..1 | Expression | The criteria that defines this population | |
![]() |
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. |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Measure | A quality measure definition | |
![]() ![]() ![]() |
S | 1..1 | Identifier | Additional identifier for the measure |
![]() ![]() ![]() ![]() |
1..1 | string | A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage). | |
![]() ![]() ![]() |
S | 1..1 | string | A machine-friendly name for the measure (e.g., DropoutRate). |
![]() ![]() ![]() |
S | 1..1 | string | A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate'). |
![]() ![]() ![]() |
S | 1..1 | code | Indicates the status of the measure (e.g., draft, active, retired). |
![]() ![]() ![]() |
S | 1..1 | dateTime | The date this measure profile or version was published. |
![]() ![]() ![]() |
S | 0..1 | string | The organization or person responsible for publishing the measure. |
![]() ![]() ![]() |
S | 1..1 | markdown | Detailed description of what this measure represents. |
![]() ![]() ![]() |
S | 0..1 | markdown | Explains the reason this measure exists and what it is intended to support. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | A code or text indicating the domain/topic of the measure (e.g., Immunization Coverage). |
![]() ![]() ![]() |
S | 0..1 | canonical(Library) | Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure. |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the measure is scored (e.g., proportion, ratio, continuous-variable). |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Indicates whether an increase or decrease in the score is desirable. |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Population criteria group |
![]() ![]() ![]() ![]() |
S | 2..* | BackboneElement | Population criteria |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The type of population for the measure (e.g., numerator, denominator, initial-population). | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Description of the population involved in the indicator. |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Measure | A quality measure definition Constraints: mea-0, mea-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the measure | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage). Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the measure | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | A machine-friendly name for the measure (e.g., DropoutRate). | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate'). | ||||
![]() ![]() ![]() |
0..1 | string | Subordinate title of the measure | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | Indicates the status of the measure (e.g., draft, active, retired). Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
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.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | The date this measure profile or version was published. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The organization or person responsible for publishing the measure. | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
SΣ | 1..1 | markdown | Detailed description of what this measure represents. | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
S | 0..1 | markdown | Explains the reason this measure exists and what it is intended to support. | ||||
![]() ![]() ![]() |
0..1 | string | Describes the clinical usage of the measure | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | date | When the measure was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the measure was last reviewed | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the measure is expected to be used | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
![]() ![]() ![]() |
S | 0..1 | canonical(Library) | Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure. | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | How the measure is scored (e.g., proportion, ratio, continuous-variable). Binding: MeasureScoring (extensible): The scoring type of the measure. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure. | ||||
![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | How risk adjustment is applied for this measure | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | How is rate aggregation performed for this measure | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Detailed description of why the measure exists | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Summary of clinical guidelines | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
Σ | 0..* | markdown | Defined terms used in the measure documentation | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Additional guidance for implementers | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Population criteria group | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the group | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Summary description | |||||
![]() ![]() ![]() ![]() |
S | 2..* | BackboneElement | Population criteria | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The type of population for the measure (e.g., numerator, denominator, initial-population). Binding: MeasurePopulationType (extensible): The type of population. | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Description of the population involved in the indicator. | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Expression | The criteria that defines this population | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Stratifier criteria for the measure | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the stratifier | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The human readable description of this stratifier | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Expression | How the measure should be stratified | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Stratifier criteria component for the measure | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the stratifier component | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | The human readable description of this stratifier component | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Expression | Component of how the measure should be stratified | |||||
![]() ![]() ![]() |
0..* | BackboneElement | What other data should be reported with the measure | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the supplemental data | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The human readable description of this supplemental data | |||||
![]() ![]() ![]() ![]() |
1..1 | Expression | Expression describing additional data to be reported | |||||
![]() |
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. |
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
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Measure | A quality measure definition Constraints: mea-0, mea-1 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the measure |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage). Example General: 123456 |
![]() ![]() ![]() |
SΣC | 1..1 | string | A machine-friendly name for the measure (e.g., DropoutRate). |
![]() ![]() ![]() |
SΣ | 1..1 | string | A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate'). |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | Indicates the status of the measure (e.g., draft, active, retired). Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | The date this measure profile or version was published. |
![]() ![]() ![]() |
SΣ | 0..1 | string | The organization or person responsible for publishing the measure. |
![]() ![]() ![]() |
SΣ | 1..1 | markdown | Detailed description of what this measure represents. |
![]() ![]() ![]() |
S | 0..1 | markdown | Explains the reason this measure exists and what it is intended to support. |
![]() ![]() ![]() |
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. |
![]() ![]() ![]() |
S | 0..1 | canonical(Library) | Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | How the measure is scored (e.g., proportion, ratio, continuous-variable). Binding: MeasureScoring (extensible): The scoring type of the measure. |
![]() ![]() ![]() |
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. |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Population criteria group |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 2..* | BackboneElement | Population criteria |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The type of population for the measure (e.g., numerator, denominator, initial-population). Binding: MeasurePopulationType (extensible): The type of population. | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Description of the population involved in the indicator. |
![]() ![]() ![]() ![]() ![]() |
1..1 | Expression | The criteria that defines this population | |
![]() |
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. |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Measure | A quality measure definition | |
![]() ![]() ![]() |
S | 1..1 | Identifier | Additional identifier for the measure |
![]() ![]() ![]() ![]() |
1..1 | string | A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage). | |
![]() ![]() ![]() |
S | 1..1 | string | A machine-friendly name for the measure (e.g., DropoutRate). |
![]() ![]() ![]() |
S | 1..1 | string | A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate'). |
![]() ![]() ![]() |
S | 1..1 | code | Indicates the status of the measure (e.g., draft, active, retired). |
![]() ![]() ![]() |
S | 1..1 | dateTime | The date this measure profile or version was published. |
![]() ![]() ![]() |
S | 0..1 | string | The organization or person responsible for publishing the measure. |
![]() ![]() ![]() |
S | 1..1 | markdown | Detailed description of what this measure represents. |
![]() ![]() ![]() |
S | 0..1 | markdown | Explains the reason this measure exists and what it is intended to support. |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | A code or text indicating the domain/topic of the measure (e.g., Immunization Coverage). |
![]() ![]() ![]() |
S | 0..1 | canonical(Library) | Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure. |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the measure is scored (e.g., proportion, ratio, continuous-variable). |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Indicates whether an increase or decrease in the score is desirable. |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Population criteria group |
![]() ![]() ![]() ![]() |
S | 2..* | BackboneElement | Population criteria |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The type of population for the measure (e.g., numerator, denominator, initial-population). | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Description of the population involved in the indicator. |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Measure | A quality measure definition Constraints: mea-0, mea-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Additional identifier for the measure | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | A unique identifier for the indicator definition (e.g. dropout-rate, bcg-coverage). Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the measure | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | A machine-friendly name for the measure (e.g., DropoutRate). | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | A human-readable title for the measure (e.g., 'Penta1 to Measles Dropout Rate'). | ||||
![]() ![]() ![]() |
0..1 | string | Subordinate title of the measure | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | Indicates the status of the measure (e.g., draft, active, retired). Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
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.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | The date this measure profile or version was published. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The organization or person responsible for publishing the measure. | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
SΣ | 1..1 | markdown | Detailed description of what this measure represents. | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
S | 0..1 | markdown | Explains the reason this measure exists and what it is intended to support. | ||||
![]() ![]() ![]() |
0..1 | string | Describes the clinical usage of the measure | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | date | When the measure was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the measure was last reviewed | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the measure is expected to be used | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
![]() ![]() ![]() |
S | 0..1 | canonical(Library) | Reference to the logic library (e.g., CQL or ELM) defining computation rules for the measure. | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | How the measure is scored (e.g., proportion, ratio, continuous-variable). Binding: MeasureScoring (extensible): The scoring type of the measure. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure. | ||||
![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | How risk adjustment is applied for this measure | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | How is rate aggregation performed for this measure | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Detailed description of why the measure exists | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Summary of clinical guidelines | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
Σ | 0..* | markdown | Defined terms used in the measure documentation | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Additional guidance for implementers | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Population criteria group | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the group | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Summary description | |||||
![]() ![]() ![]() ![]() |
S | 2..* | BackboneElement | Population criteria | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The type of population for the measure (e.g., numerator, denominator, initial-population). Binding: MeasurePopulationType (extensible): The type of population. | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Description of the population involved in the indicator. | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Expression | The criteria that defines this population | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Stratifier criteria for the measure | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the stratifier | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The human readable description of this stratifier | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Expression | How the measure should be stratified | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Stratifier criteria component for the measure | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the stratifier component | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | The human readable description of this stratifier component | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Expression | Component of how the measure should be stratified | |||||
![]() ![]() ![]() |
0..* | BackboneElement | What other data should be reported with the measure | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the supplemental data | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The human readable description of this supplemental data | |||||
![]() ![]() ![]() ![]() |
1..1 | Expression | Expression describing additional data to be reported | |||||
![]() |
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. |
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
Other representations of profile: CSV, Excel, Schematron