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

Resource Profile: SGMeasure

Official URL: http://smart.who.int/base/StructureDefinition/SGMeasure Version: 0.1.1
Draft as of 2024-06-12 Computable Name: SGMeasure

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Measure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure 0..* Measure A quality measure definition
... version 1..1 string Business version of the measure
... name 1..1 string Name for this measure (computer friendly)
... title 1..1 string Name for this measure (human friendly)
... description 1..1 markdown Natural language description of the measure

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... name ΣC 1..1 string Name for this measure (computer friendly)
... title Σ 1..1 string Name for this measure (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... publisher Σ 1..1 string Name of the publisher/steward (organization or individual)
... description Σ 1..1 markdown Natural language description of the measure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Measure.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningMeasureName 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mea-1errorMeasureStratifier SHALL be either a single criteria or a set of criteria components
: group.stratifier.all((code | description | criteria).exists() xor component.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure 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
... 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url Σ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
... identifier Σ 0..* Identifier Additional identifier for the measure
... version Σ 1..1 string Business version of the measure
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this measure (computer friendly)
... title Σ 1..1 string Name for this measure (human friendly)
... subtitle 0..1 string Subordinate title of the measure
... status ?!Σ 1..1 code draft | active | retired | unknown
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: ParticipantResourceTypes (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... basis Σ 0..1 code Population basis
Binding: FHIRTypes (required)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 1..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 1..1 markdown Natural language description of the measure
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for measure (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this measure is defined
... usage 0..1 markdown Describes the clinical usage of the measure
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the measure was approved by publisher
... lastReviewDate 0..1 date When the measure was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the measure is expected to be used
... topic 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.


... 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 0..* canonical(Library) Logic used by the measure
... disclaimer Σ 0..1 markdown Disclaimer for use of the measure or its referenced content
... scoring Σ 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible): The scoring type of the measure.

... scoringUnit Σ 0..1 CodeableConcept What units?
Binding: MeasureScoringUnit (example)
... 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 markdown How risk adjustment is applied for this measure
... rateAggregation Σ 0..1 markdown 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 Σ 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.

... term 0..* BackboneElement Defined terms used in the measure documentation
.... 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 What term?
Binding: MeasureDefinitionExample (example): Codeable representations of measure definition terms.

.... definition 0..1 markdown Meaning of the term
... guidance Σ 0..1 markdown Additional guidance for implementers (deprecated)
... group C 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
.... linkId C 0..1 string Unique id for group in measure
mea-2: Link ids should be 255 characters or less
.... code 0..1 CodeableConcept Meaning of the group
Binding: MeasureGroupExample (example): Example of measure groups.

.... description 0..1 markdown Summary description
.... type Σ 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType (extensible)
.... subject[x] 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.).

..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference(Group)
.... basis Σ 0..1 code Population basis
Binding: FHIRTypes (required)
.... scoring Σ 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible)
.... scoringUnit Σ 0..1 CodeableConcept What units?
Binding: MeasureScoringUnit (example)
.... rateAggregation Σ 0..1 markdown How is rate aggregation performed for this measure
.... improvementNotation Σ 0..1 CodeableConcept increase | decrease
Binding: MeasureImprovementNotation (required)
.... library 0..* canonical(Library) Logic used by the measure group
.... population 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
..... linkId C 0..1 string Unique id for population in measure
mea-3: Link ids should be 255 characters or less
..... code 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: MeasurePopulationType (extensible): The type of population.

..... description 0..1 markdown The human readable description of this population criteria
..... criteria 0..1 Expression The criteria that defines this population
..... groupDefinition 0..1 Reference(Group) A group resource that defines this population
..... inputPopulationId 0..1 string Which population
..... aggregateMethod 0..1 CodeableConcept Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count)
Binding: MeasureAggregateMethod (extensible)
.... stratifier C 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
..... linkId C 0..1 string Unique id for stratifier in measure
mea-4: Link ids should be 255 characters or less
..... code C 0..1 CodeableConcept Meaning of the stratifier
Binding: MeasureStratifierExample (example): Meaning of the stratifier.

..... description C 0..1 markdown The human readable description of this stratifier
..... criteria C 0..1 Expression How the measure should be stratified
..... groupDefinition 0..1 Reference(Group) A group resource that defines this population
..... component C 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
...... linkId C 0..1 string Unique id for stratifier component in measure
mea-5: Link ids should be 255 characters or less
...... code 0..1 CodeableConcept Meaning of the stratifier component
Binding: MeasureStratifierExample (example): Meaning of the stratifier.

...... description 0..1 markdown The human readable description of this stratifier component
...... criteria 0..1 Expression Component of how the measure should be stratified
...... groupDefinition 0..1 Reference(Group) A group resource that defines this population
... 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
.... linkId C 0..1 string Unique id for supplementalData in measure
mea-6: Link ids should be 255 characters or less
.... code 0..1 CodeableConcept Meaning of the supplemental data
Binding: MeasureSupplementalDataExample (example): 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 markdown 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

PathConformanceValueSetURI
Measure.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Measure.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
Measure.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Measure.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
Measure.basisrequiredFHIRTypes
http://hl7.org/fhir/ValueSet/fhir-types|5.0.0
from the FHIR Standard
Measure.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Measure.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
Measure.scoringextensibleMeasureScoring
http://terminology.hl7.org/ValueSet/measure-scoring
Measure.scoringUnitexampleMeasureScoringUnit
http://hl7.org/fhir/ValueSet/measure-scoring-unit
from the FHIR Standard
Measure.compositeScoringextensibleCompositeMeasureScoring
http://hl7.org/fhir/ValueSet/composite-measure-scoring
from the FHIR Standard
Measure.typeextensibleMeasureType
http://hl7.org/fhir/ValueSet/measure-type
from the FHIR Standard
Measure.improvementNotationrequiredMeasureImprovementNotation
http://hl7.org/fhir/ValueSet/measure-improvement-notation|5.0.0
from the FHIR Standard
Measure.term.codeexampleMeasureDefinitionExample
http://hl7.org/fhir/ValueSet/measure-definition-example
from the FHIR Standard
Measure.group.codeexampleMeasureGroupExample
http://hl7.org/fhir/ValueSet/measure-group-example
from the FHIR Standard
Measure.group.typeextensibleMeasureType
http://hl7.org/fhir/ValueSet/measure-type
from the FHIR Standard
Measure.group.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
Measure.group.basisrequiredFHIRTypes
http://hl7.org/fhir/ValueSet/fhir-types|5.0.0
from the FHIR Standard
Measure.group.scoringextensibleMeasureScoring
http://terminology.hl7.org/ValueSet/measure-scoring
Measure.group.scoringUnitexampleMeasureScoringUnit
http://hl7.org/fhir/ValueSet/measure-scoring-unit
from the FHIR Standard
Measure.group.improvementNotationrequiredMeasureImprovementNotation
http://hl7.org/fhir/ValueSet/measure-improvement-notation|5.0.0
from the FHIR Standard
Measure.group.population.codeextensibleMeasurePopulationType
http://hl7.org/fhir/ValueSet/measure-population
from the FHIR Standard
Measure.group.population.aggregateMethodextensibleMeasureAggregateMethod
http://hl7.org/fhir/ValueSet/measure-aggregate-method
from the FHIR Standard
Measure.group.stratifier.codeexampleMeasureStratifierExample
http://hl7.org/fhir/ValueSet/measure-stratifier-example
from the FHIR Standard
Measure.group.stratifier.component.codeexampleMeasureStratifierExample
http://hl7.org/fhir/ValueSet/measure-stratifier-example
from the FHIR Standard
Measure.supplementalData.codeexampleMeasureSupplementalDataExample
http://hl7.org/fhir/ValueSet/measure-supplemental-data-example
from the FHIR Standard
Measure.supplementalData.usageextensibleMeasureDataUsage
http://hl7.org/fhir/ValueSet/measure-data-usage
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningMeasureName 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-1warningMeasure.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mea-1errorMeasureStratifier SHALL be either a single criteria or a set of criteria components
: group.stratifier.all((code | description | criteria).exists() xor component.exists())
mea-2warningMeasure.group.linkIdLink ids should be 255 characters or less
: $this.length() <= 255
mea-3warningMeasure.group.population.linkIdLink ids should be 255 characters or less
: $this.length() <= 255
mea-4warningMeasure.group.stratifier.linkIdLink ids should be 255 characters or less
: $this.length() <= 255
mea-5warningMeasure.group.stratifier.component.linkIdLink ids should be 255 characters or less
: $this.length() <= 255
mea-6warningMeasure.supplementalData.linkIdLink ids should be 255 characters or less
: $this.length() <= 255

This structure is derived from Measure

Cannot invoke "Object.hashCode()" because "key" is null

Differential View

This structure is derived from Measure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure 0..* Measure A quality measure definition
... version 1..1 string Business version of the measure
... name 1..1 string Name for this measure (computer friendly)
... title 1..1 string Name for this measure (human friendly)
... description 1..1 markdown Natural language description of the measure

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... name ΣC 1..1 string Name for this measure (computer friendly)
... title Σ 1..1 string Name for this measure (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... publisher Σ 1..1 string Name of the publisher/steward (organization or individual)
... description Σ 1..1 markdown Natural language description of the measure

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Measure.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningMeasureName 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mea-1errorMeasureStratifier SHALL be either a single criteria or a set of criteria components
: group.stratifier.all((code | description | criteria).exists() xor component.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure 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
... 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url Σ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
... identifier Σ 0..* Identifier Additional identifier for the measure
... version Σ 1..1 string Business version of the measure
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this measure (computer friendly)
... title Σ 1..1 string Name for this measure (human friendly)
... subtitle 0..1 string Subordinate title of the measure
... status ?!Σ 1..1 code draft | active | retired | unknown
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: ParticipantResourceTypes (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... basis Σ 0..1 code Population basis
Binding: FHIRTypes (required)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 1..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 1..1 markdown Natural language description of the measure
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for measure (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this measure is defined
... usage 0..1 markdown Describes the clinical usage of the measure
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the measure was approved by publisher
... lastReviewDate 0..1 date When the measure was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the measure is expected to be used
... topic 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.


... 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 0..* canonical(Library) Logic used by the measure
... disclaimer Σ 0..1 markdown Disclaimer for use of the measure or its referenced content
... scoring Σ 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible): The scoring type of the measure.

... scoringUnit Σ 0..1 CodeableConcept What units?
Binding: MeasureScoringUnit (example)
... 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 markdown How risk adjustment is applied for this measure
... rateAggregation Σ 0..1 markdown 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 Σ 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.

... term 0..* BackboneElement Defined terms used in the measure documentation
.... 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 What term?
Binding: MeasureDefinitionExample (example): Codeable representations of measure definition terms.

.... definition 0..1 markdown Meaning of the term
... guidance Σ 0..1 markdown Additional guidance for implementers (deprecated)
... group C 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
.... linkId C 0..1 string Unique id for group in measure
mea-2: Link ids should be 255 characters or less
.... code 0..1 CodeableConcept Meaning of the group
Binding: MeasureGroupExample (example): Example of measure groups.

.... description 0..1 markdown Summary description
.... type Σ 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType (extensible)
.... subject[x] 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.).

..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference(Group)
.... basis Σ 0..1 code Population basis
Binding: FHIRTypes (required)
.... scoring Σ 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible)
.... scoringUnit Σ 0..1 CodeableConcept What units?
Binding: MeasureScoringUnit (example)
.... rateAggregation Σ 0..1 markdown How is rate aggregation performed for this measure
.... improvementNotation Σ 0..1 CodeableConcept increase | decrease
Binding: MeasureImprovementNotation (required)
.... library 0..* canonical(Library) Logic used by the measure group
.... population 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
..... linkId C 0..1 string Unique id for population in measure
mea-3: Link ids should be 255 characters or less
..... code 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: MeasurePopulationType (extensible): The type of population.

..... description 0..1 markdown The human readable description of this population criteria
..... criteria 0..1 Expression The criteria that defines this population
..... groupDefinition 0..1 Reference(Group) A group resource that defines this population
..... inputPopulationId 0..1 string Which population
..... aggregateMethod 0..1 CodeableConcept Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count)
Binding: MeasureAggregateMethod (extensible)
.... stratifier C 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
..... linkId C 0..1 string Unique id for stratifier in measure
mea-4: Link ids should be 255 characters or less
..... code C 0..1 CodeableConcept Meaning of the stratifier
Binding: MeasureStratifierExample (example): Meaning of the stratifier.

..... description C 0..1 markdown The human readable description of this stratifier
..... criteria C 0..1 Expression How the measure should be stratified
..... groupDefinition 0..1 Reference(Group) A group resource that defines this population
..... component C 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
...... linkId C 0..1 string Unique id for stratifier component in measure
mea-5: Link ids should be 255 characters or less
...... code 0..1 CodeableConcept Meaning of the stratifier component
Binding: MeasureStratifierExample (example): Meaning of the stratifier.

...... description 0..1 markdown The human readable description of this stratifier component
...... criteria 0..1 Expression Component of how the measure should be stratified
...... groupDefinition 0..1 Reference(Group) A group resource that defines this population
... 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
.... linkId C 0..1 string Unique id for supplementalData in measure
mea-6: Link ids should be 255 characters or less
.... code 0..1 CodeableConcept Meaning of the supplemental data
Binding: MeasureSupplementalDataExample (example): 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 markdown 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

PathConformanceValueSetURI
Measure.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Measure.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
Measure.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Measure.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
Measure.basisrequiredFHIRTypes
http://hl7.org/fhir/ValueSet/fhir-types|5.0.0
from the FHIR Standard
Measure.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Measure.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
Measure.scoringextensibleMeasureScoring
http://terminology.hl7.org/ValueSet/measure-scoring
Measure.scoringUnitexampleMeasureScoringUnit
http://hl7.org/fhir/ValueSet/measure-scoring-unit
from the FHIR Standard
Measure.compositeScoringextensibleCompositeMeasureScoring
http://hl7.org/fhir/ValueSet/composite-measure-scoring
from the FHIR Standard
Measure.typeextensibleMeasureType
http://hl7.org/fhir/ValueSet/measure-type
from the FHIR Standard
Measure.improvementNotationrequiredMeasureImprovementNotation
http://hl7.org/fhir/ValueSet/measure-improvement-notation|5.0.0
from the FHIR Standard
Measure.term.codeexampleMeasureDefinitionExample
http://hl7.org/fhir/ValueSet/measure-definition-example
from the FHIR Standard
Measure.group.codeexampleMeasureGroupExample
http://hl7.org/fhir/ValueSet/measure-group-example
from the FHIR Standard
Measure.group.typeextensibleMeasureType
http://hl7.org/fhir/ValueSet/measure-type
from the FHIR Standard
Measure.group.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
Measure.group.basisrequiredFHIRTypes
http://hl7.org/fhir/ValueSet/fhir-types|5.0.0
from the FHIR Standard
Measure.group.scoringextensibleMeasureScoring
http://terminology.hl7.org/ValueSet/measure-scoring
Measure.group.scoringUnitexampleMeasureScoringUnit
http://hl7.org/fhir/ValueSet/measure-scoring-unit
from the FHIR Standard
Measure.group.improvementNotationrequiredMeasureImprovementNotation
http://hl7.org/fhir/ValueSet/measure-improvement-notation|5.0.0
from the FHIR Standard
Measure.group.population.codeextensibleMeasurePopulationType
http://hl7.org/fhir/ValueSet/measure-population
from the FHIR Standard
Measure.group.population.aggregateMethodextensibleMeasureAggregateMethod
http://hl7.org/fhir/ValueSet/measure-aggregate-method
from the FHIR Standard
Measure.group.stratifier.codeexampleMeasureStratifierExample
http://hl7.org/fhir/ValueSet/measure-stratifier-example
from the FHIR Standard
Measure.group.stratifier.component.codeexampleMeasureStratifierExample
http://hl7.org/fhir/ValueSet/measure-stratifier-example
from the FHIR Standard
Measure.supplementalData.codeexampleMeasureSupplementalDataExample
http://hl7.org/fhir/ValueSet/measure-supplemental-data-example
from the FHIR Standard
Measure.supplementalData.usageextensibleMeasureDataUsage
http://hl7.org/fhir/ValueSet/measure-data-usage
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningMeasureName 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-1warningMeasure.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mea-1errorMeasureStratifier SHALL be either a single criteria or a set of criteria components
: group.stratifier.all((code | description | criteria).exists() xor component.exists())
mea-2warningMeasure.group.linkIdLink ids should be 255 characters or less
: $this.length() <= 255
mea-3warningMeasure.group.population.linkIdLink ids should be 255 characters or less
: $this.length() <= 255
mea-4warningMeasure.group.stratifier.linkIdLink ids should be 255 characters or less
: $this.length() <= 255
mea-5warningMeasure.group.stratifier.component.linkIdLink ids should be 255 characters or less
: $this.length() <= 255
mea-6warningMeasure.supplementalData.linkIdLink 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