SMART Base
0.1.1 - ci-build
SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base/ and changes regularly. See the Directory of published versions
Official URL: http://smart.who.int/base/StructureDefinition/SGMeasure | Version: 0.1.1 | |||
Draft as of 2024-06-12 | Computable Name: SGMeasure |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Measure
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Measure | A quality measure definition | |
![]() ![]() ![]() |
1..1 | string | Business version of the measure | |
![]() ![]() ![]() |
1..1 | string | Name for this measure (computer friendly) | |
![]() ![]() ![]() |
1..1 | string | Name for this measure (human friendly) | |
![]() ![]() ![]() |
1..1 | string | Name of the publisher/steward (organization or individual) | |
![]() ![]() ![]() |
1..1 | markdown | Natural language description of the measure | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Measure | A quality measure definition cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation mea-1: Stratifier SHALL be either a single criteria or a set of criteria components |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | string | Business version of the measure |
![]() ![]() ![]() |
ΣC | 1..1 | string | Name for this measure (computer friendly) |
![]() ![]() ![]() |
Σ | 1..1 | string | Name for this measure (human friendly) |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
Σ | 1..1 | string | Name of the publisher/steward (organization or individual) |
![]() ![]() ![]() |
Σ | 1..1 | markdown | Natural language description of the measure |
![]() |
Path | Conformance | ValueSet | URI |
Measure.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Measure | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
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-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()) |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Measure | A quality measure definition cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation mea-1: Stratifier SHALL be either a single criteria or a set of criteria components | ||||
![]() ![]() ![]() |
Σ | 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: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
ΣC | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the measure | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Business version of the measure | ||||
![]() ![]() ![]() |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() |
ΣC | 1..1 | string | Name for this measure (computer friendly) | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Name for this measure (human friendly) | ||||
![]() ![]() ![]() |
0..1 | string | Subordinate title of the measure | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown 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: ParticipantResourceTypes (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
Σ | 0..1 | code | Population basis Binding: FHIRTypes (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Name of the publisher/steward (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
Σ | 1..1 | markdown | Natural language description of the measure | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this measure is defined | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the clinical usage of the measure | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) | |||||
![]() ![]() ![]() |
0..1 | date | When the measure was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the measure was last reviewed by the publisher | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the measure is expected to be used | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc 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 | |||||
![]() ![]() ![]() |
0..* | canonical(Library) | Logic used by the measure | |||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible): The scoring type of the measure. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What units? Binding: MeasureScoringUnit (example) | ||||
![]() ![]() ![]() |
Σ | 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 | markdown | How risk adjustment is applied for this measure | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | 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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Defined terms used in the measure documentation | |||||
![]() ![]() ![]() ![]() |
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 | What term? Binding: MeasureDefinitionExample (example): Codeable representations of measure definition terms. | |||||
![]() ![]() ![]() ![]() |
0..1 | markdown | Meaning of the term | |||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Additional guidance for implementers (deprecated) | ||||
![]() ![]() ![]() |
C | 0..* | 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 | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Unique id for group in measure mea-2: Link ids should be 255 characters or less | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the group Binding: MeasureGroupExample (example): Example of measure groups. | |||||
![]() ![]() ![]() ![]() |
0..1 | markdown | Summary description | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Population basis Binding: FHIRTypes (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What units? Binding: MeasureScoringUnit (example) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | markdown | How is rate aggregation performed for this measure | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required) | ||||
![]() ![]() ![]() ![]() |
0..* | canonical(Library) | Logic used by the measure group | |||||
![]() ![]() ![]() ![]() |
0..* | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Unique id for population in measure mea-3: Link ids should be 255 characters or less | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible): The type of population. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | markdown | The human readable description of this population criteria | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Expression | The criteria that defines this population | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Group) | A group resource that defines this population | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Which population | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count) Binding: MeasureAggregateMethod (extensible) | |||||
![]() ![]() ![]() ![]() |
C | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Unique id for stratifier in measure mea-4: Link ids should be 255 characters or less | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Meaning of the stratifier Binding: MeasureStratifierExample (example): Meaning of the stratifier. | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | markdown | The human readable description of this stratifier | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Expression | How the measure should be stratified | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Group) | A group resource that defines this population | |||||
![]() ![]() ![]() ![]() ![]() |
C | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Unique id for stratifier component in measure mea-5: Link ids should be 255 characters or less | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the stratifier component Binding: MeasureStratifierExample (example): Meaning of the stratifier. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | markdown | The human readable description of this stratifier component | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Expression | Component of how the measure should be stratified | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Group) | A group resource that defines this population | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Unique id for supplementalData in measure mea-6: Link ids should be 255 characters or less | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureSupplementalDataExample (example): 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 | markdown | The human readable description of this supplemental data | |||||
![]() ![]() ![]() ![]() |
1..1 | Expression | Expression describing additional data to be reported | |||||
![]() |
Path | Conformance | ValueSet | URI |
Measure.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Measure.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
Measure.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
Measure.subject[x] | extensible | ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-types from the FHIR Standard | |
Measure.basis | required | FHIRTypeshttp://hl7.org/fhir/ValueSet/fhir-types|5.0.0 from the FHIR Standard | |
Measure.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
Measure.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | |
Measure.scoring | extensible | MeasureScoringhttp://terminology.hl7.org/ValueSet/measure-scoring | |
Measure.scoringUnit | example | MeasureScoringUnithttp://hl7.org/fhir/ValueSet/measure-scoring-unit from the FHIR Standard | |
Measure.compositeScoring | extensible | CompositeMeasureScoringhttp://hl7.org/fhir/ValueSet/composite-measure-scoring from the FHIR Standard | |
Measure.type | extensible | MeasureTypehttp://hl7.org/fhir/ValueSet/measure-type from the FHIR Standard | |
Measure.improvementNotation | required | MeasureImprovementNotationhttp://hl7.org/fhir/ValueSet/measure-improvement-notation|5.0.0 from the FHIR Standard | |
Measure.term.code | example | MeasureDefinitionExamplehttp://hl7.org/fhir/ValueSet/measure-definition-example from the FHIR Standard | |
Measure.group.code | example | MeasureGroupExamplehttp://hl7.org/fhir/ValueSet/measure-group-example from the FHIR Standard | |
Measure.group.type | extensible | MeasureTypehttp://hl7.org/fhir/ValueSet/measure-type from the FHIR Standard | |
Measure.group.subject[x] | extensible | ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-types from the FHIR Standard | |
Measure.group.basis | required | FHIRTypeshttp://hl7.org/fhir/ValueSet/fhir-types|5.0.0 from the FHIR Standard | |
Measure.group.scoring | extensible | MeasureScoringhttp://terminology.hl7.org/ValueSet/measure-scoring | |
Measure.group.scoringUnit | example | MeasureScoringUnithttp://hl7.org/fhir/ValueSet/measure-scoring-unit from the FHIR Standard | |
Measure.group.improvementNotation | required | MeasureImprovementNotationhttp://hl7.org/fhir/ValueSet/measure-improvement-notation|5.0.0 from the FHIR Standard | |
Measure.group.population.code | extensible | MeasurePopulationTypehttp://hl7.org/fhir/ValueSet/measure-population from the FHIR Standard | |
Measure.group.population.aggregateMethod | extensible | MeasureAggregateMethodhttp://hl7.org/fhir/ValueSet/measure-aggregate-method from the FHIR Standard | |
Measure.group.stratifier.code | example | MeasureStratifierExamplehttp://hl7.org/fhir/ValueSet/measure-stratifier-example from the FHIR Standard | |
Measure.group.stratifier.component.code | example | MeasureStratifierExamplehttp://hl7.org/fhir/ValueSet/measure-stratifier-example from the FHIR Standard | |
Measure.supplementalData.code | example | MeasureSupplementalDataExamplehttp://hl7.org/fhir/ValueSet/measure-supplemental-data-example from the FHIR Standard | |
Measure.supplementalData.usage | extensible | MeasureDataUsagehttp://hl7.org/fhir/ValueSet/measure-data-usage from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Measure | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | Measure.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
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-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()) | |
mea-2 | warning | Measure.group.linkId | Link ids should be 255 characters or less : $this.length() <= 255 | |
mea-3 | warning | Measure.group.population.linkId | Link ids should be 255 characters or less : $this.length() <= 255 | |
mea-4 | warning | Measure.group.stratifier.linkId | Link ids should be 255 characters or less : $this.length() <= 255 | |
mea-5 | warning | Measure.group.stratifier.component.linkId | Link ids should be 255 characters or less : $this.length() <= 255 | |
mea-6 | warning | Measure.supplementalData.linkId | Link ids should be 255 characters or less : $this.length() <= 255 |
This structure is derived from Measure
Differential View
This structure is derived from Measure
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Measure | A quality measure definition | |
![]() ![]() ![]() |
1..1 | string | Business version of the measure | |
![]() ![]() ![]() |
1..1 | string | Name for this measure (computer friendly) | |
![]() ![]() ![]() |
1..1 | string | Name for this measure (human friendly) | |
![]() ![]() ![]() |
1..1 | string | Name of the publisher/steward (organization or individual) | |
![]() ![]() ![]() |
1..1 | markdown | Natural language description of the measure | |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Measure | A quality measure definition cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation mea-1: Stratifier SHALL be either a single criteria or a set of criteria components |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | string | Business version of the measure |
![]() ![]() ![]() |
ΣC | 1..1 | string | Name for this measure (computer friendly) |
![]() ![]() ![]() |
Σ | 1..1 | string | Name for this measure (human friendly) |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
Σ | 1..1 | string | Name of the publisher/steward (organization or individual) |
![]() ![]() ![]() |
Σ | 1..1 | markdown | Natural language description of the measure |
![]() |
Path | Conformance | ValueSet | URI |
Measure.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Measure | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
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-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()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Measure | A quality measure definition cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation mea-1: Stratifier SHALL be either a single criteria or a set of criteria components | ||||
![]() ![]() ![]() |
Σ | 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: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
ΣC | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the measure | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Business version of the measure | ||||
![]() ![]() ![]() |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() |
ΣC | 1..1 | string | Name for this measure (computer friendly) | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Name for this measure (human friendly) | ||||
![]() ![]() ![]() |
0..1 | string | Subordinate title of the measure | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown 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: ParticipantResourceTypes (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
Σ | 0..1 | code | Population basis Binding: FHIRTypes (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Name of the publisher/steward (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
Σ | 1..1 | markdown | Natural language description of the measure | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this measure is defined | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the clinical usage of the measure | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) | |||||
![]() ![]() ![]() |
0..1 | date | When the measure was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the measure was last reviewed by the publisher | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the measure is expected to be used | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | The category of the measure, such as Education, Treatment, Assessment, etc 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 | |||||
![]() ![]() ![]() |
0..* | canonical(Library) | Logic used by the measure | |||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible): The scoring type of the measure. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What units? Binding: MeasureScoringUnit (example) | ||||
![]() ![]() ![]() |
Σ | 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 | markdown | How risk adjustment is applied for this measure | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | 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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Defined terms used in the measure documentation | |||||
![]() ![]() ![]() ![]() |
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 | What term? Binding: MeasureDefinitionExample (example): Codeable representations of measure definition terms. | |||||
![]() ![]() ![]() ![]() |
0..1 | markdown | Meaning of the term | |||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Additional guidance for implementers (deprecated) | ||||
![]() ![]() ![]() |
C | 0..* | 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 | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Unique id for group in measure mea-2: Link ids should be 255 characters or less | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the group Binding: MeasureGroupExample (example): Example of measure groups. | |||||
![]() ![]() ![]() ![]() |
0..1 | markdown | Summary description | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | process | outcome | structure | patient-reported-outcome | composite Binding: MeasureType (extensible) | ||||
![]() ![]() ![]() ![]() |
0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Population basis Binding: FHIRTypes (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What units? Binding: MeasureScoringUnit (example) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | markdown | How is rate aggregation performed for this measure | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | increase | decrease Binding: MeasureImprovementNotation (required) | ||||
![]() ![]() ![]() ![]() |
0..* | canonical(Library) | Logic used by the measure group | |||||
![]() ![]() ![]() ![]() |
0..* | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Unique id for population in measure mea-3: Link ids should be 255 characters or less | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation Binding: MeasurePopulationType (extensible): The type of population. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | markdown | The human readable description of this population criteria | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Expression | The criteria that defines this population | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Group) | A group resource that defines this population | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Which population | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count) Binding: MeasureAggregateMethod (extensible) | |||||
![]() ![]() ![]() ![]() |
C | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Unique id for stratifier in measure mea-4: Link ids should be 255 characters or less | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Meaning of the stratifier Binding: MeasureStratifierExample (example): Meaning of the stratifier. | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | markdown | The human readable description of this stratifier | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Expression | How the measure should be stratified | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Group) | A group resource that defines this population | |||||
![]() ![]() ![]() ![]() ![]() |
C | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Unique id for stratifier component in measure mea-5: Link ids should be 255 characters or less | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the stratifier component Binding: MeasureStratifierExample (example): Meaning of the stratifier. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | markdown | The human readable description of this stratifier component | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Expression | Component of how the measure should be stratified | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Group) | A group resource that defines this population | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Unique id for supplementalData in measure mea-6: Link ids should be 255 characters or less | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureSupplementalDataExample (example): 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 | markdown | The human readable description of this supplemental data | |||||
![]() ![]() ![]() ![]() |
1..1 | Expression | Expression describing additional data to be reported | |||||
![]() |
Path | Conformance | ValueSet | URI |
Measure.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Measure.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
Measure.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
Measure.subject[x] | extensible | ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-types from the FHIR Standard | |
Measure.basis | required | FHIRTypeshttp://hl7.org/fhir/ValueSet/fhir-types|5.0.0 from the FHIR Standard | |
Measure.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
Measure.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | |
Measure.scoring | extensible | MeasureScoringhttp://terminology.hl7.org/ValueSet/measure-scoring | |
Measure.scoringUnit | example | MeasureScoringUnithttp://hl7.org/fhir/ValueSet/measure-scoring-unit from the FHIR Standard | |
Measure.compositeScoring | extensible | CompositeMeasureScoringhttp://hl7.org/fhir/ValueSet/composite-measure-scoring from the FHIR Standard | |
Measure.type | extensible | MeasureTypehttp://hl7.org/fhir/ValueSet/measure-type from the FHIR Standard | |
Measure.improvementNotation | required | MeasureImprovementNotationhttp://hl7.org/fhir/ValueSet/measure-improvement-notation|5.0.0 from the FHIR Standard | |
Measure.term.code | example | MeasureDefinitionExamplehttp://hl7.org/fhir/ValueSet/measure-definition-example from the FHIR Standard | |
Measure.group.code | example | MeasureGroupExamplehttp://hl7.org/fhir/ValueSet/measure-group-example from the FHIR Standard | |
Measure.group.type | extensible | MeasureTypehttp://hl7.org/fhir/ValueSet/measure-type from the FHIR Standard | |
Measure.group.subject[x] | extensible | ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-types from the FHIR Standard | |
Measure.group.basis | required | FHIRTypeshttp://hl7.org/fhir/ValueSet/fhir-types|5.0.0 from the FHIR Standard | |
Measure.group.scoring | extensible | MeasureScoringhttp://terminology.hl7.org/ValueSet/measure-scoring | |
Measure.group.scoringUnit | example | MeasureScoringUnithttp://hl7.org/fhir/ValueSet/measure-scoring-unit from the FHIR Standard | |
Measure.group.improvementNotation | required | MeasureImprovementNotationhttp://hl7.org/fhir/ValueSet/measure-improvement-notation|5.0.0 from the FHIR Standard | |
Measure.group.population.code | extensible | MeasurePopulationTypehttp://hl7.org/fhir/ValueSet/measure-population from the FHIR Standard | |
Measure.group.population.aggregateMethod | extensible | MeasureAggregateMethodhttp://hl7.org/fhir/ValueSet/measure-aggregate-method from the FHIR Standard | |
Measure.group.stratifier.code | example | MeasureStratifierExamplehttp://hl7.org/fhir/ValueSet/measure-stratifier-example from the FHIR Standard | |
Measure.group.stratifier.component.code | example | MeasureStratifierExamplehttp://hl7.org/fhir/ValueSet/measure-stratifier-example from the FHIR Standard | |
Measure.supplementalData.code | example | MeasureSupplementalDataExamplehttp://hl7.org/fhir/ValueSet/measure-supplemental-data-example from the FHIR Standard | |
Measure.supplementalData.usage | extensible | MeasureDataUsagehttp://hl7.org/fhir/ValueSet/measure-data-usage from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | Measure | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | Measure.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
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-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()) | |
mea-2 | warning | Measure.group.linkId | Link ids should be 255 characters or less : $this.length() <= 255 | |
mea-3 | warning | Measure.group.population.linkId | Link ids should be 255 characters or less : $this.length() <= 255 | |
mea-4 | warning | Measure.group.stratifier.linkId | Link ids should be 255 characters or less : $this.length() <= 255 | |
mea-5 | warning | Measure.group.stratifier.component.linkId | Link ids should be 255 characters or less : $this.length() <= 255 | |
mea-6 | warning | Measure.supplementalData.linkId | Link ids should be 255 characters or less : $this.length() <= 255 |
This structure is derived from Measure
Cannot invoke "Object.hashCode()" because "key" is null
Other representations of profile: CSV, Excel, Schematron