Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). 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 icon Work Group Maturity Level: 0Trial Use Use Context: Any

The 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

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 elements
Must-Support: 6 elements

This indicates the differences between this profile and the base Measure structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Measure 1..1MeasureA quality measure definition
... url 1..1uriCanonical identifier for this measure, represented as a URI (globally unique)
... identifier S0..*IdentifierAdditional identifier for the measure
... version 1..1stringBusiness version of the measure
... title S0..1stringName for this measure (human friendly)
... experimental 1..1booleanFor testing purposes, not real usage
... date S0..1dateTimeDate last changed
... publisher 1..1stringName of the publisher/steward (organization or individual)
... contact S0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the measure
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for 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.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Measure C icon1..1MeasureA quality measure definition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC icon1..1uriCanonical identifier for this measure, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the measure
... version Σ1..1stringBusiness version of the measure
... name ΣC icon1..1stringName for this measure (computer friendly)
... title SΣ0..1stringName for this measure (human friendly)
... subtitle 0..1stringSubordinate title of the measure
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... subject[x] 0..1E.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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... basis Σ0..1codePopulation basis
Binding: All FHIR Types (required)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher/steward (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the measure
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for measure (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this measure is defined
... usage 0..1stringDescribes the clinical usage of the measure
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the measure was approved by publisher
... lastReviewDate 0..1dateWhen the measure was last reviewed
... effectivePeriod Σ0..1PeriodWhen the measure is expected to be used
... topic 0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... library 0..*canonical(Library)Logic used by the measure
... disclaimer Σ0..1markdownDisclaimer for use of the measure or its referenced content
... scoring Σ0..1CodeableConceptproportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible): The scoring type of the measure.

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

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


... riskAdjustment Σ0..1stringHow risk adjustment is applied for this measure
... rateAggregation Σ0..1stringHow is rate aggregation performed for this measure
... rationale Σ0..1markdownDetailed description of why the measure exists
... clinicalRecommendationStatement Σ0..1markdownSummary of clinical guidelines
... improvementNotation Σ0..1CodeableConceptincrease | decrease
Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue.

... term 0..*BackboneElementDefined terms used in the measure documentation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptWhat term?
Binding: MeasureDefinitionExample (example): Codeable representations of measure definition terms.

.... definition 0..1markdownMeaning of the term
... guidance Σ0..1markdownAdditional guidance for implementers
... group 0..*BackboneElementPopulation criteria group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptMeaning of the group
Binding: MeasureGroupExample (example): Example of measure groups.

.... description 0..1stringSummary description
.... type Σ0..*CodeableConceptprocess | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType (extensible)
.... basis Σ0..1codePopulation basis
Binding: All FHIR Types (required)
.... scoring Σ0..1CodeableConceptproportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible)
.... scoringUnit Σ0..1CodeableConceptWhat units?
Binding: Measure Scoring Unit (example)
.... improvementNotation Σ0..1CodeableConceptincrease | decrease
Binding: MeasureImprovementNotation (required)
.... population 0..*BackboneElementPopulation criteria
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1CodeableConceptinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: MeasurePopulationType (extensible): The type of population.

..... description 0..1stringThe human readable description of this population criteria
..... criteria 1..1ExpressionThe criteria that defines this population
..... inputPopulationId 0..1stringWhich population
..... aggregateMethod 0..1CodeableConceptAggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count)
Binding: Measure Aggregate Method (extensible)
.... stratifier 0..*BackboneElementStratifier criteria for the measure
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1CodeableConceptMeaning of the stratifier
Binding: MeasureStratifierExample (example): Meaning of the stratifier.

..... description 0..1stringThe human readable description of this stratifier
..... criteria 0..1ExpressionHow the measure should be stratified
..... component 0..*BackboneElementStratifier criteria component for the measure
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 0..1CodeableConceptMeaning of the stratifier component
Binding: MeasureStratifierExample (example): Meaning of the stratifier.

...... description 0..1stringThe human readable description of this stratifier component
...... criteria 1..1ExpressionComponent of how the measure should be stratified
... supplementalData 0..*BackboneElementWhat other data should be reported with the measure
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptMeaning of the supplemental data
Binding: MeasureSupplementalDataExample (example): Meaning of the supplemental data.

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


.... description 0..1stringThe human readable description of this supplemental data
.... criteria 1..1ExpressionExpression describing additional data to be reported

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

<Measure xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <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><!-- 0..* Resource Contained, inline Resources --></contained>
 <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 -->
 <name value="[string]"/><!-- I 1..1 Name for this measure (computer friendly) -->
 <title value="[string]"/><!-- I 0..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 1..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 1..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><!-- I 0..* CodeableConcept Intended jurisdiction for measure (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this measure is defined -->
 <usage value="[string]"/><!-- I 0..1 Describes the clinical usage of the measure -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <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 -->
 <effectivePeriod><!-- I 0..1 Period 
     When the measure is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the content --></author>
 <editor><!-- I 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- I 0..* RelatedArtifact 
     Additional documentation, citations, etc. --></relatedArtifact>
 <library value="[canonical]"/><!-- I 0..* Logic used by the measure -->
 <disclaimer value="[markdown]"/><!-- I 0..1 Disclaimer for use of the measure or its referenced content -->
 <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort   --></scoring>
 <scoringUnit><!-- I 0..1 CodeableConcept What units?   --></scoringUnit>
 <compositeScoring><!-- I 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted   --></compositeScoring>
 <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite   --></type>
 <riskAdjustment value="[string]"/><!-- I 0..1 How risk adjustment is applied for this measure -->
 <rateAggregation value="[string]"/><!-- 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 -->
  <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 -->
 <group> I 0..* BackboneElement  <!-- I 0..* Population criteria group -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 0..1 CodeableConcept Meaning of the group   --></code>
  <description value="[string]"/><!-- I 0..1 Summary description -->
  <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite   --></type>
  <basis value="[code]"/><!-- I 0..1 Population basis   -->
  <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort   --></scoring>
  <scoringUnit><!-- I 0..1 CodeableConcept What units?   --></scoringUnit>
  <improvementNotation><!-- I 0..1 CodeableConcept increase | decrease   --></improvementNotation>
  <population> I 0..* BackboneElement  <!-- I 0..* Population criteria -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <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="[string]"/><!-- I 0..1 The human readable description of this population criteria -->
   <criteria><!-- I 1..1 Expression 
       The criteria that defines this population --></criteria>
   <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>
  <stratifier> I 0..* BackboneElement  <!-- I 0..* Stratifier criteria for the measure -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code><!-- I 0..1 CodeableConcept Meaning of the stratifier   --></code>
   <description value="[string]"/><!-- I 0..1 The human readable description of this stratifier -->
   <criteria><!-- I 0..1 Expression 
       How the measure should be stratified --></criteria>
   <component> I 0..* BackboneElement  <!-- I 0..* Stratifier criteria component for the measure -->
    <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code><!-- I 0..1 CodeableConcept Meaning of the stratifier component   --></code>
    <description value="[string]"/><!-- I 0..1 
        The human readable description of this stratifier component -->
    <criteria><!-- I 1..1 Expression 
        Component of how the measure should be stratified --></criteria>
   </component>
  </stratifier>
 </group>
 <supplementalData> I 0..* BackboneElement  <!-- I 0..* What other data should be reported with the measure -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 0..1 CodeableConcept Meaning of the supplemental data   --></code>
  <usage><!-- I 0..* CodeableConcept supplemental-data | risk-adjustment-factor   --></usage>
  <description value="[string]"/><!-- 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>
{ // Shareable Measure
  // from Element: extension
    "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
    "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
    "name" : "<string>", // I R! Name for this measure (computer friendly)
    "title" : "<string>", // IName for this measure (human friendly)
    "subtitle" : "<string>", // ISubordinate title of the measure
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // I R! For 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>", // I R! Name 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" : "<string>", // IDescribes the clinical usage of the measure
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "approvalDate" : "<date>", // IWhen the measure was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the measure was last reviewed
    "effectivePeriod" : { Period }, // IWhen the measure is expected to be used
    "topic" : [{ CodeableConcept }], // IThe category of the measure, such as Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // IWho authored the content
    "editor" : [{ ContactDetail }], // IWho edited the content
    "reviewer" : [{ ContactDetail }], // IWho reviewed the content
    "endorser" : [{ ContactDetail }], // IWho endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc.
    "library" : ["<canonical>"], // ILogic used by the measure
    "disclaimer" : "<markdown>", // IDisclaimer for use of the measure or its referenced content
    "scoring" : { CodeableConcept }, // Iproportion | ratio | continuous-variable | cohort
    "scoringUnit" : { CodeableConcept }, // IWhat units?
    "compositeScoring" : { CodeableConcept }, // Iopportunity | all-or-nothing | linear | weighted
    "type" : [{ CodeableConcept }], // Iprocess | outcome | structure | patient-reported-outcome | composite
    "riskAdjustment" : "<string>", // IHow risk adjustment is applied for this measure
    "rateAggregation" : "<string>", // 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
    "group" : [{ BackboneElement }], // IPopulation criteria group
    "supplementalData" : [{ BackboneElement }] // IWhat other data should be reported with the measure
  }

This structure is derived from Measure.

Summary

Mandatory: 6 elements
Must-Support: 6 elements

Differential View

This indicates the differences between this profile and the base Measure structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Measure 1..1MeasureA quality measure definition
... url 1..1uriCanonical identifier for this measure, represented as a URI (globally unique)
... identifier S0..*IdentifierAdditional identifier for the measure
... version 1..1stringBusiness version of the measure
... title S0..1stringName for this measure (human friendly)
... experimental 1..1booleanFor testing purposes, not real usage
... date S0..1dateTimeDate last changed
... publisher 1..1stringName of the publisher/steward (organization or individual)
... contact S0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the measure
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for 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.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Measure C icon1..1MeasureA quality measure definition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC icon1..1uriCanonical identifier for this measure, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the measure
... version Σ1..1stringBusiness version of the measure
... name ΣC icon1..1stringName for this measure (computer friendly)
... title SΣ0..1stringName for this measure (human friendly)
... subtitle 0..1stringSubordinate title of the measure
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... subject[x] 0..1E.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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... basis Σ0..1codePopulation basis
Binding: All FHIR Types (required)
... date SΣ0..1dateTimeDate last changed
... publisher Σ1..1stringName of the publisher/steward (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the measure
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for measure (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this measure is defined
... usage 0..1stringDescribes the clinical usage of the measure
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the measure was approved by publisher
... lastReviewDate 0..1dateWhen the measure was last reviewed
... effectivePeriod Σ0..1PeriodWhen the measure is expected to be used
... topic 0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... library 0..*canonical(Library)Logic used by the measure
... disclaimer Σ0..1markdownDisclaimer for use of the measure or its referenced content
... scoring Σ0..1CodeableConceptproportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible): The scoring type of the measure.

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

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


... riskAdjustment Σ0..1stringHow risk adjustment is applied for this measure
... rateAggregation Σ0..1stringHow is rate aggregation performed for this measure
... rationale Σ0..1markdownDetailed description of why the measure exists
... clinicalRecommendationStatement Σ0..1markdownSummary of clinical guidelines
... improvementNotation Σ0..1CodeableConceptincrease | decrease
Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue.

... term 0..*BackboneElementDefined terms used in the measure documentation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptWhat term?
Binding: MeasureDefinitionExample (example): Codeable representations of measure definition terms.

.... definition 0..1markdownMeaning of the term
... guidance Σ0..1markdownAdditional guidance for implementers
... group 0..*BackboneElementPopulation criteria group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptMeaning of the group
Binding: MeasureGroupExample (example): Example of measure groups.

.... description 0..1stringSummary description
.... type Σ0..*CodeableConceptprocess | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType (extensible)
.... basis Σ0..1codePopulation basis
Binding: All FHIR Types (required)
.... scoring Σ0..1CodeableConceptproportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible)
.... scoringUnit Σ0..1CodeableConceptWhat units?
Binding: Measure Scoring Unit (example)
.... improvementNotation Σ0..1CodeableConceptincrease | decrease
Binding: MeasureImprovementNotation (required)
.... population 0..*BackboneElementPopulation criteria
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1CodeableConceptinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: MeasurePopulationType (extensible): The type of population.

..... description 0..1stringThe human readable description of this population criteria
..... criteria 1..1ExpressionThe criteria that defines this population
..... inputPopulationId 0..1stringWhich population
..... aggregateMethod 0..1CodeableConceptAggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count)
Binding: Measure Aggregate Method (extensible)
.... stratifier 0..*BackboneElementStratifier criteria for the measure
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1CodeableConceptMeaning of the stratifier
Binding: MeasureStratifierExample (example): Meaning of the stratifier.

..... description 0..1stringThe human readable description of this stratifier
..... criteria 0..1ExpressionHow the measure should be stratified
..... component 0..*BackboneElementStratifier criteria component for the measure
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 0..1CodeableConceptMeaning of the stratifier component
Binding: MeasureStratifierExample (example): Meaning of the stratifier.

...... description 0..1stringThe human readable description of this stratifier component
...... criteria 1..1ExpressionComponent of how the measure should be stratified
... supplementalData 0..*BackboneElementWhat other data should be reported with the measure
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptMeaning of the supplemental data
Binding: MeasureSupplementalDataExample (example): Meaning of the supplemental data.

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


.... description 0..1stringThe human readable description of this supplemental data
.... criteria 1..1ExpressionExpression describing additional data to be reported

doco Documentation for this format icon

XML Template

<!-- Shareable Measure -->doco

<Measure xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <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><!-- 0..* Resource Contained, inline Resources --></contained>
 <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 -->
 <name value="[string]"/><!-- I 1..1 Name for this measure (computer friendly) -->
 <title value="[string]"/><!-- I 0..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 1..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 1..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><!-- I 0..* CodeableConcept Intended jurisdiction for measure (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this measure is defined -->
 <usage value="[string]"/><!-- I 0..1 Describes the clinical usage of the measure -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <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 -->
 <effectivePeriod><!-- I 0..1 Period 
     When the measure is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the content --></author>
 <editor><!-- I 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- I 0..* RelatedArtifact 
     Additional documentation, citations, etc. --></relatedArtifact>
 <library value="[canonical]"/><!-- I 0..* Logic used by the measure -->
 <disclaimer value="[markdown]"/><!-- I 0..1 Disclaimer for use of the measure or its referenced content -->
 <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort   --></scoring>
 <scoringUnit><!-- I 0..1 CodeableConcept What units?   --></scoringUnit>
 <compositeScoring><!-- I 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted   --></compositeScoring>
 <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite   --></type>
 <riskAdjustment value="[string]"/><!-- I 0..1 How risk adjustment is applied for this measure -->
 <rateAggregation value="[string]"/><!-- 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 -->
  <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 -->
 <group> I 0..* BackboneElement  <!-- I 0..* Population criteria group -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 0..1 CodeableConcept Meaning of the group   --></code>
  <description value="[string]"/><!-- I 0..1 Summary description -->
  <type><!-- I 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite   --></type>
  <basis value="[code]"/><!-- I 0..1 Population basis   -->
  <scoring><!-- I 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort   --></scoring>
  <scoringUnit><!-- I 0..1 CodeableConcept What units?   --></scoringUnit>
  <improvementNotation><!-- I 0..1 CodeableConcept increase | decrease   --></improvementNotation>
  <population> I 0..* BackboneElement  <!-- I 0..* Population criteria -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <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="[string]"/><!-- I 0..1 The human readable description of this population criteria -->
   <criteria><!-- I 1..1 Expression 
       The criteria that defines this population --></criteria>
   <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>
  <stratifier> I 0..* BackboneElement  <!-- I 0..* Stratifier criteria for the measure -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code><!-- I 0..1 CodeableConcept Meaning of the stratifier   --></code>
   <description value="[string]"/><!-- I 0..1 The human readable description of this stratifier -->
   <criteria><!-- I 0..1 Expression 
       How the measure should be stratified --></criteria>
   <component> I 0..* BackboneElement  <!-- I 0..* Stratifier criteria component for the measure -->
    <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code><!-- I 0..1 CodeableConcept Meaning of the stratifier component   --></code>
    <description value="[string]"/><!-- I 0..1 
        The human readable description of this stratifier component -->
    <criteria><!-- I 1..1 Expression 
        Component of how the measure should be stratified --></criteria>
   </component>
  </stratifier>
 </group>
 <supplementalData> I 0..* BackboneElement  <!-- I 0..* What other data should be reported with the measure -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 0..1 CodeableConcept Meaning of the supplemental data   --></code>
  <usage><!-- I 0..* CodeableConcept supplemental-data | risk-adjustment-factor   --></usage>
  <description value="[string]"/><!-- 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

{ // Shareable Measure
  // from Element: extension
    "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
    "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
    "name" : "<string>", // I R! Name for this measure (computer friendly)
    "title" : "<string>", // IName for this measure (human friendly)
    "subtitle" : "<string>", // ISubordinate title of the measure
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // I R! For 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>", // I R! Name 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" : "<string>", // IDescribes the clinical usage of the measure
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "approvalDate" : "<date>", // IWhen the measure was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the measure was last reviewed
    "effectivePeriod" : { Period }, // IWhen the measure is expected to be used
    "topic" : [{ CodeableConcept }], // IThe category of the measure, such as Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // IWho authored the content
    "editor" : [{ ContactDetail }], // IWho edited the content
    "reviewer" : [{ ContactDetail }], // IWho reviewed the content
    "endorser" : [{ ContactDetail }], // IWho endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc.
    "library" : ["<canonical>"], // ILogic used by the measure
    "disclaimer" : "<markdown>", // IDisclaimer for use of the measure or its referenced content
    "scoring" : { CodeableConcept }, // Iproportion | ratio | continuous-variable | cohort
    "scoringUnit" : { CodeableConcept }, // IWhat units?
    "compositeScoring" : { CodeableConcept }, // Iopportunity | all-or-nothing | linear | weighted
    "type" : [{ CodeableConcept }], // Iprocess | outcome | structure | patient-reported-outcome | composite
    "riskAdjustment" : "<string>", // IHow risk adjustment is applied for this measure
    "rateAggregation" : "<string>", // 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
    "group" : [{ BackboneElement }], // IPopulation criteria group
    "supplementalData" : [{ BackboneElement }] // IWhat other data should be reported with the measure
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

PathNameConformanceValueSet
Measure.languageCommon LanguagespreferredCommon Languages
Measure.statusPublicationStatusrequiredPublicationStatus
Measure.subject[x]Participant Resource TypesextensibleParticipant Resource Types
Measure.basisAll FHIR TypesrequiredAll FHIR Types
Measure.jurisdictionJurisdiction ValueSetextensibleJurisdiction ValueSet
Measure.topicDefinitionTopicexampleDefinitionTopic
Measure.scoringMeasureScoringextensibleMeasureScoring
Measure.scoringUnitMeasure Scoring UnitexampleMeasure Scoring Unit
Measure.compositeScoringCompositeMeasureScoringextensibleCompositeMeasureScoring
Measure.typeMeasureTypeextensibleMeasureType
Measure.improvementNotationMeasureImprovementNotationrequiredMeasureImprovementNotation
Measure.term.codeMeasureDefinitionExampleexampleMeasureDefinitionExample
Measure.group.codeMeasureGroupExampleexampleMeasureGroupExample
Measure.group.typeMeasureTypeextensibleMeasureType
Measure.group.basisAll FHIR TypesrequiredAll FHIR Types
Measure.group.scoringMeasureScoringextensibleMeasureScoring
Measure.group.scoringUnitMeasure Scoring UnitexampleMeasure Scoring Unit
Measure.group.improvementNotationMeasureImprovementNotationrequiredMeasureImprovementNotation
Measure.group.population.codeMeasurePopulationTypeextensibleMeasurePopulationType
Measure.group.population.aggregateMethodMeasure Aggregate MethodextensibleMeasure Aggregate Method
Measure.group.stratifier.codeMeasureStratifierExampleexampleMeasureStratifierExample
Measure.group.stratifier.component.codeMeasureStratifierExampleexampleMeasureStratifierExample
Measure.supplementalData.codeMeasureSupplementalDataExampleexampleMeasureSupplementalDataExample
Measure.supplementalData.usageMeasureDataUsageextensibleMeasureDataUsage
.