Release 4B 5

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 icon 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 icon 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.

0 .. *
Name Flags Card. Type Description & Constraints doco
. . Measure 1..1 Measure A quality measure definition
. . url . knowledgeCapability S 1..1 0..* uri code Canonical identifier for this measure, represented as a URI (globally unique) shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability ( required )
. . identifier . knowledgeRepresentationLevel S 0 .. * 0..* Identifier code Additional identifier for the measure narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level ( required )
. . version . artifactComment S 1..1 0..* string (Complex) Business version of the measure Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
. . . title version S 0..1 1..1 string Name for this Business version of the measure (human friendly)
. . experimental . versionAlgorithm[x] S 1..1 0 .. 1 boolean string , Coding For testing purposes, not real usage How to compare versions
. . . date name S 0..1 0 .. 1 dateTime string Date last changed Name for this measure (computer friendly)
. . publisher . title S 1..1 string Name of the publisher (organization or individual) for this measure (human friendly)
. . . contact experimental S 0 .. * 1 ContactDetail boolean Contact details for the publisher For testing purposes, not real usage
. . description . publisher 1..1 markdown Natural language description of the measure useContext S 0 .. * 1 UsageContext string The context that Name of the content is intended to support publisher/steward (organization or individual)
. . jurisdiction . description S 1..1 CodeableConcept markdown Intended jurisdiction for Natural language description of the measure (if applicable)

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Measure structure.

S 1..1 S S S
Name Flags Card. Type Description & Constraints doco
. . Measure I C icon 1..1 Measure A quality measure definition
. . . id Σ 0..1 id Logical id of this artifact
. . . meta Σ 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
. . . language 0..1 code Language of the resource content
Binding: Common All Languages ( preferred required ): IETF language tag for a human language

Additional Bindings Purpose All Languages Max Binding
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . Slices for extension 0..* Extension Additional content defined Extension
Slice: Unordered, Open by implementations value:url
. . . knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability ( required )
... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level ( required )
... artifactComment S 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
. . . url S Σ C icon 1..1 uri Canonical identifier for this measure, represented as a URI (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the measure
. . . version S Σ 1..1 string Business version of the measure
. . . versionAlgorithm[x] S Σ 0..1 How to compare versions
Binding: Version Algorithm ( extensible )
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
. . . name S Σ I C icon 1..1 0..1 string Name for this measure (computer friendly)
. . . title S Σ 0..1 1..1 string Name for this measure (human friendly)
. . . subtitle 0..1 string Subordinate title of the measure
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact.

. . . experimental S Σ 1..1 0..1 boolean For testing purposes, not real usage
. . . subject[x] 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: Subject type Participant Resource Types ( extensible ): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).

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


. . . purpose 0..1 markdown Why this measure is defined
. . . usage 0..1 string markdown Describes the clinical usage of the measure
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . copyrightLabel 0..1 string Copyright holder and year(s)
. . . approvalDate 0..1 date When the measure was approved by publisher
. . . lastReviewDate 0..1 date When the measure was last reviewed by the publisher
. . . effectivePeriod Σ 0..1 Period When the measure is expected to be used
. . . topic XD 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc. etc
Binding: DefinitionTopic Definition Topic ( example ): High-level categorization of the definition, used for searching, sorting, and filtering.


. . . author 0..* ContactDetail Who authored the content
. . . editor 0..* ContactDetail Who edited the content
. . . reviewer 0..* ContactDetail Who reviewed the content
. . . endorser 0..* ContactDetail Who endorsed the content
. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc. etc
. . . library 0..* canonical ( Library ) Logic used by the measure
. . . disclaimer Σ 0..1 markdown Disclaimer for use of the measure or its referenced content
. . . scoring Σ 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort
Binding: MeasureScoring icon ( extensible ): The scoring type of the measure.

. . . compositeScoring scoringUnit Σ 0..1 CodeableConcept What units?
Binding: Measure Scoring Unit ( example )
... compositeScoring Σ 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted
Binding: CompositeMeasureScoring Composite Measure Scoring ( extensible ): The composite scoring method of the measure.

. . . type Σ 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType Measure Type ( extensible ): The type of measure (includes codes from 2.16.840.1.113883.1.11.20368).


. . . riskAdjustment Σ 0..1 string markdown How risk adjustment is applied for this measure
. . . rateAggregation Σ 0..1 string markdown How is rate aggregation performed for this measure
. . . rationale Σ 0..1 markdown Detailed description of why the measure exists
. . . clinicalRecommendationStatement Σ 0..1 markdown Summary of clinical guidelines
. . . improvementNotation Σ 0..1 CodeableConcept increase | decrease
Binding: MeasureImprovementNotation Measure Improvement Notation ( required ): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue.

. . . term 0..* BackboneElement Defined terms used in the measure documentation
. . . . definition id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?! Σ 0..* markdown Extension Defined terms used in the Extensions that cannot be ignored even if unrecognized
.... code 0..1 CodeableConcept What term?
Binding: Measure Definition Example ( example ): Codeable representations of measure documentation definition terms.

. . . . definition 0..1 markdown Meaning of the term
. . . guidance Σ XD 0..1 markdown Additional guidance for implementers (deprecated)
. . . group C icon 0..* BackboneElement Population criteria group
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . code . linkId C icon 0..1 string Unique id for group in measure
.... code 0..1 CodeableConcept Meaning of the group
Binding: MeasureGroupExample Measure Group Example ( example ): Example of measure groups.

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

..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference ( Group )
.... basis Σ 0..1 code Population basis
Binding: All FHIR Types ( required )
... . population scoring Σ 0..* 0..1 BackboneElement CodeableConcept Population criteria proportion | ratio | continuous-variable | cohort
Binding: MeasureScoring icon ( extensible )
.... scoringUnit Σ 0..1 CodeableConcept What units?
Binding: Measure Scoring Unit ( example )
. . . . rateAggregation Σ 0..1 markdown How is rate aggregation performed for this measure
. . . id . improvementNotation Σ 0..1 CodeableConcept increase | decrease
Binding: Measure Improvement Notation ( required )
.... library 0..* canonical ( Library ) Logic used by the measure group
.... population 0..* BackboneElement Population criteria
..... id 0..1 string Unique id for inter-element referencing
. . . . . extension 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . linkId C icon 0..1 string Unique id for population in measure
. . . . . code 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: MeasurePopulationType Measure Population Type ( extensible ): The type of population.

. . . . . description 0..1 string markdown The human readable description of this population criteria
. . . . . criteria 1..1 0..1 Expression The criteria that defines this population
. . . . . groupDefinition 0..1 Reference ( Group ) A group resource that defines this population
..... inputPopulationId 0..1 string Which population
.... . stratifier aggregateMethod 0..1 CodeableConcept Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count)
Binding: Measure Aggregate Method ( extensible )
.... stratifier C icon 0..* BackboneElement Stratifier criteria for the measure
. . . . . id 0..1 string Unique id for inter-element referencing
. . . . . extension 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . linkId C icon 0..1 string Unique id for stratifier in measure
. . . . . code C icon 0..1 CodeableConcept Meaning of the stratifier
Binding: MeasureStratifierExample Measure Stratifier Example ( example ): Meaning of the stratifier.

. . . . . description C icon 0..1 string markdown The human readable description of this stratifier
. . . . . criteria C icon 0..1 Expression How the measure should be stratified
. . . . . groupDefinition 0..1 Reference ( Group ) A group resource that defines this population
. . . . . component C icon 0..* BackboneElement Stratifier criteria component for the measure
. . . . . . id 0..1 string Unique id for inter-element referencing
. . . . . . extension 0..* Extension Additional content defined by implementations
. . . . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . . linkId C icon 0..1 string Unique id for stratifier component in measure
. . . . . . code 0..1 CodeableConcept Meaning of the stratifier component
Binding: MeasureStratifierExample Measure Stratifier Example ( example ): Meaning of the stratifier.

. . . . . . description 0..1 string markdown The human readable description of this stratifier component
. . . . . . criteria 1..1 0..1 Expression Component of how the measure should be stratified
. . supplementalData . . . . groupDefinition 0..1 Reference ( Group ) A group resource that defines this population
... supplementalData 0..* BackboneElement What other data should be reported with the measure
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . linkId C icon 0..1 string Unique id for supplementalData in measure
. . . . code 0..1 CodeableConcept Meaning of the supplemental data
Binding: MeasureSupplementalDataExample Measure Supplemental Data Example ( example ): Meaning of the supplemental data.

. . . . usage 0..* CodeableConcept supplemental-data | risk-adjustment-factor
Binding: MeasureDataUsage Measure Data Usage ( extensible ): The intended usage for supplemental data elements in the measure.


. . . . description 0..1 string markdown The human readable description of this supplemental data
. . . . criteria 1..1 Expression Expression describing additional data to be reported

doco Documentation for this format icon
<!-- Shareable Measure -->

<!-- ShareableMeasure -->doco


<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 icon   --></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 icon   --></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 icon
    "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.

0 .. *
Name Flags Card. Type Description & Constraints doco
. . Measure 1..1 Measure A quality measure definition
. . url . knowledgeCapability S 1..1 0..* uri code Canonical identifier for this measure, represented as a URI (globally unique) shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability ( required )
. . identifier . knowledgeRepresentationLevel S 0 .. * 0..* Identifier code Additional identifier for the measure narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level ( required )
. . version . artifactComment S 1..1 0..* string (Complex) Business version of the measure Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
. . . title version S 0..1 1..1 string Name for this Business version of the measure (human friendly)
. . experimental . versionAlgorithm[x] S 1..1 0 .. 1 boolean string , Coding For testing purposes, not real usage How to compare versions
. . . date name S 0..1 0 .. 1 dateTime string Date last changed Name for this measure (computer friendly)
. . publisher . title S 1..1 string Name of the publisher (organization or individual) for this measure (human friendly)
. . . contact experimental S 0 .. * 1 ContactDetail boolean Contact details for the publisher For testing purposes, not real usage
. . description . publisher 1..1 markdown Natural language description of the measure useContext S 0 .. * 1 UsageContext string The context that Name of the content is intended to support publisher/steward (organization or individual)
. . jurisdiction . description S 1..1 CodeableConcept markdown Intended jurisdiction for Natural language description of the measure (if applicable)

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Measure structure.

S 1..1 S S S
Name Flags Card. Type Description & Constraints doco
. . Measure I C icon 1..1 Measure A quality measure definition
. . . id Σ 0..1 id Logical id of this artifact
. . . meta Σ 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
. . . language 0..1 code Language of the resource content
Binding: Common All Languages ( preferred required ): IETF language tag for a human language

Additional Bindings Purpose All Languages Max Binding
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . Slices for extension 0..* Extension Additional content defined Extension
Slice: Unordered, Open by implementations value:url
. . . knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability ( required )
... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level ( required )
... artifactComment S 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
. . . url S Σ C icon 1..1 uri Canonical identifier for this measure, represented as a URI (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the measure
. . . version S Σ 1..1 string Business version of the measure
. . . versionAlgorithm[x] S Σ 0..1 How to compare versions
Binding: Version Algorithm ( extensible )
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
. . . name S Σ I C icon 1..1 0..1 string Name for this measure (computer friendly)
. . . title S Σ 0..1 1..1 string Name for this measure (human friendly)
. . . subtitle 0..1 string Subordinate title of the measure
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact.

. . . experimental S Σ 1..1 0..1 boolean For testing purposes, not real usage
. . . subject[x] 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: Subject type Participant Resource Types ( extensible ): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).

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


. . . purpose 0..1 markdown Why this measure is defined
. . . usage 0..1 string markdown Describes the clinical usage of the measure
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . copyrightLabel 0..1 string Copyright holder and year(s)
. . . approvalDate 0..1 date When the measure was approved by publisher
. . . lastReviewDate 0..1 date When the measure was last reviewed by the publisher
. . . effectivePeriod Σ 0..1 Period When the measure is expected to be used
. . . topic XD 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc. etc
Binding: DefinitionTopic Definition Topic ( example ): High-level categorization of the definition, used for searching, sorting, and filtering.


. . . author 0..* ContactDetail Who authored the content
. . . editor 0..* ContactDetail Who edited the content
. . . reviewer 0..* ContactDetail Who reviewed the content
. . . endorser 0..* ContactDetail Who endorsed the content
. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc. etc
. . . library 0..* canonical ( Library ) Logic used by the measure
. . . disclaimer Σ 0..1 markdown Disclaimer for use of the measure or its referenced content
. . . scoring Σ 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort
Binding: MeasureScoring icon ( extensible ): The scoring type of the measure.

. . . compositeScoring scoringUnit Σ 0..1 CodeableConcept What units?
Binding: Measure Scoring Unit ( example )
... compositeScoring Σ 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted
Binding: CompositeMeasureScoring Composite Measure Scoring ( extensible ): The composite scoring method of the measure.

. . . type Σ 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType Measure Type ( extensible ): The type of measure (includes codes from 2.16.840.1.113883.1.11.20368).


. . . riskAdjustment Σ 0..1 string markdown How risk adjustment is applied for this measure
. . . rateAggregation Σ 0..1 string markdown How is rate aggregation performed for this measure
. . . rationale Σ 0..1 markdown Detailed description of why the measure exists
. . . clinicalRecommendationStatement Σ 0..1 markdown Summary of clinical guidelines
. . . improvementNotation Σ 0..1 CodeableConcept increase | decrease
Binding: MeasureImprovementNotation Measure Improvement Notation ( required ): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue.

. . . term 0..* BackboneElement Defined terms used in the measure documentation
. . . . definition id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?! Σ 0..* markdown Extension Defined terms used in the Extensions that cannot be ignored even if unrecognized
.... code 0..1 CodeableConcept What term?
Binding: Measure Definition Example ( example ): Codeable representations of measure documentation definition terms.

. . . . definition 0..1 markdown Meaning of the term
. . . guidance Σ XD 0..1 markdown Additional guidance for implementers (deprecated)
. . . group C icon 0..* BackboneElement Population criteria group
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . code . linkId C icon 0..1 string Unique id for group in measure
.... code 0..1 CodeableConcept Meaning of the group
Binding: MeasureGroupExample Measure Group Example ( example ): Example of measure groups.

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

..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference ( Group )
.... basis Σ 0..1 code Population basis
Binding: All FHIR Types ( required )
... . population scoring Σ 0..* 0..1 BackboneElement CodeableConcept Population criteria proportion | ratio | continuous-variable | cohort
Binding: MeasureScoring icon ( extensible )
. . . . scoringUnit Σ 0..1 CodeableConcept What units?
Binding: Measure Scoring Unit ( example )
. . . id . rateAggregation Σ 0..1 markdown How is rate aggregation performed for this measure
.... improvementNotation Σ 0..1 CodeableConcept increase | decrease
Binding: Measure Improvement Notation ( required )
.... library 0..* canonical ( Library ) Logic used by the measure group
.... population 0..* BackboneElement Population criteria
..... id 0..1 string Unique id for inter-element referencing
. . . . . extension 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . linkId C icon 0..1 string Unique id for population in measure
. . . . . code 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: MeasurePopulationType Measure Population Type ( extensible ): The type of population.

. . . . . description 0..1 string markdown The human readable description of this population criteria
. . . . . criteria 1..1 0..1 Expression The criteria that defines this population
. . . . . groupDefinition 0..1 Reference ( Group ) A group resource that defines this population
..... inputPopulationId 0..1 string Which population
.... . stratifier aggregateMethod 0..1 CodeableConcept Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count)
Binding: Measure Aggregate Method ( extensible )
.... stratifier C icon 0..* BackboneElement Stratifier criteria for the measure
. . . . . id 0..1 string Unique id for inter-element referencing
. . . . . extension 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . linkId C icon 0..1 string Unique id for stratifier in measure
. . . . . code C icon 0..1 CodeableConcept Meaning of the stratifier
Binding: MeasureStratifierExample Measure Stratifier Example ( example ): Meaning of the stratifier.

. . . . . description C icon 0..1 string markdown The human readable description of this stratifier
. . . . . criteria C icon 0..1 Expression How the measure should be stratified
. . . . . groupDefinition 0..1 Reference ( Group ) A group resource that defines this population
. . . . . component C icon 0..* BackboneElement Stratifier criteria component for the measure
. . . . . . id 0..1 string Unique id for inter-element referencing
. . . . . . extension 0..* Extension Additional content defined by implementations
. . . . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . . linkId C icon 0..1 string Unique id for stratifier component in measure
. . . . . . code 0..1 CodeableConcept Meaning of the stratifier component
Binding: MeasureStratifierExample Measure Stratifier Example ( example ): Meaning of the stratifier.

. . . . . . description 0..1 string markdown The human readable description of this stratifier component
. . . . . . criteria 1..1 0..1 Expression Component of how the measure should be stratified
. . supplementalData . . . . groupDefinition 0..1 Reference ( Group ) A group resource that defines this population
... supplementalData 0..* BackboneElement What other data should be reported with the measure
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . linkId C icon 0..1 string Unique id for supplementalData in measure
. . . . code 0..1 CodeableConcept Meaning of the supplemental data
Binding: MeasureSupplementalDataExample Measure Supplemental Data Example ( example ): Meaning of the supplemental data.

. . . . usage 0..* CodeableConcept supplemental-data | risk-adjustment-factor
Binding: MeasureDataUsage Measure Data Usage ( extensible ): The intended usage for supplemental data elements in the measure.


. . . . description 0..1 string markdown The human readable description of this supplemental data
. . . . criteria 1..1 Expression Expression describing additional data to be reported

doco Documentation for this format icon

XML Template

<!-- Shareable Measure -->

<!-- ShareableMeasure -->doco


<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 icon   --></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 icon   --></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 icon
    "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 Common All Languages preferred required Common All Languages
Measure.versionAlgorithm[x] Version Algorithm extensible Version Algorithm
Measure.status PublicationStatus required PublicationStatus
Measure.subject[x] Subject type Participant Resource Types extensible Subject type Participant Resource Types
Measure.basis All FHIR Types required All FHIR Types
Measure.jurisdiction Jurisdiction ValueSet extensible Jurisdiction ValueSet
Measure.topic DefinitionTopic Definition Topic example DefinitionTopic Definition Topic
Measure.scoring MeasureScoring extensible MeasureScoring icon
Measure.scoringUnit Measure Scoring Unit example Measure Scoring Unit
Measure.compositeScoring CompositeMeasureScoring Composite Measure Scoring extensible CompositeMeasureScoring Composite Measure Scoring
Measure.type MeasureType Measure Type extensible MeasureType Measure Type
Measure.improvementNotation MeasureImprovementNotation Measure Improvement Notation required MeasureImprovementNotation Measure Improvement Notation
Measure.term.code Measure Definition Example example Measure Definition Example
Measure.group.code MeasureGroupExample Measure Group Example example MeasureGroupExample Measure Group 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 icon
Measure.group.scoringUnit Measure Scoring Unit example Measure Scoring Unit
Measure.group.improvementNotation Measure Improvement Notation required Measure Improvement Notation
Measure.group.population.code MeasurePopulationType Measure Population Type extensible MeasurePopulationType Measure Population Type
Measure.group.population.aggregateMethod Measure Aggregate Method extensible Measure Aggregate Method
Measure.group.stratifier.code MeasureStratifierExample Measure Stratifier Example example MeasureStratifierExample Measure Stratifier Example
Measure.group.stratifier.component.code MeasureStratifierExample Measure Stratifier Example example MeasureStratifierExample Measure Stratifier Example
Measure.supplementalData.code MeasureSupplementalDataExample Measure Supplemental Data Example example MeasureSupplementalDataExample Measure Supplemental Data Example
Measure.supplementalData.usage MeasureDataUsage Measure Data Usage extensible MeasureDataUsage Measure Data Usage
. .