This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
(v4.2.0:
R5
Preview
#1).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
Clinical
Quality
Information
Work
Group
|
Maturity Level : 1 | Trial Use | Use Context : Any |
The official 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
This profile was published on [no date] as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from Measure .
This structure is derived from Measure .
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | Measure | ||
|
1..1 | uri | ||
|
S | 0 .. * | Identifier | |
|
1..1 | string | ||
|
1..1 | string | ||
|
S | 0..1 | string | |
|
1..1 | boolean | ||
|
S | 0..1 | dateTime | |
|
1..1 | string | ||
|
S | 0 .. * | ContactDetail | |
|
1..1 | markdown | ||
|
S | 0 .. * | UsageContext | |
|
S | 0 .. * | CodeableConcept | |
Documentation
for
this
format
|
||||
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
I | 1..1 | Measure |
A
quality
measure
definition
|
|
Σ | 0..1 |
|
Logical id of this artifact |
|
Σ I | 0..1 | Meta | Metadata about the resource |
|
?! Σ I | 0..1 | uri | A set of rules under which this content was created |
|
I | 0..1 | code |
Language
of
the
resource
content
Binding: Common Languages ( preferred ) Max Binding: All Languages |
|
I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
|
0..* | Resource |
Contained,
inline
Resources
|
|
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! I | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
|
Σ I | 1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
|
S Σ I | 0..* | Identifier |
Additional
identifier
for
the
measure
|
|
Σ I | 1..1 | string | Business version of the measure |
|
Σ I | 1..1 | string | Name for this measure (computer friendly) |
|
S Σ I | 0..1 | string | Name for this measure (human friendly) |
|
I | 0..1 | string | Subordinate title of the measure |
|
?! Σ I | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ) |
|
Σ I | 1..1 | boolean | For testing purposes, not real usage |
|
I | 0..1 |
E.g.
Patient,
Practitioner,
RelatedPerson,
Organization,
Location,
Device
Binding: Subject type ( extensible ) |
|
|
CodeableConcept | |||
|
Reference
|
|||
|
S Σ I | 0..1 | dateTime | Date last changed |
|
Σ I | 1..1 | string | Name of the publisher (organization or individual) |
|
S Σ I | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
Σ I | 1..1 | markdown | Natural language description of the measure |
|
S Σ I | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
S Σ I | 0..* | CodeableConcept |
Intended
jurisdiction
for
measure
(if
applicable)
Binding: Jurisdiction ( extensible ) |
|
I | 0..1 | markdown | Why this measure is defined |
|
I | 0..1 | string | Describes the clinical usage of the measure |
|
I | 0..1 | markdown | Use and/or publishing restrictions |
|
I | 0..1 | date | When the measure was approved by publisher |
|
I | 0..1 | date | When the measure was last reviewed |
|
Σ I | 0..1 | Period | When the measure is expected to be used |
|
I | 0..* | CodeableConcept |
The
category
of
the
measure,
such
as
Education,
Treatment,
Assessment,
etc.
Binding: DefinitionTopic ( example ) |
|
I | 0..* | ContactDetail |
Who
authored
the
content
|
|
I | 0..* | ContactDetail |
Who
edited
the
content
|
|
I | 0..* | ContactDetail |
Who
reviewed
the
content
|
|
I | 0..* | ContactDetail |
Who
endorsed
the
content
|
|
I | 0..* | RelatedArtifact |
Additional
documentation,
citations,
etc.
|
|
I | 0..* | canonical ( Library ) |
Logic
used
by
the
measure
|
|
Σ I | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
|
Σ I | 0..1 | CodeableConcept |
proportion
|
ratio
|
continuous-variable
|
cohort
Binding: MeasureScoring ( extensible ) |
|
Σ I | 0..1 | CodeableConcept |
opportunity
|
all-or-nothing
|
linear
|
weighted
Binding: CompositeMeasureScoring ( extensible ) |
|
Σ I | 0..* | CodeableConcept |
process
|
outcome
|
structure
|
patient-reported-outcome
|
composite
Binding: MeasureType ( extensible ) |
|
Σ I | 0..1 | string | How risk adjustment is applied for this measure |
|
Σ I | 0..1 | string | How is rate aggregation performed for this measure |
|
Σ I | 0..1 | markdown | Detailed description of why the measure exists |
|
Σ I | 0..1 | markdown | Summary of clinical guidelines |
|
Σ I | 0..1 | CodeableConcept |
increase
|
decrease
Binding: MeasureImprovementNotation ( required ) |
|
Σ I | 0..* | markdown |
Defined
terms
used
in
the
measure
documentation
|
|
Σ I | 0..1 | markdown | Additional guidance for implementers |
|
I | 0..* | BackboneElement |
Population
criteria
group
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | CodeableConcept | Meaning of the group |
|
I | 0..1 | string | Summary description |
|
I | 0..* | BackboneElement |
Population
criteria
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | CodeableConcept |
initial-population
|
numerator
|
numerator-exclusion
|
denominator
|
denominator-exclusion
|
denominator-exception
|
measure-population
|
measure-population-exclusion
|
measure-observation
Binding: MeasurePopulationType ( extensible ) |
|
I | 0..1 | string | The human readable description of this population criteria |
|
I | 1..1 | Expression | The criteria that defines this population |
|
I | 0..* | BackboneElement |
Stratifier
criteria
for
the
measure
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | CodeableConcept | Meaning of the stratifier |
|
I | 0..1 | string | The human readable description of this stratifier |
|
I | 0..1 | Expression | How the measure should be stratified |
|
I | 0..* | BackboneElement |
Stratifier
criteria
component
for
the
measure
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | CodeableConcept | Meaning of the stratifier component |
|
I | 0..1 | string | The human readable description of this stratifier component |
|
I | 1..1 | Expression | Component of how the measure should be stratified |
|
I | 0..* | BackboneElement |
What
other
data
should
be
reported
with
the
measure
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | CodeableConcept | Meaning of the supplemental data |
|
I | 0..* | CodeableConcept |
supplemental-data
|
risk-adjustment-factor
Binding: MeasureDataUsage ( extensible ) |
|
I | 0..1 | string | The human readable description of this supplemental data |
|
I | 1..1 | Expression | Expression describing additional data to be reported |
Documentation
for
this
format
|
||||
<!-- Shareable Measure --><Measure xmlns="http://hl7.org/fhir" > <!-- from Element: extension -->
<</id><id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!--0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
0..1 A set of rules under which this content was created --> <language value="[code]"/><!--
0..1 Language of the resource content --> <text><!--
0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!--
1..1 Canonical identifier for this measure, represented as a URI (globally unique) --> <identifier><!--
0..* Identifier Additional identifier for the measure --></identifier> <version value="[string]"/><!--
1..1 Business version of the measure --> <name value="[string]"/><!--
1..1 Name for this measure (computer friendly) --> <title value="[string]"/><!--
0..1 Name for this measure (human friendly) --> <subtitle value="[string]"/><!--
0..1 Subordinate title of the measure --> <status value="[code]"/><!--
1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!--
1..1 For testing purposes, not real usage --> <subject[x]><!--
0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]> <date value="[dateTime]"/><!--
0..1 Date last changed --> <publisher value="[string]"/><!--
1..1 Name of the publisher (organization or individual) --> <contact><!--
0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!--
1..1 Natural language description of the measure --> <useContext><!--
0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!--
0..* CodeableConcept Intended jurisdiction for measure (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!--
0..1 Why this measure is defined --> <usage value="[string]"/><!--
0..1 Describes the clinical usage of the measure --> <copyright value="[markdown]"/><!--
0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!--
0..1 When the measure was approved by publisher --> <lastReviewDate value="[date]"/><!--
0..1 When the measure was last reviewed --> <effectivePeriod><!--
0..1 Period When the measure is expected to be used --></effectivePeriod> <topic><!--
0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc. --></topic> <author><!--
0..* ContactDetail Who authored the content --></author> <editor><!--
0..* ContactDetail Who edited the content --></editor> <reviewer><!--
0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!--
0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!--
0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <library value="[canonical]"/><!--
0..* Logic used by the measure --> <disclaimer value="[markdown]"/><!--
0..1 Disclaimer for use of the measure or its referenced content --> <scoring><!--
0..1 CodeableConcept proportion | ratio | continuous-variable | cohort --></scoring> <compositeScoring><!--
0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted --></compositeScoring> <type><!--
0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <riskAdjustment value="[string]"/><!--
0..1 How risk adjustment is applied for this measure --> <rateAggregation value="[string]"/><!--
0..1 How is rate aggregation performed for this measure --> <rationale value="[markdown]"/><!--
0..1 Detailed description of why the measure exists --> <clinicalRecommendationStatement value="[markdown]"/><!--
0..1 Summary of clinical guidelines --> <improvementNotation><!--
0..1 CodeableConcept increase | decrease --></improvementNotation> <definition value="[markdown]"/><!--
0..* Defined terms used in the measure documentation --> <guidance value="[markdown]"/><!--
0..1 Additional guidance for implementers -->
<<group>0..* BackboneElement <!--
0..* Population criteria group --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
0..1 CodeableConcept Meaning of the group --></code> <description value="[string]"/><!--
0..1 Summary description -->
<<population>0..* BackboneElement <!--
0..* Population criteria --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <description value="[string]"/><!--
0..1 The human readable description of this population criteria --> <criteria><!--
1..1 Expression The criteria that defines this population --></criteria> </population>
<<stratifier>0..* BackboneElement <!--
0..* Stratifier criteria for the measure --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
0..1 CodeableConcept Meaning of the stratifier --></code> <description value="[string]"/><!--
0..1 The human readable description of this stratifier --> <criteria><!--
0..1 Expression How the measure should be stratified --></criteria>
<<component>0..* BackboneElement <!--
0..* Stratifier criteria component for the measure --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
0..1 CodeableConcept Meaning of the stratifier component --></code> <description value="[string]"/><!--
0..1 The human readable description of this stratifier component --> <criteria><!--
1..1 Expression Component of how the measure should be stratified --></criteria> </component> </stratifier> </group>
<<supplementalData>0..* BackboneElement <!--
0..* What other data should be reported with the measure --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
0..1 CodeableConcept Meaning of the supplemental data --></code> <usage><!--
0..* CodeableConcept supplemental-data | risk-adjustment-factor --></usage> <description value="[string]"/><!--
0..1 The human readable description of this supplemental data --> <criteria><!--
1..1 Expression Expression describing additional data to be reported --></criteria> </supplementalData> </Measure>
{ // Shareable Measure
// from Element: extension
"meta" : { Meta }, // C?Metadata about the resource
"implicitRules" : "<uri>", // C?A set of rules under which this content was created
"language" : "<code>", // C?Language of the resource content
"text" : { Narrative }, // C?Text summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
"url" : "<uri>", // C? R! Canonical identifier for this measure, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // C?Additional identifier for the measure
"version" : "<string>", // C? R! Business version of the measure
"name" : "<string>", // C? R! Name for this measure (computer friendly)
"title" : "<string>", // C?Name for this measure (human friendly)
"subtitle" : "<string>", // C?Subordinate title of the measure
"status" : "<code>", // C? R! draft | active | retired | unknown
"experimental" : <boolean>, // C? R! For testing purposes, not real usage
// value[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2:
"subjectCodeableConcept" : { CodeableConcept }, // C?E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
"subjectReference" : { Reference(Group) }, // C?E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
"date" : "<dateTime>", // C?Date last changed
"publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // C?Contact details for the publisher
"description" : "<markdown>", // C? R! Natural language description of the measure
"useContext" : [{ UsageContext }], // C?The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for measure (if applicable)
"purpose" : "<markdown>", // C?Why this measure is defined
"usage" : "<string>", // C?Describes the clinical usage of the measure
"copyright" : "<markdown>", // C?Use and/or publishing restrictions
"approvalDate" : "<date>", // C?When the measure was approved by publisher
"lastReviewDate" : "<date>", // C?When the measure was last reviewed
"effectivePeriod" : { Period }, // C?When the measure is expected to be used
"topic" : [{ CodeableConcept }], // C?The category of the measure, such as Education, Treatment, Assessment, etc.
"author" : [{ ContactDetail }], // C?Who authored the content
"editor" : [{ ContactDetail }], // C?Who edited the content
"reviewer" : [{ ContactDetail }], // C?Who reviewed the content
"endorser" : [{ ContactDetail }], // C?Who endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
"library" : ["<canonical>"], // C?Logic used by the measure
"disclaimer" : "<markdown>", // C?Disclaimer for use of the measure or its referenced content
"scoring" : { CodeableConcept }, // C?proportion | ratio | continuous-variable | cohort
"compositeScoring" : { CodeableConcept }, // C?opportunity | all-or-nothing | linear | weighted
"type" : [{ CodeableConcept }], // C?process | outcome | structure | patient-reported-outcome | composite
"riskAdjustment" : "<string>", // C?How risk adjustment is applied for this measure
"rateAggregation" : "<string>", // C?How is rate aggregation performed for this measure
"rationale" : "<markdown>", // C?Detailed description of why the measure exists
"clinicalRecommendationStatement" : "<markdown>", // C?Summary of clinical guidelines
"improvementNotation" : { CodeableConcept }, // C?increase | decrease
"definition" : ["<markdown>"], // C?Defined terms used in the measure documentation
"guidance" : "<markdown>", // C?Additional guidance for implementers
"
"
"group" : [{ BackboneElement }] // C?Population criteria group
"supplementalData" : [{ BackboneElement }], // C?What other data should be reported with the measure
}
This structure is derived from Measure .
Differential View
This structure is derived from Measure .
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | Measure | ||
|
1..1 | uri | ||
|
S | 0 .. * | Identifier | |
|
1..1 | string | ||
|
1..1 | string | ||
|
S | 0..1 | string | |
|
1..1 | boolean | ||
|
S | 0..1 | dateTime | |
|
1..1 | string | ||
|
S | 0 .. * | ContactDetail | |
|
1..1 | markdown | ||
|
S | 0 .. * | UsageContext | |
|
S | 0 .. * | CodeableConcept | |
Documentation
for
this
format
|
||||
Snapshot View
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
I | 1..1 | Measure |
A
quality
measure
definition
|
|
Σ | 0..1 |
|
Logical id of this artifact |
|
Σ I | 0..1 | Meta | Metadata about the resource |
|
?! Σ I | 0..1 | uri | A set of rules under which this content was created |
|
I | 0..1 | code |
Language
of
the
resource
content
Binding: Common Languages ( preferred ) Max Binding: All Languages |
|
I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
|
0..* | Resource |
Contained,
inline
Resources
|
|
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! I | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
|
Σ I | 1..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) |
|
S Σ I | 0..* | Identifier |
Additional
identifier
for
the
measure
|
|
Σ I | 1..1 | string | Business version of the measure |
|
Σ I | 1..1 | string | Name for this measure (computer friendly) |
|
S Σ I | 0..1 | string | Name for this measure (human friendly) |
|
I | 0..1 | string | Subordinate title of the measure |
|
?! Σ I | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ) |
|
Σ I | 1..1 | boolean | For testing purposes, not real usage |
|
I | 0..1 |
E.g.
Patient,
Practitioner,
RelatedPerson,
Organization,
Location,
Device
Binding: Subject type ( extensible ) |
|
|
CodeableConcept | |||
|
Reference
|
|||
|
S Σ I | 0..1 | dateTime | Date last changed |
|
Σ I | 1..1 | string | Name of the publisher (organization or individual) |
|
S Σ I | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
Σ I | 1..1 | markdown | Natural language description of the measure |
|
S Σ I | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
S Σ I | 0..* | CodeableConcept |
Intended
jurisdiction
for
measure
(if
applicable)
Binding: Jurisdiction ( extensible ) |
|
I | 0..1 | markdown | Why this measure is defined |
|
I | 0..1 | string | Describes the clinical usage of the measure |
|
I | 0..1 | markdown | Use and/or publishing restrictions |
|
I | 0..1 | date | When the measure was approved by publisher |
|
I | 0..1 | date | When the measure was last reviewed |
|
Σ I | 0..1 | Period | When the measure is expected to be used |
|
I | 0..* | CodeableConcept |
The
category
of
the
measure,
such
as
Education,
Treatment,
Assessment,
etc.
Binding: DefinitionTopic ( example ) |
|
I | 0..* | ContactDetail |
Who
authored
the
content
|
|
I | 0..* | ContactDetail |
Who
edited
the
content
|
|
I | 0..* | ContactDetail |
Who
reviewed
the
content
|
|
I | 0..* | ContactDetail |
Who
endorsed
the
content
|
|
I | 0..* | RelatedArtifact |
Additional
documentation,
citations,
etc.
|
|
I | 0..* | canonical ( Library ) |
Logic
used
by
the
measure
|
|
Σ I | 0..1 | markdown | Disclaimer for use of the measure or its referenced content |
|
Σ I | 0..1 | CodeableConcept |
proportion
|
ratio
|
continuous-variable
|
cohort
Binding: MeasureScoring ( extensible ) |
|
Σ I | 0..1 | CodeableConcept |
opportunity
|
all-or-nothing
|
linear
|
weighted
Binding: CompositeMeasureScoring ( extensible ) |
|
Σ I | 0..* | CodeableConcept |
process
|
outcome
|
structure
|
patient-reported-outcome
|
composite
Binding: MeasureType ( extensible ) |
|
Σ I | 0..1 | string | How risk adjustment is applied for this measure |
|
Σ I | 0..1 | string | How is rate aggregation performed for this measure |
|
Σ I | 0..1 | markdown | Detailed description of why the measure exists |
|
Σ I | 0..1 | markdown | Summary of clinical guidelines |
|
Σ I | 0..1 | CodeableConcept |
increase
|
decrease
Binding: MeasureImprovementNotation ( required ) |
|
Σ I | 0..* | markdown |
Defined
terms
used
in
the
measure
documentation
|
|
Σ I | 0..1 | markdown | Additional guidance for implementers |
|
I | 0..* | BackboneElement |
Population
criteria
group
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | CodeableConcept | Meaning of the group |
|
I | 0..1 | string | Summary description |
|
I | 0..* | BackboneElement |
Population
criteria
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | CodeableConcept |
initial-population
|
numerator
|
numerator-exclusion
|
denominator
|
denominator-exclusion
|
denominator-exception
|
measure-population
|
measure-population-exclusion
|
measure-observation
Binding: MeasurePopulationType ( extensible ) |
|
I | 0..1 | string | The human readable description of this population criteria |
|
I | 1..1 | Expression | The criteria that defines this population |
|
I | 0..* | BackboneElement |
Stratifier
criteria
for
the
measure
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | CodeableConcept | Meaning of the stratifier |
|
I | 0..1 | string | The human readable description of this stratifier |
|
I | 0..1 | Expression | How the measure should be stratified |
|
I | 0..* | BackboneElement |
Stratifier
criteria
component
for
the
measure
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | CodeableConcept | Meaning of the stratifier component |
|
I | 0..1 | string | The human readable description of this stratifier component |
|
I | 1..1 | Expression | Component of how the measure should be stratified |
|
I | 0..* | BackboneElement |
What
other
data
should
be
reported
with
the
measure
|
|
0..1 |
|
Unique id for inter-element referencing | |
|
I | 0..* | Extension |
Additional
content
defined
by
implementations
|
|
?! Σ I | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
|
I | 0..1 | CodeableConcept | Meaning of the supplemental data |
|
I | 0..* | CodeableConcept |
supplemental-data
|
risk-adjustment-factor
Binding: MeasureDataUsage ( extensible ) |
|
I | 0..1 | string | The human readable description of this supplemental data |
|
I | 1..1 | Expression | Expression describing additional data to be reported |
Documentation
for
this
format
|
||||
XML Template
<!-- Shareable Measure --><Measure xmlns="http://hl7.org/fhir" > <!-- from Element: extension -->
<</id><id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!--0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!--
0..1 A set of rules under which this content was created --> <language value="[code]"/><!--
0..1 Language of the resource content --> <text><!--
0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!--
1..1 Canonical identifier for this measure, represented as a URI (globally unique) --> <identifier><!--
0..* Identifier Additional identifier for the measure --></identifier> <version value="[string]"/><!--
1..1 Business version of the measure --> <name value="[string]"/><!--
1..1 Name for this measure (computer friendly) --> <title value="[string]"/><!--
0..1 Name for this measure (human friendly) --> <subtitle value="[string]"/><!--
0..1 Subordinate title of the measure --> <status value="[code]"/><!--
1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!--
1..1 For testing purposes, not real usage --> <subject[x]><!--
0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]> <date value="[dateTime]"/><!--
0..1 Date last changed --> <publisher value="[string]"/><!--
1..1 Name of the publisher (organization or individual) --> <contact><!--
0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!--
1..1 Natural language description of the measure --> <useContext><!--
0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!--
0..* CodeableConcept Intended jurisdiction for measure (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!--
0..1 Why this measure is defined --> <usage value="[string]"/><!--
0..1 Describes the clinical usage of the measure --> <copyright value="[markdown]"/><!--
0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!--
0..1 When the measure was approved by publisher --> <lastReviewDate value="[date]"/><!--
0..1 When the measure was last reviewed --> <effectivePeriod><!--
0..1 Period When the measure is expected to be used --></effectivePeriod> <topic><!--
0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc. --></topic> <author><!--
0..* ContactDetail Who authored the content --></author> <editor><!--
0..* ContactDetail Who edited the content --></editor> <reviewer><!--
0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!--
0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!--
0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <library value="[canonical]"/><!--
0..* Logic used by the measure --> <disclaimer value="[markdown]"/><!--
0..1 Disclaimer for use of the measure or its referenced content --> <scoring><!--
0..1 CodeableConcept proportion | ratio | continuous-variable | cohort --></scoring> <compositeScoring><!--
0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted --></compositeScoring> <type><!--
0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite --></type> <riskAdjustment value="[string]"/><!--
0..1 How risk adjustment is applied for this measure --> <rateAggregation value="[string]"/><!--
0..1 How is rate aggregation performed for this measure --> <rationale value="[markdown]"/><!--
0..1 Detailed description of why the measure exists --> <clinicalRecommendationStatement value="[markdown]"/><!--
0..1 Summary of clinical guidelines --> <improvementNotation><!--
0..1 CodeableConcept increase | decrease --></improvementNotation> <definition value="[markdown]"/><!--
0..* Defined terms used in the measure documentation --> <guidance value="[markdown]"/><!--
0..1 Additional guidance for implementers -->
<<group>0..* BackboneElement <!--
0..* Population criteria group --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
0..1 CodeableConcept Meaning of the group --></code> <description value="[string]"/><!--
0..1 Summary description -->
<<population>0..* BackboneElement <!--
0..* Population criteria --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation --></code> <description value="[string]"/><!--
0..1 The human readable description of this population criteria --> <criteria><!--
1..1 Expression The criteria that defines this population --></criteria> </population>
<<stratifier>0..* BackboneElement <!--
0..* Stratifier criteria for the measure --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
0..1 CodeableConcept Meaning of the stratifier --></code> <description value="[string]"/><!--
0..1 The human readable description of this stratifier --> <criteria><!--
0..1 Expression How the measure should be stratified --></criteria>
<<component>0..* BackboneElement <!--
0..* Stratifier criteria component for the measure --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
0..1 CodeableConcept Meaning of the stratifier component --></code> <description value="[string]"/><!--
0..1 The human readable description of this stratifier component --> <criteria><!--
1..1 Expression Component of how the measure should be stratified --></criteria> </component> </stratifier> </group>
<<supplementalData>0..* BackboneElement <!--
0..* What other data should be reported with the measure --> <modifierExtension><!--
0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <code><!--
0..1 CodeableConcept Meaning of the supplemental data --></code> <usage><!--
0..* CodeableConcept supplemental-data | risk-adjustment-factor --></usage> <description value="[string]"/><!--
0..1 The human readable description of this supplemental data --> <criteria><!--
1..1 Expression Expression describing additional data to be reported --></criteria> </supplementalData> </Measure>
JSON Template
{ // Shareable Measure
// from Element: extension
"meta" : { Meta }, // C?Metadata about the resource
"implicitRules" : "<uri>", // C?A set of rules under which this content was created
"language" : "<code>", // C?Language of the resource content
"text" : { Narrative }, // C?Text summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
"url" : "<uri>", // C? R! Canonical identifier for this measure, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // C?Additional identifier for the measure
"version" : "<string>", // C? R! Business version of the measure
"name" : "<string>", // C? R! Name for this measure (computer friendly)
"title" : "<string>", // C?Name for this measure (human friendly)
"subtitle" : "<string>", // C?Subordinate title of the measure
"status" : "<code>", // C? R! draft | active | retired | unknown
"experimental" : <boolean>, // C? R! For testing purposes, not real usage
// value[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2:
"subjectCodeableConcept" : { CodeableConcept }, // C?E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
"subjectReference" : { Reference(Group) }, // C?E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
"date" : "<dateTime>", // C?Date last changed
"publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // C?Contact details for the publisher
"description" : "<markdown>", // C? R! Natural language description of the measure
"useContext" : [{ UsageContext }], // C?The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for measure (if applicable)
"purpose" : "<markdown>", // C?Why this measure is defined
"usage" : "<string>", // C?Describes the clinical usage of the measure
"copyright" : "<markdown>", // C?Use and/or publishing restrictions
"approvalDate" : "<date>", // C?When the measure was approved by publisher
"lastReviewDate" : "<date>", // C?When the measure was last reviewed
"effectivePeriod" : { Period }, // C?When the measure is expected to be used
"topic" : [{ CodeableConcept }], // C?The category of the measure, such as Education, Treatment, Assessment, etc.
"author" : [{ ContactDetail }], // C?Who authored the content
"editor" : [{ ContactDetail }], // C?Who edited the content
"reviewer" : [{ ContactDetail }], // C?Who reviewed the content
"endorser" : [{ ContactDetail }], // C?Who endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
"library" : ["<canonical>"], // C?Logic used by the measure
"disclaimer" : "<markdown>", // C?Disclaimer for use of the measure or its referenced content
"scoring" : { CodeableConcept }, // C?proportion | ratio | continuous-variable | cohort
"compositeScoring" : { CodeableConcept }, // C?opportunity | all-or-nothing | linear | weighted
"type" : [{ CodeableConcept }], // C?process | outcome | structure | patient-reported-outcome | composite
"riskAdjustment" : "<string>", // C?How risk adjustment is applied for this measure
"rateAggregation" : "<string>", // C?How is rate aggregation performed for this measure
"rationale" : "<markdown>", // C?Detailed description of why the measure exists
"clinicalRecommendationStatement" : "<markdown>", // C?Summary of clinical guidelines
"improvementNotation" : { CodeableConcept }, // C?increase | decrease
"definition" : ["<markdown>"], // C?Defined terms used in the measure documentation
"guidance" : "<markdown>", // C?Additional guidance for implementers
"
"
"group" : [{ BackboneElement }] // C?Population criteria group
"supplementalData" : [{ BackboneElement }], // C?What other data should be reported with the measure
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| Measure.language | Common Languages | preferred | Common Languages |
| Measure.status | PublicationStatus | required | PublicationStatus |
| Measure.subject[x] | Subject type | extensible | Subject type |
| Measure.jurisdiction | Jurisdiction | extensible | Jurisdiction |
| Measure.topic | DefinitionTopic | example | DefinitionTopic |
| Measure.scoring | MeasureScoring | extensible | MeasureScoring |
| Measure.compositeScoring | CompositeMeasureScoring | extensible | CompositeMeasureScoring |
| Measure.type | MeasureType | extensible | MeasureType |
| Measure.improvementNotation | MeasureImprovementNotation | required | MeasureImprovementNotation |
| Measure.group.population.code | MeasurePopulationType | extensible | MeasurePopulationType |
| Measure.supplementalData.usage | MeasureDataUsage | extensible | MeasureDataUsage |