Release 4

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

Clinical Quality Information Work Group Maturity Level: 1Trial Use Use Context: Any

The official URL for this profile is:

http://hl7.org/fhir/StructureDefinition/shareablemeasure

Enforces the minimum information set for the measure metadata required by HL7 and other organizations that share and publish measures

This profile was published on [no date] as a draft by HL7.

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

This structure is derived from Measure.

Summary

Mandatory: 6 elements
Must-Support: 6 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure I1..1A quality measure definition
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI1..1uriCanonical identifier for this measure, represented as a URI (globally unique)
... identifier SΣI0..*IdentifierAdditional identifier for the measure
... version ΣI1..1stringBusiness version of the measure
... name ΣI1..1stringName for this measure (computer friendly)
... title SΣI0..1stringName for this measure (human friendly)
... subtitle I0..1stringSubordinate title of the measure
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI1..1booleanFor testing purposes, not real usage
... subject[x] I0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: Subject type (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(group.html)
... date SΣI0..1dateTimeDate last changed
... publisher ΣI1..1stringName of the publisher (organization or individual)
... contact SΣI0..*ContactDetailContact details for the publisher
... description ΣI1..1markdownNatural language description of the measure
... useContext SΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣI0..*CodeableConceptIntended jurisdiction for measure (if applicable)
Binding: Jurisdiction (extensible)
... purpose I0..1markdownWhy this measure is defined
... usage I0..1stringDescribes the clinical usage of the measure
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the measure was approved by publisher
... lastReviewDate I0..1dateWhen the measure was last reviewed
... effectivePeriod ΣI0..1PeriodWhen the measure is expected to be used
... topic I0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact I0..*RelatedArtifactAdditional documentation, citations, etc.
... library I0..*canonical(Library)Logic used by the measure
... disclaimer ΣI0..1markdownDisclaimer for use of the measure or its referenced content
... scoring ΣI0..1CodeableConceptproportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible)
... compositeScoring ΣI0..1CodeableConceptopportunity | all-or-nothing | linear | weighted
Binding: CompositeMeasureScoring (extensible)
... type ΣI0..*CodeableConceptprocess | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType (extensible)
... riskAdjustment ΣI0..1stringHow risk adjustment is applied for this measure
... rateAggregation ΣI0..1stringHow is rate aggregation performed for this measure
... rationale ΣI0..1markdownDetailed description of why the measure exists
... clinicalRecommendationStatement ΣI0..1markdownSummary of clinical guidelines
... improvementNotation ΣI0..1CodeableConceptincrease | decrease
Binding: MeasureImprovementNotation (required)
... definition ΣI0..*markdownDefined terms used in the measure documentation
... guidance ΣI0..1markdownAdditional guidance for implementers
... group I0..*BackboneElementPopulation criteria group
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code I0..1CodeableConceptMeaning of the group
.... description I0..1stringSummary description
.... population I0..*BackboneElementPopulation criteria
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code I0..1CodeableConceptinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: MeasurePopulationType (extensible)
..... description I0..1stringThe human readable description of this population criteria
..... criteria I1..1ExpressionThe criteria that defines this population
.... stratifier I0..*BackboneElementStratifier criteria for the measure
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code I0..1CodeableConceptMeaning of the stratifier
..... description I0..1stringThe human readable description of this stratifier
..... criteria I0..1ExpressionHow the measure should be stratified
..... component I0..*BackboneElementStratifier criteria component for the measure
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code I0..1CodeableConceptMeaning of the stratifier component
...... description I0..1stringThe human readable description of this stratifier component
...... criteria I1..1ExpressionComponent of how the measure should be stratified
... supplementalData I0..*BackboneElementWhat other data should be reported with the measure
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code I0..1CodeableConceptMeaning of the supplemental data
.... usage I0..*CodeableConceptsupplemental-data | risk-adjustment-factor
Binding: MeasureDataUsage (extensible)
.... description I0..1stringThe human readable description of this supplemental data
.... criteria I1..1ExpressionExpression describing additional data to be reported

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

<Measure xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id><!-- 0..1 string Logical id of this artifact --></id>
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..1 Canonical identifier for this measure, represented as a URI (globally unique) -->
 <identifier><!-- ?? 0..* Identifier Additional identifier for the measure --></identifier>
 <version value="[string]"/><!-- ?? 1..1 Business version of the measure -->
 <name value="[string]"/><!-- ?? 1..1 Name for this measure (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this measure (human friendly) -->
 <subtitle value="[string]"/><!-- ?? 0..1 Subordinate title of the measure -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device   --></subject[x]>
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..1 Natural language description of the measure -->
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for measure (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this measure is defined -->
 <usage value="[string]"/><!-- ?? 0..1 Describes the clinical usage of the measure -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- ?? 0..1 When the measure was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- ?? 0..1 When the measure was last reviewed -->
 <effectivePeriod><!-- ?? 0..1 Period 
     When the measure is expected to be used --></effectivePeriod>
 <topic><!-- ?? 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- ?? 0..* ContactDetail Who authored the content --></author>
 <editor><!-- ?? 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- ?? 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- ?? 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- ?? 0..* RelatedArtifact 
     Additional documentation, citations, etc. --></relatedArtifact>
 <library value="[canonical]"/><!-- ?? 0..* Logic used by the measure -->
 <disclaimer value="[markdown]"/><!-- ?? 0..1 Disclaimer for use of the measure or its referenced content -->
 <scoring><!-- ?? 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort   --></scoring>
 <compositeScoring><!-- ?? 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted   --></compositeScoring>
 <type><!-- ?? 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite   --></type>
 <riskAdjustment value="[string]"/><!-- ?? 0..1 How risk adjustment is applied for this measure -->
 <rateAggregation value="[string]"/><!-- ?? 0..1 How is rate aggregation performed for this measure -->
 <rationale value="[markdown]"/><!-- ?? 0..1 Detailed description of why the measure exists -->
 <clinicalRecommendationStatement value="[markdown]"/><!-- ?? 0..1 Summary of clinical guidelines -->
 <improvementNotation><!-- ?? 0..1 CodeableConcept increase | decrease   --></improvementNotation>
 <definition value="[markdown]"/><!-- ?? 0..* Defined terms used in the measure documentation -->
 <guidance value="[markdown]"/><!-- ?? 0..1 Additional guidance for implementers -->
 <group> ?? 0..* BackboneElement  <!-- ?? 0..* Population criteria group -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- ?? 0..1 CodeableConcept Meaning of the group --></code>
  <description value="[string]"/><!-- ?? 0..1 Summary description -->
  <population> ?? 0..* BackboneElement  <!-- ?? 0..* Population criteria -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code><!-- ?? 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation   --></code>
   <description value="[string]"/><!-- ?? 0..1 The human readable description of this population criteria -->
   <criteria><!-- ?? 1..1 Expression 
       The criteria that defines this population --></criteria>
  </population>
  <stratifier> ?? 0..* BackboneElement  <!-- ?? 0..* Stratifier criteria for the measure -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code><!-- ?? 0..1 CodeableConcept 
       Meaning of the stratifier --></code>
   <description value="[string]"/><!-- ?? 0..1 The human readable description of this stratifier -->
   <criteria><!-- ?? 0..1 Expression 
       How the measure should be stratified --></criteria>
   <component> ?? 0..* BackboneElement  <!-- ?? 0..* Stratifier criteria component for the measure -->
    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code><!-- ?? 0..1 CodeableConcept 
        Meaning of the stratifier component --></code>
    <description value="[string]"/><!-- ?? 0..1 
        The human readable description of this stratifier component -->
    <criteria><!-- ?? 1..1 Expression 
        Component of how the measure should be stratified --></criteria>
   </component>
  </stratifier>
 </group>
 <supplementalData> ?? 0..* BackboneElement  <!-- ?? 0..* What other data should be reported with the measure -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- ?? 0..1 CodeableConcept 
      Meaning of the supplemental data --></code>
  <usage><!-- ?? 0..* CodeableConcept supplemental-data | risk-adjustment-factor   --></usage>
  <description value="[string]"/><!-- ?? 0..1 The human readable description of this supplemental data -->
  <criteria><!-- ?? 1..1 Expression 
      Expression describing additional data to be reported --></criteria>
 </supplementalData>
</Measure>
{ // Shareable Measure
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this measure, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the measure
    "version" : "<string>", // C? R! Business version of the measure
    "name" : "<string>", // C? R! Name for this measure (computer friendly)
    "title" : "<string>", // C?Name for this measure (human friendly)
    "subtitle" : "<string>", // C?Subordinate title of the measure
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
// value[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept }, // C?E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    "subjectReference" : { Reference(Group) }, // C?E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the measure
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for measure (if applicable)
    "purpose" : "<markdown>", // C?Why this measure is defined
    "usage" : "<string>", // C?Describes the clinical usage of the measure
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the measure was approved by publisher
    "lastReviewDate" : "<date>", // C?When the measure was last reviewed
    "effectivePeriod" : { Period }, // C?When the measure is expected to be used
    "topic" : [{ CodeableConcept }], // C?The category of the measure, such as Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
    "library" : ["<canonical>"], // C?Logic used by the measure
    "disclaimer" : "<markdown>", // C?Disclaimer for use of the measure or its referenced content
    "scoring" : { CodeableConcept }, // C?proportion | ratio | continuous-variable | cohort
    "compositeScoring" : { CodeableConcept }, // C?opportunity | all-or-nothing | linear | weighted
    "type" : [{ CodeableConcept }], // C?process | outcome | structure | patient-reported-outcome | composite
    "riskAdjustment" : "<string>", // C?How risk adjustment is applied for this measure
    "rateAggregation" : "<string>", // C?How is rate aggregation performed for this measure
    "rationale" : "<markdown>", // C?Detailed description of why the measure exists
    "clinicalRecommendationStatement" : "<markdown>", // C?Summary of clinical guidelines
    "improvementNotation" : { CodeableConcept }, // C?increase | decrease
    "definition" : ["<markdown>"], // C?Defined terms used in the measure documentation
    "guidance" : "<markdown>", // C?Additional guidance for implementers
    "group" : [{ BackboneElement }] // C?Population criteria group
    "supplementalData" : [{ BackboneElement }], // C?What other data should be reported with the measure
  }

This structure is derived from Measure.

Summary

Mandatory: 6 elements
Must-Support: 6 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure I1..1A quality measure definition
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI1..1uriCanonical identifier for this measure, represented as a URI (globally unique)
... identifier SΣI0..*IdentifierAdditional identifier for the measure
... version ΣI1..1stringBusiness version of the measure
... name ΣI1..1stringName for this measure (computer friendly)
... title SΣI0..1stringName for this measure (human friendly)
... subtitle I0..1stringSubordinate title of the measure
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ΣI1..1booleanFor testing purposes, not real usage
... subject[x] I0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: Subject type (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(group.html)
... date SΣI0..1dateTimeDate last changed
... publisher ΣI1..1stringName of the publisher (organization or individual)
... contact SΣI0..*ContactDetailContact details for the publisher
... description ΣI1..1markdownNatural language description of the measure
... useContext SΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣI0..*CodeableConceptIntended jurisdiction for measure (if applicable)
Binding: Jurisdiction (extensible)
... purpose I0..1markdownWhy this measure is defined
... usage I0..1stringDescribes the clinical usage of the measure
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the measure was approved by publisher
... lastReviewDate I0..1dateWhen the measure was last reviewed
... effectivePeriod ΣI0..1PeriodWhen the measure is expected to be used
... topic I0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact I0..*RelatedArtifactAdditional documentation, citations, etc.
... library I0..*canonical(Library)Logic used by the measure
... disclaimer ΣI0..1markdownDisclaimer for use of the measure or its referenced content
... scoring ΣI0..1CodeableConceptproportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible)
... compositeScoring ΣI0..1CodeableConceptopportunity | all-or-nothing | linear | weighted
Binding: CompositeMeasureScoring (extensible)
... type ΣI0..*CodeableConceptprocess | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType (extensible)
... riskAdjustment ΣI0..1stringHow risk adjustment is applied for this measure
... rateAggregation ΣI0..1stringHow is rate aggregation performed for this measure
... rationale ΣI0..1markdownDetailed description of why the measure exists
... clinicalRecommendationStatement ΣI0..1markdownSummary of clinical guidelines
... improvementNotation ΣI0..1CodeableConceptincrease | decrease
Binding: MeasureImprovementNotation (required)
... definition ΣI0..*markdownDefined terms used in the measure documentation
... guidance ΣI0..1markdownAdditional guidance for implementers
... group I0..*BackboneElementPopulation criteria group
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code I0..1CodeableConceptMeaning of the group
.... description I0..1stringSummary description
.... population I0..*BackboneElementPopulation criteria
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code I0..1CodeableConceptinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: MeasurePopulationType (extensible)
..... description I0..1stringThe human readable description of this population criteria
..... criteria I1..1ExpressionThe criteria that defines this population
.... stratifier I0..*BackboneElementStratifier criteria for the measure
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code I0..1CodeableConceptMeaning of the stratifier
..... description I0..1stringThe human readable description of this stratifier
..... criteria I0..1ExpressionHow the measure should be stratified
..... component I0..*BackboneElementStratifier criteria component for the measure
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code I0..1CodeableConceptMeaning of the stratifier component
...... description I0..1stringThe human readable description of this stratifier component
...... criteria I1..1ExpressionComponent of how the measure should be stratified
... supplementalData I0..*BackboneElementWhat other data should be reported with the measure
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code I0..1CodeableConceptMeaning of the supplemental data
.... usage I0..*CodeableConceptsupplemental-data | risk-adjustment-factor
Binding: MeasureDataUsage (extensible)
.... description I0..1stringThe human readable description of this supplemental data
.... criteria I1..1ExpressionExpression describing additional data to be reported

doco Documentation for this format

XML Template

<!-- Shareable Measure -->doco

<Measure xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id><!-- 0..1 string Logical id of this artifact --></id>
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..1 Canonical identifier for this measure, represented as a URI (globally unique) -->
 <identifier><!-- ?? 0..* Identifier Additional identifier for the measure --></identifier>
 <version value="[string]"/><!-- ?? 1..1 Business version of the measure -->
 <name value="[string]"/><!-- ?? 1..1 Name for this measure (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this measure (human friendly) -->
 <subtitle value="[string]"/><!-- ?? 0..1 Subordinate title of the measure -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device   --></subject[x]>
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..1 Natural language description of the measure -->
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for measure (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- ?? 0..1 Why this measure is defined -->
 <usage value="[string]"/><!-- ?? 0..1 Describes the clinical usage of the measure -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- ?? 0..1 When the measure was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- ?? 0..1 When the measure was last reviewed -->
 <effectivePeriod><!-- ?? 0..1 Period 
     When the measure is expected to be used --></effectivePeriod>
 <topic><!-- ?? 0..* CodeableConcept The category of the measure, such as Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- ?? 0..* ContactDetail Who authored the content --></author>
 <editor><!-- ?? 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- ?? 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- ?? 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- ?? 0..* RelatedArtifact 
     Additional documentation, citations, etc. --></relatedArtifact>
 <library value="[canonical]"/><!-- ?? 0..* Logic used by the measure -->
 <disclaimer value="[markdown]"/><!-- ?? 0..1 Disclaimer for use of the measure or its referenced content -->
 <scoring><!-- ?? 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort   --></scoring>
 <compositeScoring><!-- ?? 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted   --></compositeScoring>
 <type><!-- ?? 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite   --></type>
 <riskAdjustment value="[string]"/><!-- ?? 0..1 How risk adjustment is applied for this measure -->
 <rateAggregation value="[string]"/><!-- ?? 0..1 How is rate aggregation performed for this measure -->
 <rationale value="[markdown]"/><!-- ?? 0..1 Detailed description of why the measure exists -->
 <clinicalRecommendationStatement value="[markdown]"/><!-- ?? 0..1 Summary of clinical guidelines -->
 <improvementNotation><!-- ?? 0..1 CodeableConcept increase | decrease   --></improvementNotation>
 <definition value="[markdown]"/><!-- ?? 0..* Defined terms used in the measure documentation -->
 <guidance value="[markdown]"/><!-- ?? 0..1 Additional guidance for implementers -->
 <group> ?? 0..* BackboneElement  <!-- ?? 0..* Population criteria group -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- ?? 0..1 CodeableConcept Meaning of the group --></code>
  <description value="[string]"/><!-- ?? 0..1 Summary description -->
  <population> ?? 0..* BackboneElement  <!-- ?? 0..* Population criteria -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code><!-- ?? 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation   --></code>
   <description value="[string]"/><!-- ?? 0..1 The human readable description of this population criteria -->
   <criteria><!-- ?? 1..1 Expression 
       The criteria that defines this population --></criteria>
  </population>
  <stratifier> ?? 0..* BackboneElement  <!-- ?? 0..* Stratifier criteria for the measure -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <code><!-- ?? 0..1 CodeableConcept 
       Meaning of the stratifier --></code>
   <description value="[string]"/><!-- ?? 0..1 The human readable description of this stratifier -->
   <criteria><!-- ?? 0..1 Expression 
       How the measure should be stratified --></criteria>
   <component> ?? 0..* BackboneElement  <!-- ?? 0..* Stratifier criteria component for the measure -->
    <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
    <code><!-- ?? 0..1 CodeableConcept 
        Meaning of the stratifier component --></code>
    <description value="[string]"/><!-- ?? 0..1 
        The human readable description of this stratifier component -->
    <criteria><!-- ?? 1..1 Expression 
        Component of how the measure should be stratified --></criteria>
   </component>
  </stratifier>
 </group>
 <supplementalData> ?? 0..* BackboneElement  <!-- ?? 0..* What other data should be reported with the measure -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- ?? 0..1 CodeableConcept 
      Meaning of the supplemental data --></code>
  <usage><!-- ?? 0..* CodeableConcept supplemental-data | risk-adjustment-factor   --></usage>
  <description value="[string]"/><!-- ?? 0..1 The human readable description of this supplemental data -->
  <criteria><!-- ?? 1..1 Expression 
      Expression describing additional data to be reported --></criteria>
 </supplementalData>
</Measure>

JSON Template

{ // Shareable Measure
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this measure, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the measure
    "version" : "<string>", // C? R! Business version of the measure
    "name" : "<string>", // C? R! Name for this measure (computer friendly)
    "title" : "<string>", // C?Name for this measure (human friendly)
    "subtitle" : "<string>", // C?Subordinate title of the measure
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
// value[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept }, // C?E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    "subjectReference" : { Reference(Group) }, // C?E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the measure
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for measure (if applicable)
    "purpose" : "<markdown>", // C?Why this measure is defined
    "usage" : "<string>", // C?Describes the clinical usage of the measure
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the measure was approved by publisher
    "lastReviewDate" : "<date>", // C?When the measure was last reviewed
    "effectivePeriod" : { Period }, // C?When the measure is expected to be used
    "topic" : [{ CodeableConcept }], // C?The category of the measure, such as Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
    "library" : ["<canonical>"], // C?Logic used by the measure
    "disclaimer" : "<markdown>", // C?Disclaimer for use of the measure or its referenced content
    "scoring" : { CodeableConcept }, // C?proportion | ratio | continuous-variable | cohort
    "compositeScoring" : { CodeableConcept }, // C?opportunity | all-or-nothing | linear | weighted
    "type" : [{ CodeableConcept }], // C?process | outcome | structure | patient-reported-outcome | composite
    "riskAdjustment" : "<string>", // C?How risk adjustment is applied for this measure
    "rateAggregation" : "<string>", // C?How is rate aggregation performed for this measure
    "rationale" : "<markdown>", // C?Detailed description of why the measure exists
    "clinicalRecommendationStatement" : "<markdown>", // C?Summary of clinical guidelines
    "improvementNotation" : { CodeableConcept }, // C?increase | decrease
    "definition" : ["<markdown>"], // C?Defined terms used in the measure documentation
    "guidance" : "<markdown>", // C?Additional guidance for implementers
    "group" : [{ BackboneElement }] // C?Population criteria group
    "supplementalData" : [{ BackboneElement }], // C?What other data should be reported with the measure
  }

 

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

PathNameConformanceValueSet
Measure.languageCommon LanguagespreferredCommon Languages
Measure.statusPublicationStatusrequiredPublicationStatus
Measure.subject[x]Subject typeextensibleSubject type
Measure.jurisdictionJurisdictionextensibleJurisdiction
Measure.topicDefinitionTopicexampleDefinitionTopic
Measure.scoringMeasureScoringextensibleMeasureScoring
Measure.compositeScoringCompositeMeasureScoringextensibleCompositeMeasureScoring
Measure.typeMeasureTypeextensibleMeasureType
Measure.improvementNotationMeasureImprovementNotationrequiredMeasureImprovementNotation
Measure.group.population.codeMeasurePopulationTypeextensibleMeasurePopulationType
Measure.supplementalData.usageMeasureDataUsageextensibleMeasureDataUsage
.