This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0:
R5
-
STU
).
The
This
is
the
current
published
version
which
supercedes
in
it's
permanent
home
(it
will
always
be
available
at
this
version
is
5.0.0
.
URL).
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R5
R4B
R4
Clinical
Quality
Information
Work
Group
|
Maturity Level : 0 | Trial Use | Use Context : Any |
The
official
canonical
URL
for
this
profile
is:
http://hl7.org/fhir/StructureDefinition/shareablemeasure
Enforces the minimum information set for the measure metadata required by HL7 and other organizations that share and publish measures
Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management
implementation guide as part of the next FHIR release. Implementers are encouraged to look there for updates, corrections and clarifications.
This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from Measure .
Summary
Mandatory:
6
4
elements
Must-Support:
6
11
elements
Extensions
This structure refers to these extensions:
This
structure
is
derived
from
indicates
the
differences
between
this
profile
and
the
base
Measure
.
structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | Measure | A quality measure definition | |
|
S |
|
|
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability ( required ) |
|
S |
|
|
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
|
S |
|
|
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
|
S | 1..1 |
|
|
|
S |
|
string |
|
|
S |
|
|
|
|
S |
|
|
|
|
S | 1..1 | string |
Name
|
|
S |
0
..
|
|
|
|
|
0
..
|
|
|
|
S | 1..1 |
|
|
Documentation
for
this
format
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Measure structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
|
1..1 | Measure |
A
quality
measure
definition
|
|
Σ | 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: |
|
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |
|
0..* | Resource |
Contained,
inline
Resources
|
|
|
0..* | Extension |
Slice: Unordered, Open by |
|
| S | 0..* | code |
shareable
|
computable
|
publishable
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability ( required ) |
![]() ![]() | S | 0..* | code |
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
![]() ![]() | S | 0..* | (Complex) |
Additional
documentation,
review,
or
usage
guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
![]() ![]() |
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
|
S
Σ
C
|
1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
|
Σ | 0..* | Identifier |
Additional
identifier
for
the
measure
|
|
S Σ | 1..1 | string | Business version of the measure |
| S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) | |
![]() ![]() ![]() | string | |||
![]() ![]() ![]() | Coding | |||
|
S
Σ
|
|
string | Name for this measure (computer friendly) |
|
S Σ |
|
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. |
|
S Σ |
|
boolean | For testing purposes, not real usage |
|
0..1 |
E.g.
Patient,
Practitioner,
RelatedPerson,
Organization,
Location,
Device
Binding: |
||
|
CodeableConcept | |||
|
Reference ( Group ) | |||
|
|
0..1 | code |
Population
basis
Binding: All FHIR Types ( required ) |
![]() ![]() | Σ | 0..1 | dateTime | Date last changed |
|
S Σ | 0..1 | string |
Name
of
the
|
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
S Σ | 1..1 | markdown | Natural language description of the measure |
|
Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
Σ XD | 0..* | CodeableConcept |
Intended
jurisdiction
for
measure
(if
applicable)
Binding: Jurisdiction ValueSet ( extensible ): Countries and regions within which this artifact is targeted for use. |
|
0..1 | markdown | Why this measure is defined | |
|
0..1 |
|
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 |
|
XD | 0..* | CodeableConcept |
The
category
of
the
measure,
such
as
Education,
Treatment,
Assessment,
Binding: |
|
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,
|
|
|
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: Measure Scoring Unit ( example ) |
![]() ![]() | Σ | 0..1 | CodeableConcept |
opportunity
|
all-or-nothing
|
linear
|
weighted
Binding: |
|
Σ | 0..* | CodeableConcept |
process
|
outcome
|
structure
|
patient-reported-outcome
|
composite
Binding: |
|
Σ | 0..1 |
|
How risk adjustment is applied for this measure |
|
Σ | 0..1 |
|
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: |
| 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..* |
|
|
![]() ![]() ![]() | 0..1 | CodeableConcept |
What
term?
Binding: Measure Definition Example ( example ): Codeable representations of measure |
|
| 0..1 | markdown | Meaning of the term | |
|
Σ XD | 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 |
![]() ![]() ![]() | 0..1 | CodeableConcept |
Meaning
of
the
group
Binding: |
|
|
0..1 | markdown | Summary description | |
![]() ![]() ![]() |
Σ |
|
|
Binding: Measure Type ( extensible ) |
| 0..1 |
E.g.
Patient,
Practitioner,
RelatedPerson,
Organization,
Location,
Device
Binding: Participant Resource Types ( 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: All FHIR Types ( required ) |
![]() ![]()
|
Σ |
|
|
Binding: MeasureScoring
(
extensible
)
|
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept |
What
units?
Binding: Measure Scoring Unit ( example ) |
| Σ | 0..1 | markdown | How is rate aggregation performed for this measure |
|
Σ | 0..1 | CodeableConcept |
increase
|
decrease
Binding: Measure Improvement Notation ( 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 |
|
0..1 | CodeableConcept |
initial-population
|
numerator
|
numerator-exclusion
|
denominator
|
denominator-exclusion
|
denominator-exception
|
measure-population
|
measure-population-exclusion
|
measure-observation
Binding: |
|
|
0..1 |
|
The human readable description of this population criteria | |
|
|
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: Measure Aggregate Method ( 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 |
|
C
|
0..1 | CodeableConcept |
Meaning
of
the
stratifier
Binding: |
|
C
|
0..1 |
|
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 |
|
0..1 | CodeableConcept |
Meaning
of
the
stratifier
component
Binding: |
|
|
0..1 |
|
The human readable description of this stratifier component | |
|
|
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 |
|
0..1 | CodeableConcept |
Meaning
of
the
supplemental
data
Binding: |
|
|
0..* | CodeableConcept |
supplemental-data
|
risk-adjustment-factor
Binding: |
|
|
0..1 |
|
The human readable description of this supplemental data | |
|
1..1 | Expression | Expression describing additional data to be reported | |
Documentation
for
this
format
|
||||
<!-- Shareable Measure --><!-- ShareableMeasure --><Measure xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
<</meta> < < <<meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text><</contained> <<a href="shareablemeasure-definitions.html#Measure.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<contained><!-- 0..* Resource Contained, inline Resources --></contained> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> < <</identifier> < < < < < < <</subject[x]> < < <</contact> < < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this measure, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the measure --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the measure --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this measure (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this measure (human friendly) --> <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the measure --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage --> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]> <basis value="[code]"/><!-- I 0..1 Population basis --> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the measure --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext><</jurisdiction> < < < < < <<jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for measure (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this measure is defined --> <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the measure --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the measure was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the measure was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the measure is expected to be used --></effectivePeriod><</topic> <</author> <</editor> <</reviewer> <</endorser> < Additional documentation, citations, etc.</relatedArtifact> < < <</scoring> <</compositeScoring> <</type> < < < < <</improvementNotation> < < < <<a href="shareablemeasure-definitions.html#Measure.group.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<topic><!-- I 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the content --></author> <editor><!-- I 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <library value="[canonical]"/><!-- I 0..* Logic used by the measure --> <disclaimer value="[markdown]"/><!-- I 0..1 Disclaimer for use of the measure or its referenced content --> <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort--></scoring> <scoringUnit><!-- I 0..1 CodeableConcept What units? --></scoringUnit> <compositeScoring><!-- I 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted --></compositeScoring> <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <riskAdjustment value="[markdown]"/><!-- I 0..1 How risk adjustment is applied for this measure --> <rateAggregation value="[markdown]"/><!-- I 0..1 How is rate aggregation performed for this measure --> <rationale value="[markdown]"/><!-- I 0..1 Detailed description of why the measure exists --> <clinicalRecommendationStatement value="[markdown]"/><!-- I 0..1 Summary of clinical guidelines --> <improvementNotation><!-- I 0..1 CodeableConcept increase | decrease --></improvementNotation> <term> I 0..* BackboneElement <!-- I 0..* Defined terms used in the measure documentation --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> < < <<a href="shareablemeasure-definitions.html#Measure.group.population.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept What term? --></code> <definition value="[markdown]"/><!-- I 0..1 Meaning of the term --> </term> <guidance value="[markdown]"/><!-- I 0..1 Additional guidance for implementers (deprecated) --> <group> I 0..* BackboneElement <!-- I 0..* Population criteria group --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> < < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- I 0..1 Unique id for group in measure --> <code><!-- I 0..1 CodeableConcept Meaning of the group --></code> <description value="[markdown]"/><!-- I 0..1 Summary description --> <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]> <basis value="[code]"/><!-- I 0..1 Population basis --> <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort
--></scoring> <scoringUnit><!-- I 0..1 CodeableConcept What units? --></scoringUnit> <rateAggregation value="[markdown]"/><!-- I 0..1 How is rate aggregation performed for this measure --> <improvementNotation><!-- I 0..1 CodeableConcept increase | decrease --></improvementNotation> <library value="[canonical]"/><!-- I 0..* Logic used by the measure group --> <population> I 0..* BackboneElement <!-- I 0..* Population criteria --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- I 0..1 Unique id for population in measure --> <code><!-- I 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <description value="[markdown]"/><!-- I 0..1 The human readable description of this population criteria --> <criteria><!-- I 0..1 Expression The criteria that defines this population --></criteria> <groupDefinition><!-- I 0..1 Reference(Group) A group resource that defines this population --></groupDefinition> <inputPopulationId value="[string]"/><!-- I 0..1 Which population --> <aggregateMethod><!-- I 0..1 CodeableConcept Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count) --></aggregateMethod> </population>
< <<a href="shareablemeasure-definitions.html#Measure.group.stratifier.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<stratifier> I 0..* BackboneElement <!-- I 0..* Stratifier criteria for the measure --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> < < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- I 0..1 Unique id for stratifier in measure --> <code><!-- I 0..1 CodeableConcept Meaning of the stratifier --></code> <description value="[markdown]"/><!-- I 0..1 The human readable description of this stratifier --> <criteria><!-- I 0..1 Expression How the measure should be stratified --></criteria>< <<a href="shareablemeasure-definitions.html#Measure.group.stratifier.component.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<groupDefinition><!-- I 0..1 Reference(Group) A group resource that defines this population --></groupDefinition> <component> I 0..* BackboneElement <!-- I 0..* Stratifier criteria component for the measure --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- I 0..1 Unique id for stratifier component in measure --> <code><!-- I 0..1 CodeableConcept Meaning of the stratifier component --></code> <description value="[markdown]"/><!-- I 0..1 The human readable description of this stratifier component --><<criteria><!-- I 0..1 Expression Component of how the measure should be stratified --></criteria> <groupDefinition><!-- I 0..1 Reference(Group) A group resource that defines this population --></groupDefinition> </component> </stratifier> </group>< <<a href="shareablemeasure-definitions.html#Measure.supplementalData.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<supplementalData> I 0..* BackboneElement <!-- I 0..* What other data should be reported with the measure --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> <</usage> < < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- I 0..1 Unique id for supplementalData in measure --> <code><!-- I 0..1 CodeableConcept Meaning of the supplemental data --></code> <usage><!-- I 0..* CodeableConcept supplemental-data | risk-adjustment-factor --></usage> <description value="[markdown]"/><!-- I 0..1 The human readable description of this supplemental data --> <criteria><!-- I 1..1 Expression Expression describing additional data to be reported --></criteria> </supplementalData> </Measure>
{ //{ // ShareableMeasure // from Element: extension" " " " " "<a href="shareablemeasure-definitions.html#Measure.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."meta" : { Meta }, // IMetadata about the resource "implicitRules" : "<uri>", // IA set of rules under which this content was created "language" : "<code>", // ILanguage of the resource content "text" : { Narrative }, // IText summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "extension" : [ // sliced by value:url in the specified order, Open { // shareable | computable | publishable | executable // I // from Element: extension }, { // narrative | semi-structured | structured | executable // I // from Element: extension }, { // Additional documentation, review, or usage guidance // I // from Element: extension } ], "Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"> " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored "url" : "<uri>", // I R! Canonical identifier for this measure, represented as a URI (globally unique) "identifier" : [{ Identifier }], // IAdditional identifier for the measure "version" : "<string>", // I R! Business version of the measure // value[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", // IHow to compare versions "versionAlgorithmCoding" : { Coding }, // IHow to compare versions "name" : "<string>", // IName for this measure (computer friendly) "title" : "<string>", // I R! Name for this measure (human friendly) "subtitle" : "<string>", // ISubordinate title of the measure "status" : "<code>", // I R! draft | active | retired | unknown "experimental" : <boolean>, // IFor testing purposes, not real usage // value[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2: "subjectCodeableConcept" : { CodeableConcept }, // IE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device "subjectReference" : { Reference(Group) }, // IE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device "basis" : "<code>", // IPopulation basis "date" : "<dateTime>", // IDate last changed "publisher" : "<string>", // IName of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // IContact details for the publisher "description" : "<markdown>", // I R! Natural language description of the measure "useContext" : [{ UsageContext }], // IThe context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for measure (if applicable) "purpose" : "<markdown>", // IWhy this measure is defined "usage" : "<markdown>", // IDescribes the clinical usage of the measure "copyright" : "<markdown>", // IUse and/or publishing restrictions "copyrightLabel" : "<string>", // ICopyright holder and year(s) "approvalDate" : "<date>", // IWhen the measure was approved by publisher "lastReviewDate" : "<date>", // IWhen the measure was last reviewed by the publisher "effectivePeriod" : { Period }, // IWhen the measure is expected to be used "topic" : [{ CodeableConcept }], // IThe category of the measure, such as Education, Treatment, Assessment, etc "author" : [{ ContactDetail }], // IWho authored the content "editor" : [{ ContactDetail }], // IWho edited the content "reviewer" : [{ ContactDetail }], // IWho reviewed the content "endorser" : [{ ContactDetail }], // IWho endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc "library" : ["<canonical>"], // ILogic used by the measure "disclaimer" : "<markdown>", // IDisclaimer for use of the measure or its referenced content "scoring" : { CodeableConcept }, // Iproportion | ratio | continuous-variable | cohort"scoringUnit" : { CodeableConcept }, // IWhat units? "compositeScoring" : { CodeableConcept }, // Iopportunity | all-or-nothing | linear | weighted "type" : [{ CodeableConcept }], // Iprocess | outcome | structure | patient-reported-outcome | composite "riskAdjustment" : "<markdown>", // IHow risk adjustment is applied for this measure "rateAggregation" : "<markdown>", // IHow is rate aggregation performed for this measure "rationale" : "<markdown>", // IDetailed description of why the measure exists "clinicalRecommendationStatement" : "<markdown>", // ISummary of clinical guidelines "improvementNotation" : { CodeableConcept }, // Iincrease | decrease "term" : [{ BackboneElement }], // IDefined terms used in the measure documentation "guidance" : "<markdown>", // IAdditional guidance for implementers (deprecated) "group" : [{ BackboneElement }], // IPopulation criteria group "supplementalData" : [{ BackboneElement }], // IWhat other data should be reported with the measure }
This structure is derived from Measure .
Differential View
This
structure
is
derived
from
indicates
the
differences
between
this
profile
and
the
base
Measure
.
structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | Measure | A quality measure definition | |
|
S |
|
|
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability ( required ) |
|
S |
|
|
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
|
S |
|
|
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
|
S | 1..1 |
|
|
|
S |
|
string |
|
|
S |
|
|
|
|
S |
|
|
|
|
S | 1..1 | string |
Name
|
|
S |
0
..
|
|
|
|
|
0
..
|
|
|
|
S | 1..1 |
|
|
Documentation
for
this
format
|
||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Measure structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
|
1..1 | Measure |
A
quality
measure
definition
|
|
Σ | 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: |
|
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |
|
0..* | Resource |
Contained,
inline
Resources
|
|
|
0..* | Extension |
Slice: Unordered, Open by |
|
| S | 0..* | code |
shareable
|
computable
|
publishable
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability ( required ) |
![]() ![]() | S | 0..* | code |
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
![]() ![]() | S | 0..* | (Complex) |
Additional
documentation,
review,
or
usage
guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
![]() ![]() |
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
|
S
Σ
C
|
1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
|
Σ | 0..* | Identifier |
Additional
identifier
for
the
measure
|
|
S Σ | 1..1 | string | Business version of the measure |
| S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) | |
![]() ![]() ![]() | string | |||
![]() ![]() ![]() | Coding | |||
|
S
Σ
|
|
string | Name for this measure (computer friendly) |
|
S Σ |
|
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. |
|
S Σ |
|
boolean | For testing purposes, not real usage |
|
0..1 |
E.g.
Patient,
Practitioner,
RelatedPerson,
Organization,
Location,
Device
Binding: |
||
|
CodeableConcept | |||
|
Reference ( Group ) | |||
|
|
0..1 | code |
Population
basis
Binding: All FHIR Types ( required ) |
![]() ![]() | Σ | 0..1 | dateTime | Date last changed |
|
S Σ | 0..1 | string |
Name
of
the
|
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
S Σ | 1..1 | markdown | Natural language description of the measure |
|
Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
Σ XD | 0..* | CodeableConcept |
Intended
jurisdiction
for
measure
(if
applicable)
Binding: Jurisdiction ValueSet ( extensible ): Countries and regions within which this artifact is targeted for use. |
|
0..1 | markdown | Why this measure is defined | |
|
0..1 |
|
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 |
|
XD | 0..* | CodeableConcept |
The
category
of
the
measure,
such
as
Education,
Treatment,
Assessment,
Binding: |
|
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,
|
|
|
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: Measure Scoring Unit ( example ) |
![]() ![]() | Σ | 0..1 | CodeableConcept |
opportunity
|
all-or-nothing
|
linear
|
weighted
Binding: |
|
Σ | 0..* | CodeableConcept |
process
|
outcome
|
structure
|
patient-reported-outcome
|
composite
Binding: |
|
Σ | 0..1 |
|
How risk adjustment is applied for this measure |
|
Σ | 0..1 |
|
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: |
| 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..* |
|
|
![]() ![]() ![]() | 0..1 | CodeableConcept |
What
term?
Binding: Measure Definition Example ( example ): Codeable representations of measure |
|
| 0..1 | markdown | Meaning of the term | |
|
Σ XD | 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 |
![]() ![]() ![]() | 0..1 | CodeableConcept |
Meaning
of
the
group
Binding: |
|
|
0..1 | markdown | Summary description | |
![]() ![]() ![]() |
Σ |
|
|
Binding: Measure Type ( extensible ) |
| 0..1 |
E.g.
Patient,
Practitioner,
RelatedPerson,
Organization,
Location,
Device
Binding: Participant Resource Types ( 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: All FHIR Types ( required ) |
![]() ![]()
|
Σ |
|
|
Binding: MeasureScoring
(
extensible
)
|
| Σ | 0..1 | CodeableConcept |
What
units?
Binding: Measure Scoring Unit ( example ) |
|
Σ | 0..1 | markdown | How is rate aggregation performed for this measure |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept |
increase
|
decrease
Binding: Measure Improvement Notation ( 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 |
|
0..1 | CodeableConcept |
initial-population
|
numerator
|
numerator-exclusion
|
denominator
|
denominator-exclusion
|
denominator-exception
|
measure-population
|
measure-population-exclusion
|
measure-observation
Binding: |
|
|
0..1 |
|
The human readable description of this population criteria | |
|
|
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: Measure Aggregate Method ( 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 |
|
C
|
0..1 | CodeableConcept |
Meaning
of
the
stratifier
Binding: |
|
C
|
0..1 |
|
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 |
|
0..1 | CodeableConcept |
Meaning
of
the
stratifier
component
Binding: |
|
|
0..1 |
|
The human readable description of this stratifier component | |
|
|
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 |
|
0..1 | CodeableConcept |
Meaning
of
the
supplemental
data
Binding: |
|
|
0..* | CodeableConcept |
supplemental-data
|
risk-adjustment-factor
Binding: |
|
|
0..1 |
|
The human readable description of this supplemental data | |
|
1..1 | Expression | Expression describing additional data to be reported | |
Documentation
for
this
format
|
||||
XML Template
<!-- Shareable Measure --><!-- ShareableMeasure --><Measure xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
<</meta> < < <<meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text><</contained> <<a href="shareablemeasure-definitions.html#Measure.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<contained><!-- 0..* Resource Contained, inline Resources --></contained> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> < <</identifier> < < < < < < <</subject[x]> < < <</contact> < < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this measure, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the measure --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the measure --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this measure (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this measure (human friendly) --> <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the measure --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage --> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]> <basis value="[code]"/><!-- I 0..1 Population basis --> <date value="[dateTime]"/><!-- I 0..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the measure --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext><</jurisdiction> < < < < < <<jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for measure (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this measure is defined --> <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the measure --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the measure was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the measure was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the measure is expected to be used --></effectivePeriod><</topic> <</author> <</editor> <</reviewer> <</endorser> < Additional documentation, citations, etc.</relatedArtifact> < < <</scoring> <</compositeScoring> <</type> < < < < <</improvementNotation> < < < <<a href="shareablemeasure-definitions.html#Measure.group.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<topic><!-- I 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the content --></author> <editor><!-- I 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- I 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <library value="[canonical]"/><!-- I 0..* Logic used by the measure --> <disclaimer value="[markdown]"/><!-- I 0..1 Disclaimer for use of the measure or its referenced content --> <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort--></scoring> <scoringUnit><!-- I 0..1 CodeableConcept What units? --></scoringUnit> <compositeScoring><!-- I 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted --></compositeScoring> <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <riskAdjustment value="[markdown]"/><!-- I 0..1 How risk adjustment is applied for this measure --> <rateAggregation value="[markdown]"/><!-- I 0..1 How is rate aggregation performed for this measure --> <rationale value="[markdown]"/><!-- I 0..1 Detailed description of why the measure exists --> <clinicalRecommendationStatement value="[markdown]"/><!-- I 0..1 Summary of clinical guidelines --> <improvementNotation><!-- I 0..1 CodeableConcept increase | decrease --></improvementNotation> <term> I 0..* BackboneElement <!-- I 0..* Defined terms used in the measure documentation --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> < < <<a href="shareablemeasure-definitions.html#Measure.group.population.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!-- I 0..1 CodeableConcept What term? --></code> <definition value="[markdown]"/><!-- I 0..1 Meaning of the term --> </term> <guidance value="[markdown]"/><!-- I 0..1 Additional guidance for implementers (deprecated) --> <group> I 0..* BackboneElement <!-- I 0..* Population criteria group --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> < < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- I 0..1 Unique id for group in measure --> <code><!-- I 0..1 CodeableConcept Meaning of the group --></code> <description value="[markdown]"/><!-- I 0..1 Summary description --> <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]> <basis value="[code]"/><!-- I 0..1 Population basis --> <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort
--></scoring> <scoringUnit><!-- I 0..1 CodeableConcept What units? --></scoringUnit> <rateAggregation value="[markdown]"/><!-- I 0..1 How is rate aggregation performed for this measure --> <improvementNotation><!-- I 0..1 CodeableConcept increase | decrease --></improvementNotation> <library value="[canonical]"/><!-- I 0..* Logic used by the measure group --> <population> I 0..* BackboneElement <!-- I 0..* Population criteria --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- I 0..1 Unique id for population in measure --> <code><!-- I 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <description value="[markdown]"/><!-- I 0..1 The human readable description of this population criteria --> <criteria><!-- I 0..1 Expression The criteria that defines this population --></criteria> <groupDefinition><!-- I 0..1 Reference(Group) A group resource that defines this population --></groupDefinition> <inputPopulationId value="[string]"/><!-- I 0..1 Which population --> <aggregateMethod><!-- I 0..1 CodeableConcept Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count) --></aggregateMethod> </population>
< <<a href="shareablemeasure-definitions.html#Measure.group.stratifier.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<stratifier> I 0..* BackboneElement <!-- I 0..* Stratifier criteria for the measure --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> < < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- I 0..1 Unique id for stratifier in measure --> <code><!-- I 0..1 CodeableConcept Meaning of the stratifier --></code> <description value="[markdown]"/><!-- I 0..1 The human readable description of this stratifier --> <criteria><!-- I 0..1 Expression How the measure should be stratified --></criteria>< <<a href="shareablemeasure-definitions.html#Measure.group.stratifier.component.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<groupDefinition><!-- I 0..1 Reference(Group) A group resource that defines this population --></groupDefinition> <component> I 0..* BackboneElement <!-- I 0..* Stratifier criteria component for the measure --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- I 0..1 Unique id for stratifier component in measure --> <code><!-- I 0..1 CodeableConcept Meaning of the stratifier component --></code> <description value="[markdown]"/><!-- I 0..1 The human readable description of this stratifier component --><<criteria><!-- I 0..1 Expression Component of how the measure should be stratified --></criteria> <groupDefinition><!-- I 0..1 Reference(Group) A group resource that defines this population --></groupDefinition> </component> </stratifier> </group>< <<a href="shareablemeasure-definitions.html#Measure.supplementalData.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.<supplementalData> I 0..* BackboneElement <!-- I 0..* What other data should be reported with the measure --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> <</code> <</usage> < < Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <linkId value="[string]"/><!-- I 0..1 Unique id for supplementalData in measure --> <code><!-- I 0..1 CodeableConcept Meaning of the supplemental data --></code> <usage><!-- I 0..* CodeableConcept supplemental-data | risk-adjustment-factor --></usage> <description value="[markdown]"/><!-- I 0..1 The human readable description of this supplemental data --> <criteria><!-- I 1..1 Expression Expression describing additional data to be reported --></criteria> </supplementalData> </Measure>
JSON Template
{ //{ // ShareableMeasure // from Element: extension" " " " " "<a href="shareablemeasure-definitions.html#Measure.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."meta" : { Meta }, // IMetadata about the resource "implicitRules" : "<uri>", // IA set of rules under which this content was created "language" : "<code>", // ILanguage of the resource content "text" : { Narrative }, // IText summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "extension" : [ // sliced by value:url in the specified order, Open { // shareable | computable | publishable | executable // I // from Element: extension }, { // narrative | semi-structured | structured | executable // I // from Element: extension }, { // Additional documentation, review, or usage guidance // I // from Element: extension } ], "Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"> " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " " Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored "url" : "<uri>", // I R! Canonical identifier for this measure, represented as a URI (globally unique) "identifier" : [{ Identifier }], // IAdditional identifier for the measure "version" : "<string>", // I R! Business version of the measure // value[x]: How to compare versions. One of these 2: "versionAlgorithmString" : "<string>", // IHow to compare versions "versionAlgorithmCoding" : { Coding }, // IHow to compare versions "name" : "<string>", // IName for this measure (computer friendly) "title" : "<string>", // I R! Name for this measure (human friendly) "subtitle" : "<string>", // ISubordinate title of the measure "status" : "<code>", // I R! draft | active | retired | unknown "experimental" : <boolean>, // IFor testing purposes, not real usage // value[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2: "subjectCodeableConcept" : { CodeableConcept }, // IE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device "subjectReference" : { Reference(Group) }, // IE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device "basis" : "<code>", // IPopulation basis "date" : "<dateTime>", // IDate last changed "publisher" : "<string>", // IName of the publisher/steward (organization or individual) "contact" : [{ ContactDetail }], // IContact details for the publisher "description" : "<markdown>", // I R! Natural language description of the measure "useContext" : [{ UsageContext }], // IThe context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for measure (if applicable) "purpose" : "<markdown>", // IWhy this measure is defined "usage" : "<markdown>", // IDescribes the clinical usage of the measure "copyright" : "<markdown>", // IUse and/or publishing restrictions "copyrightLabel" : "<string>", // ICopyright holder and year(s) "approvalDate" : "<date>", // IWhen the measure was approved by publisher "lastReviewDate" : "<date>", // IWhen the measure was last reviewed by the publisher "effectivePeriod" : { Period }, // IWhen the measure is expected to be used "topic" : [{ CodeableConcept }], // IThe category of the measure, such as Education, Treatment, Assessment, etc "author" : [{ ContactDetail }], // IWho authored the content "editor" : [{ ContactDetail }], // IWho edited the content "reviewer" : [{ ContactDetail }], // IWho reviewed the content "endorser" : [{ ContactDetail }], // IWho endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc "library" : ["<canonical>"], // ILogic used by the measure "disclaimer" : "<markdown>", // IDisclaimer for use of the measure or its referenced content "scoring" : { CodeableConcept }, // Iproportion | ratio | continuous-variable | cohort"scoringUnit" : { CodeableConcept }, // IWhat units? "compositeScoring" : { CodeableConcept }, // Iopportunity | all-or-nothing | linear | weighted "type" : [{ CodeableConcept }], // Iprocess | outcome | structure | patient-reported-outcome | composite "riskAdjustment" : "<markdown>", // IHow risk adjustment is applied for this measure "rateAggregation" : "<markdown>", // IHow is rate aggregation performed for this measure "rationale" : "<markdown>", // IDetailed description of why the measure exists "clinicalRecommendationStatement" : "<markdown>", // ISummary of clinical guidelines "improvementNotation" : { CodeableConcept }, // Iincrease | decrease "term" : [{ BackboneElement }], // IDefined terms used in the measure documentation "guidance" : "<markdown>", // IAdditional guidance for implementers (deprecated) "group" : [{ BackboneElement }], // IPopulation criteria group "supplementalData" : [{ BackboneElement }], // IWhat other data should be reported with the measure }
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| Measure.language |
|
|
|
| Measure.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
| Measure.status | PublicationStatus | required | PublicationStatus |
| Measure.subject[x] |
|
extensible |
|
| Measure.basis | All FHIR Types | required | All FHIR Types |
| Measure.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
| Measure.topic |
|
example |
|
| Measure.scoring | MeasureScoring | extensible |
MeasureScoring
|
| Measure.scoringUnit | Measure Scoring Unit | example | Measure Scoring Unit |
| Measure.compositeScoring |
|
extensible |
|
| Measure.type |
|
extensible |
|
| Measure.improvementNotation |
|
required |
|
| Measure.term.code | Measure Definition Example | example | Measure Definition Example |
| Measure.group.code |
|
example |
|
| Measure.group.type | Measure Type | extensible | Measure Type |
| Measure.group.subject[x] | Participant Resource Types | extensible | Participant Resource Types |
| Measure.group.basis | All FHIR Types | required | All FHIR Types |
| Measure.group.scoring | MeasureScoring | extensible |
MeasureScoring
![]() |
| Measure.group.scoringUnit | Measure Scoring Unit | example | Measure Scoring Unit |
| Measure.group.improvementNotation | Measure Improvement Notation | required | Measure Improvement Notation |
| Measure.group.population.code |
|
extensible |
|
| Measure.group.population.aggregateMethod | Measure Aggregate Method | extensible | Measure Aggregate Method |
| Measure.group.stratifier.code |
|
example |
|
| Measure.group.stratifier.component.code |
|
example |
|
| Measure.supplementalData.code |
|
example |
|
| Measure.supplementalData.usage |
|
extensible |
|