PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r5.examples@5.0.0
    http://hl7.org/fhir/StructureDefinition/Measure
description: The Measure resource provides the definition of a quality measure.
package_name: hl7.fhir.r5.examples
derivation: specialization
name: Measure
type: Measure
elements:
  description: {isModifier: false, short: Natural language description of the measure, type: markdown, mustSupport: false, isSummary: true, index: 20}
  date: {isModifier: false, short: Date last changed, type: dateTime, mustSupport: false, isSummary: true, index: 17}
  group:
    isModifier: false
    short: Population criteria group
    type: BackboneElement
    mustSupport: false
    array: true
    isSummary: false
    index: 51
    elements:
      description: {isModifier: false, short: Summary description, type: markdown, mustSupport: false, isSummary: false, index: 54}
      linkId:
        constraint:
          mea-2: {human: Link ids should be 255 characters or less, source: 'http://hl7.org/fhir/StructureDefinition/Measure', severity: warning, expression: $this.length() <= 255}
        isModifier: false
        short: Unique id for group in measure
        type: string
        mustSupport: false
        isSummary: false
        index: 52
      stratifier:
        isModifier: false
        short: Stratifier criteria for the measure
        type: BackboneElement
        mustSupport: false
        array: true
        isSummary: false
        index: 74
        elements:
          linkId:
            constraint:
              mea-4: {human: Link ids should be 255 characters or less, source: 'http://hl7.org/fhir/StructureDefinition/Measure', severity: warning, expression: $this.length() <= 255}
            isModifier: false
            short: Unique id for stratifier in measure
            type: string
            mustSupport: false
            isSummary: false
            index: 75
          code:
            isModifier: false
            short: Meaning of the stratifier
            type: CodeableConcept
            mustSupport: false
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/measure-stratifier-example'}
            isSummary: false
            index: 76
          description: {isModifier: false, short: The human readable description of this stratifier, type: markdown, mustSupport: false, isSummary: false, index: 77}
          criteria: {isModifier: false, short: How the measure should be stratified, type: Expression, mustSupport: false, isSummary: false, index: 78}
          groupDefinition:
            isModifier: false
            short: A group resource that defines this population
            refers: ['http://hl7.org/fhir/StructureDefinition/Group']
            type: Reference
            mustSupport: false
            isSummary: false
            index: 79
          component:
            isModifier: false
            short: Stratifier criteria component for the measure
            type: BackboneElement
            mustSupport: false
            array: true
            isSummary: false
            index: 80
            elements:
              linkId:
                constraint:
                  mea-5: {human: Link ids should be 255 characters or less, source: 'http://hl7.org/fhir/StructureDefinition/Measure', severity: warning, expression: $this.length() <= 255}
                isModifier: false
                short: Unique id for stratifier component in measure
                type: string
                mustSupport: false
                isSummary: false
                index: 81
              code:
                isModifier: false
                short: Meaning of the stratifier component
                type: CodeableConcept
                mustSupport: false
                binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/measure-stratifier-example'}
                isSummary: false
                index: 82
              description: {isModifier: false, short: The human readable description of this stratifier component, type: markdown, mustSupport: false, isSummary: false, index: 83}
              criteria: {isModifier: false, short: Component of how the measure should be stratified, type: Expression, mustSupport: false, isSummary: false, index: 84}
              groupDefinition:
                isModifier: false
                short: A group resource that defines this population
                refers: ['http://hl7.org/fhir/StructureDefinition/Group']
                type: Reference
                mustSupport: false
                isSummary: false
                index: 85
      scoringUnit:
        isModifier: false
        short: What units?
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/measure-scoring-unit'}
        isSummary: true
        index: 62
      subjectCodeableConcept: {isModifier: false, short: 'E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device', type: CodeableConcept, mustSupport: false, meaningWhenMissing: Patient, choiceOf: subject, isSummary: false, index: 58}
      basis:
        isModifier: false
        short: Population basis
        type: code
        mustSupport: false
        meaningWhenMissing: boolean
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/fhir-types|5.0.0'}
        isSummary: true
        index: 60
      type:
        isModifier: false
        short: process | outcome | structure | patient-reported-outcome | composite
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/measure-type'}
        isSummary: true
        index: 55
      library: {isModifier: false, short: Logic used by the measure group, type: canonical, mustSupport: false, array: true, isSummary: false, index: 65}
      population:
        isModifier: false
        short: Population criteria
        type: BackboneElement
        mustSupport: false
        array: true
        isSummary: false
        index: 66
        elements:
          linkId:
            constraint:
              mea-3: {human: Link ids should be 255 characters or less, source: 'http://hl7.org/fhir/StructureDefinition/Measure', severity: warning, expression: $this.length() <= 255}
            isModifier: false
            short: Unique id for population in measure
            type: string
            mustSupport: false
            isSummary: false
            index: 67
          code:
            isModifier: false
            short: initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
            type: CodeableConcept
            mustSupport: false
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/measure-population'}
            isSummary: false
            index: 68
          description: {isModifier: false, short: The human readable description of this population criteria, type: markdown, mustSupport: false, isSummary: false, index: 69}
          criteria: {isModifier: false, short: The criteria that defines this population, type: Expression, mustSupport: false, isSummary: false, index: 70}
          groupDefinition:
            isModifier: false
            short: A group resource that defines this population
            refers: ['http://hl7.org/fhir/StructureDefinition/Group']
            type: Reference
            mustSupport: false
            isSummary: false
            index: 71
          inputPopulationId: {isModifier: false, short: Which population, type: string, mustSupport: false, isSummary: false, index: 72}
          aggregateMethod:
            isModifier: false
            short: Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count)
            type: CodeableConcept
            mustSupport: false
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/measure-aggregate-method'}
            isSummary: false
            index: 73
      code:
        isModifier: false
        short: Meaning of the group
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/measure-group-example'}
        isSummary: false
        index: 53
      scoring:
        isModifier: false
        short: proportion | ratio | continuous-variable | cohort
        type: CodeableConcept
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://terminology.hl7.org/ValueSet/measure-scoring'}
        isSummary: true
        index: 61
      subjectReference:
        isModifier: false
        short: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
        index: 59
        refers: ['http://hl7.org/fhir/StructureDefinition/Group']
        type: Reference
        mustSupport: false
        meaningWhenMissing: Patient
        choiceOf: subject
        isSummary: false
      improvementNotation:
        isModifier: false
        short: increase | decrease
        type: CodeableConcept
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/measure-improvement-notation|5.0.0'}
        isSummary: true
        index: 64
      subject:
        isModifier: false
        short: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
        mustSupport: false
        choices: [subjectCodeableConcept, subjectReference]
        meaningWhenMissing: Patient
        isSummary: false
        index: 57
      rateAggregation: {isModifier: false, short: How is rate aggregation performed for this measure, type: markdown, mustSupport: false, isSummary: true, index: 63}
  endorser: {isModifier: false, short: Who endorsed the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 34}
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), type: string, mustSupport: false, isSummary: true, index: 18}
  approvalDate: {isModifier: false, short: When the measure was approved by publisher, type: date, mustSupport: false, isSummary: false, index: 27}
  compositeScoring:
    isModifier: false
    short: opportunity | all-or-nothing | linear | weighted
    type: CodeableConcept
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/composite-measure-scoring'}
    isSummary: true
    index: 40
  disclaimer: {isModifier: false, short: Disclaimer for use of the measure or its referenced content, type: markdown, mustSupport: false, isSummary: true, index: 37}
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction for measure (if applicable)
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 22
  scoringUnit:
    isModifier: false
    short: What units?
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/measure-scoring-unit'}
    isSummary: true
    index: 39
  purpose: {isModifier: false, short: Why this measure is defined, type: markdown, mustSupport: false, isSummary: false, index: 23}
  subjectCodeableConcept: {isModifier: false, short: 'E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device', type: CodeableConcept, mustSupport: false, meaningWhenMissing: Patient, choiceOf: subject, isSummary: false, index: 14}
  name: {isModifier: false, short: Name for this measure (computer friendly), type: string, mustSupport: false, isSummary: true, index: 7}
  basis:
    isModifier: false
    short: Population basis
    type: code
    mustSupport: false
    meaningWhenMissing: boolean
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/fhir-types|5.0.0'}
    isSummary: true
    index: 16
  copyrightLabel: {isModifier: false, short: Copyright holder and year(s), type: string, mustSupport: false, isSummary: false, index: 26}
  useContext: {isModifier: false, short: The context that the content is intended to support, type: UsageContext, mustSupport: false, array: true, isSummary: true, index: 21}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, type: markdown, mustSupport: false, isSummary: false, index: 25}
  versionAlgorithm:
    isModifier: false
    short: How to compare versions
    mustSupport: false
    choices: [versionAlgorithmString, versionAlgorithmCoding]
    isSummary: true
    index: 4
  guidance: {isModifier: false, short: Additional guidance for implementers (deprecated), type: markdown, mustSupport: false, isSummary: true, index: 50}
  type:
    isModifier: false
    short: process | outcome | structure | patient-reported-outcome | composite
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/measure-type'}
    isSummary: true
    index: 41
  experimental: {isModifier: false, short: 'For testing purposes, not real usage', type: boolean, mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 11}
  topic:
    isModifier: false
    short: The category of the measure, such as Education, Treatment, Assessment, etc
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/definition-topic'}
    isSummary: false
    index: 30
  title: {isModifier: false, short: Name for this measure (human friendly), type: string, mustSupport: false, isSummary: true, index: 8}
  supplementalData:
    isModifier: false
    short: What other data should be reported with the measure
    index: 86
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      linkId:
        constraint:
          mea-6: {human: Link ids should be 255 characters or less, source: 'http://hl7.org/fhir/StructureDefinition/Measure', severity: warning, expression: $this.length() <= 255}
        isModifier: false
        short: Unique id for supplementalData in measure
        type: string
        mustSupport: false
        isSummary: false
        index: 87
      code:
        isModifier: false
        short: Meaning of the supplemental data
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/measure-supplemental-data-example'}
        isSummary: false
        index: 88
      usage:
        isModifier: false
        short: supplemental-data | risk-adjustment-factor
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/measure-data-usage'}
        isSummary: false
        index: 89
      description: {isModifier: false, short: The human readable description of this supplemental data, type: markdown, mustSupport: false, isSummary: false, index: 90}
      criteria: {isModifier: false, short: Expression describing additional data to be reported, type: Expression, mustSupport: false, isSummary: false, index: 91}
    required: [criteria]
    isSummary: false
  library: {isModifier: false, short: Logic used by the measure, type: canonical, mustSupport: false, array: true, isSummary: false, index: 36}
  author: {isModifier: false, short: Who authored the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 31}
  term:
    isModifier: false
    short: Defined terms used in the measure documentation
    type: BackboneElement
    mustSupport: false
    array: true
    isSummary: false
    index: 47
    elements:
      code:
        isModifier: false
        short: What term?
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/measure-definition-example'}
        isSummary: false
        index: 48
      definition: {isModifier: false, short: Meaning of the term, type: markdown, mustSupport: false, isSummary: false, index: 49}
  versionAlgorithmCoding: {isModifier: false, short: How to compare versions, type: Coding, mustSupport: false, choiceOf: versionAlgorithm, isSummary: true, index: 6}
  usage: {isModifier: false, short: Describes the clinical usage of the measure, type: markdown, mustSupport: false, isSummary: false, index: 24}
  rationale: {isModifier: false, short: Detailed description of why the measure exists, type: markdown, mustSupport: false, isSummary: true, index: 44}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    index: 10
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    isSummary: true
  subtitle: {isModifier: false, short: Subordinate title of the measure, type: string, mustSupport: false, isSummary: false, index: 9}
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/Measure', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'}
    isModifier: false
    short: Canonical identifier for this measure, represented as a URI (globally unique)
    type: uri
    mustSupport: false
    isSummary: true
    index: 0
  identifier: {isModifier: false, short: Additional identifier for the measure, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 1}
  lastReviewDate: {isModifier: false, short: When the measure was last reviewed by the publisher, type: date, mustSupport: false, isSummary: false, index: 28}
  editor: {isModifier: false, short: Who edited the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 32}
  riskAdjustment: {isModifier: false, short: How risk adjustment is applied for this measure, type: markdown, mustSupport: false, isSummary: true, index: 42}
  scoring:
    isModifier: false
    short: proportion | ratio | continuous-variable | cohort
    type: CodeableConcept
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://terminology.hl7.org/ValueSet/measure-scoring'}
    isSummary: true
    index: 38
  versionAlgorithmString: {isModifier: false, short: How to compare versions, type: string, mustSupport: false, choiceOf: versionAlgorithm, isSummary: true, index: 5}
  reviewer: {isModifier: false, short: Who reviewed the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 33}
  version: {isModifier: false, short: Business version of the measure, type: string, mustSupport: false, isSummary: true, index: 2}
  relatedArtifact: {isModifier: false, short: 'Additional documentation, citations, etc', type: RelatedArtifact, mustSupport: false, array: true, isSummary: false, index: 35}
  contact: {isModifier: false, short: Contact details for the publisher, type: ContactDetail, mustSupport: false, array: true, isSummary: true, index: 19}
  subjectReference:
    isModifier: false
    short: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    index: 15
    refers: ['http://hl7.org/fhir/StructureDefinition/Group']
    type: Reference
    mustSupport: false
    meaningWhenMissing: Patient
    choiceOf: subject
    isSummary: false
  improvementNotation:
    isModifier: false
    short: increase | decrease
    type: CodeableConcept
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/measure-improvement-notation|5.0.0'}
    isSummary: true
    index: 46
  subject:
    isModifier: false
    short: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
    mustSupport: false
    choices: [subjectCodeableConcept, subjectReference]
    meaningWhenMissing: Patient
    isSummary: false
    index: 13
  rateAggregation: {isModifier: false, short: How is rate aggregation performed for this measure, type: markdown, mustSupport: false, isSummary: true, index: 43}
  effectivePeriod: {isModifier: false, short: When the measure is expected to be used, type: Period, mustSupport: false, isSummary: true, index: 29}
  clinicalRecommendationStatement: {isModifier: false, short: Summary of clinical guidelines, type: markdown, mustSupport: false, isSummary: true, index: 45}
package_version: 5.0.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Measure
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [status]