This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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 R3
Detailed Descriptions for the elements in the Measure resource.
Measure | |
Definition | The Measure resource provides the definition of a quality measure. |
Control | 1..1 |
Measure.url | |
Definition | An absolute URL that is used to identify this measure when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published. The URL SHOULD include the major version of the measure. For more information see Technical and Business Versions. |
Control | 0..1 |
Type | uri |
Requirements | Allows the measure to be referenced by a single globally unique identifier. |
Summary | true |
Comments | Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. |
Measure.identifier | |
Definition | A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows externally provided and/or useable business identifiers to be easily associated with the module. |
Summary | true |
Comments | Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this measure outside of FHIR, where the logical URL is not possible to use. |
To Do | Add constraint to require identifier for non-experimental active artifacts. |
Measure.version | |
Definition | The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
Comments | There may be multiple different instances of a measure that have the same identifier but different versions. |
To Do | Add constraint to require a version for non-experimental active artifacts. |
Measure.name | |
Definition | A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
Control | 0..1 |
Type | string |
Requirements | Support human navigation & code generation. |
Summary | true |
Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly. |
Measure.title | |
Definition | A short, descriptive, user-friendly title for the measure. |
Control | 0..1 |
Type | string |
Summary | true |
Measure.status | |
Definition | The status of this measure. Enables tracking the life-cycle of the content. |
Control | 1..1 |
Terminology Binding | PublicationStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | Allows filtering of measure that are appropriate for use vs. not. |
Measure.experimental | |
Definition | A flag to indicate that this measure is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | Enables experimental content to be developed following the same life-cycle as a production-level measure would. |
Summary | true |
Comments | Allows filtering of measure that are appropriate for use vs. not. |
Measure.date | |
Definition | The date (and optionally time) when the measure was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes. |
Control | 0..1 |
Type | dateTime |
Summary | true |
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the measure. Additional specific dates may be added as extensions. |
Measure.description | |
Definition | A free text natural language description of the measure from the consumer's perspective. |
Control | 0..1 |
Type | markdown |
Comments | This description can be used to capture details such as why the measure was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context. |
Measure.purpose | |
Definition | Explains why this measure is needed and why it has been designed as it has. |
Control | 0..1 |
Type | markdown |
Comments | This element does not describe the usage of the measure (See, e.g, the comments element, or relatedArtifacts), rather it's for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this measure. |
Measure.usage | |
Definition | A detailed description of how the measure is used from a clinical perspective. |
Control | 0..1 |
Type | string |
Measure.approvalDate | |
Definition | The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
Control | 0..1 |
Type | date |
Comments | The date may be more recent than the approval date because of minor changes / editorial corrections. |
Measure.lastReviewDate | |
Definition | The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. |
Control | 0..1 |
Type | date |
Comments | If specified, this is usually after the approval date. |
Measure.effectivePeriod | |
Definition | The period during which the measure content was or is planned to be effective. |
Control | 0..1 |
Type | Period |
Summary | true |
Comments | The effective period for a measure determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015. |
Measure.useContext | |
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions. |
Control | 0..* |
Type | UsageContext |
Requirements | Assist in searching for appropriate content. |
Summary | true |
Comments | When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply. |
Measure.jurisdiction | |
Definition | A jurisdiction in which the measure is intended to be used. |
Control | 0..* |
Terminology Binding | Jurisdiction ValueSet (Extensible) |
Type | CodeableConcept |
Summary | true |
Measure.topic | |
Definition | Clinical topics related to the content of the measure. |
Control | 0..* |
Type | CodeableConcept |
Requirements | Repositories must be able to determine how to categorize the measure so that it can be found by topical searches. |
Measure.contributor | |
Definition | A contributor to the content of the measure, including authors, editors, reviewers, and endorsers. |
Control | 0..* |
Type | Contributor |
Requirements | Consumers of the content must be able to quickly determine who contributed to the content of the measure. |
Measure.publisher | |
Definition | The name of the individual or organization that published the measure. |
Control | 0..1 |
Type | string |
Requirements | Helps establish the "authority/credibility" of the measure. May also allow for contact. |
Summary | true |
Comments | Usually an organization, but may be an individual. The publisher (or steward) of the measure is the organization or individual primarily responsible for the maintenance and upkeep of the measure. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the measure. This item SHOULD be populated unless the information is available from context. |
To Do | Add constraint to require a publisher for non-experimental active artifacts. |
Measure.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactDetail |
Summary | true |
Comments | May be a web site, an email address, a telephone number, etc. |
Measure.copyright | |
Definition | A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure. |
Control | 0..1 |
Type | markdown |
Requirements | Consumers of the library must be able to determine any legal restrictions on the use of the measure and/or its content. |
Alternate Names | License; Restrictions |
Measure.relatedArtifact | |
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. |
Control | 0..* |
Type | RelatedArtifact |
Requirements | Measures must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. |
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. |
Measure.library | |
Definition | A reference to a Library resource containing the formal logic used by the measure. |
Control | 0..* |
Type | Reference(Library) |
Measure.disclaimer | |
Definition | A disclaimer for the use of the measure. |
Control | 0..1 |
Type | markdown |
Summary | true |
Measure.scoring | |
Definition | The measure scoring type, e.g. proportion, CV. |
Control | 0..1 |
Terminology Binding | MeasureScoring (Required) |
Type | code |
Summary | true |
Measure.compositeScoring | |
Definition | If this is a composite measure, the scoring method used to combine the component measures to determine the composite score. |
Control | 0..1 |
Terminology Binding | CompositeMeasureScoring (Required) |
Type | code |
Summary | true |
Measure.type | |
Definition | The measure type, e.g. process, outcome. |
Control | 0..* |
Terminology Binding | MeasureType (Required) |
Type | code |
Summary | true |
Measure.riskAdjustment | |
Definition | A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results. |
Control | 0..1 |
Type | string |
Summary | true |
Measure.rateAggregation | |
Definition | A description of the rate aggregation for the measure. |
Control | 0..1 |
Type | string |
Summary | true |
Measure.rationale | |
Definition | The rationale for the measure. |
Control | 0..1 |
Type | markdown |
Summary | true |
Measure.clinicalRecommendationStatement | |
Definition | The clinical recommendation statement for the measure. |
Control | 0..1 |
Type | markdown |
Summary | true |
Measure.improvementNotation | |
Definition | Improvement notation for the measure, e.g. higher score indicates better quality. |
Control | 0..1 |
Type | string |
Summary | true |
Measure.definition | |
Definition | A narrative description of the complete measure calculation. |
Control | 0..1 |
Type | markdown |
Summary | true |
Measure.guidance | |
Definition | Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure. |
Control | 0..1 |
Type | markdown |
Summary | true |
Measure.set | |
Definition | The measure set, e.g. Preventive Care and Screening. |
Control | 0..1 |
Type | string |
Summary | true |
Measure.group | |
Definition | A group of population criteria for the measure. |
Control | 0..* |
Measure.group.identifier | |
Definition | A unique identifier for the group. This identifier will used to report data for the group in the measure report. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
Measure.group.name | |
Definition | Optional name or short description of this group. |
Control | 0..1 |
Type | string |
Measure.group.description | |
Definition | The human readable description of this population group. |
Control | 0..1 |
Type | string |
Measure.group.population | |
Definition | A population criteria for the measure. |
Control | 0..* |
Measure.group.population.type | |
Definition | The type of population criteria. |
Control | 1..1 |
Terminology Binding | MeasurePopulationType (Required) |
Type | code |
Measure.group.population.identifier | |
Definition | A unique identifier for the population criteria. This identifier is used to report data against this criteria within the measure report. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
Measure.group.population.name | |
Definition | Optional name or short description of this population. |
Control | 0..1 |
Type | string |
Measure.group.population.description | |
Definition | The human readable description of this population criteria. |
Control | 0..1 |
Type | string |
Measure.group.population.criteria | |
Definition | The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria. |
Control | 1..1 |
Type | string |
Measure.group.stratifier | |
Definition | The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library, or a valid FHIR Resource Path. |
Control | 0..* |
Measure.group.stratifier.identifier | |
Definition | The identifier for the stratifier used to coordinate the reported data back to this stratifier. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
Measure.group.stratifier.criteria | |
Definition | The criteria for the stratifier. This must be the name of an expression defined within a referenced library. |
Control | 0..1 |
Type | string |
Measure.group.stratifier.path | |
Definition | The path to an element that defines the stratifier, specified as a valid FHIR resource path. |
Control | 0..1 |
Type | string |
Measure.supplementalData | |
Definition | The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path. |
Control | 0..* |
Measure.supplementalData.identifier | |
Definition | An identifier for the supplemental data. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier |
Measure.supplementalData.usage | |
Definition | An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation. |
Control | 0..* |
Terminology Binding | MeasureDataUsage (Required) |
Type | code |
Measure.supplementalData.criteria | |
Definition | The criteria for the supplemental data. This must be the name of a valid expression defined within a referenced library, and defines the data to be returned for this element. |
Control | 0..1 |
Type | string |
Measure.supplementalData.path | |
Definition | The supplemental data to be supplied as part of the measure response, specified as a valid FHIR Resource Path. |
Control | 0..1 |
Type | string |