STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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

14.6.6 Resource Measure - Detailed Descriptions

Detailed Descriptions for the elements in the Measure resource.

Measure
Definition

The Measure resource provides the definition of a quality measure.

Control1..1
Measure.url
Definition

An absolute URL that is used to identify this measure when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published.

Control0..1
Typeuri
Requirements

Allows the measure to be referenced by a single globally unique identifier.

Summarytrue
Measure.identifier
Definition

A logical identifier for the measure such as the CMS or NQF identifier. Note that at least one identifier is required for non-experimental active artifacts.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows external business identifiers to be easily associated with the measure.

Summarytrue
To DoAdd constraint to require identifier for non-experimental active artifacts.
Measure.version
Definition

The version of the measure, if any. 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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Requirements

Allows for versioning of the content of the measure.

Summarytrue
To DoAdd constraint to require a version for non-experimental active artifacts.
Measure.name
Definition

A machine-friendly name for the measure. This name should be usable as an identifier for the measure by machine processing applications such as code generation.

Control0..1
Typestring
Requirements

Simplifies machine-processing tasks related to the measure such as code-generation or logging.

Summarytrue
Comments

This identifier for the measure should be unique within the intended scope of use, and should conform to the traditional syntactic definition of an identifier within most programming languages. regex: ([A-Za-z][A-Za-z0-9]*).

Measure.title
Definition

A short, descriptive, user-friendly title for the measure.

Control0..1
Typestring
Summarytrue
Measure.status
Definition

The status of the measure.

Control1..1
BindingLibraryStatus: The status of the measure (Required)
Typecode
Is Modifiertrue
Requirements

Enables tracking the life-cycle of the content of the measure.

Summarytrue
Measure.experimental
Definition

Determines whether the measure was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.

Control0..1
Typeboolean
Is Modifiertrue
Requirements

Enables experimental content to be developed following the same life-cycle as a production-level measure would.

Summarytrue
Measure.description
Definition

A free text natural language description of the measure from the consumer's perspective.

Control0..1
Typestring
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 measure 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

A brief description of the purpose of the measure.

Control0..1
Typestring
Comments

This description should address the question of why this measure was built, though not necessarily in as much detail as the justification, rationale, or clinical recommendation statement of a measure would. That information would typically be provided in the related resource element.

Measure.usage
Definition

A detailed description of how the measure is used from a clinical perspective.

Control0..1
Typestring
Measure.publicationDate
Definition

The date on which the measure was published.

Control0..1
Typedate
Measure.lastReviewDate
Definition

The date on which the measure content was last reviewed.

Control0..1
Typedate
Measure.effectivePeriod
Definition

The period during which the measure content is effective.

Control0..1
TypePeriod
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.coverage
Definition

Specifies various attributes of the patient population for whom and/or environment of care in which, the measure is applicable.

Control0..*
TypeUsageContext
Requirements

Consumers of the measure must be able to determine the intended applicability for the measure. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed.

Measure.topic
Definition

Clinical topics related to the content of the measure.

Control0..*
TypeCodeableConcept
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.

Control0..*
TypeContributor
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 (also known as the steward for the measure). This information is required for non-experimental active artifacts.

Control0..1
Typestring
Requirements

Consumers of the measure must be able to determine where to obtain support in the use of this measure, as well as where to direct questions and concerns about the content.

Comments

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 organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the measure.

To DoAdd 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.

Control0..*
TypeContactDetail
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.

Control0..1
Typestring
Requirements

Consumers of the measure must be able to determine any legal restrictions on the use of the measure and/or its content.

Measure.relatedResource
Definition

Related resources such as additional documentation, justification, or bibliographic references.

Control0..*
TypeRelatedResource
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 resource 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.

Control0..*
TypeReference(Library)
Measure.disclaimer
Definition

A disclaimer for the use of the measure.

Control0..1
Typemarkdown
Measure.scoring
Definition

The measure scoring type, e.g. proportion, CV.

Control0..1
BindingMeasureScoring: The scoring type of the measure (Required)
Typecode
Measure.type
Definition

The measure type, e.g. process, outcome.

Control0..*
BindingMeasureType: The type of measure (Required)
Typecode
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.

Control0..1
Typestring
Measure.rateAggregation
Definition

A description of the rate aggregation for the measure.

Control0..1
Typestring
Measure.rationale
Definition

The rationale for the measure.

Control0..1
Typemarkdown
Measure.clinicalRecommendationStatement
Definition

The clinical recommendation statement for the measure.

Control0..1
Typemarkdown
Measure.improvementNotation
Definition

Improvement notation for the measure, e.g. higher score indicates better quality.

Control0..1
Typestring
Measure.definition
Definition

A narrative description of the complete measure calculation.

Control0..1
Typemarkdown
Measure.guidance
Definition

Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.

Control0..1
Typemarkdown
Measure.set
Definition

The measure set, e.g. Preventive Care and Screening.

Control0..1
Typestring
Measure.group
Definition

A group of population criteria for the measure.

Control0..*
Measure.group.identifier
Definition

A unique identifier for the group. This identifier will used to report data for the group in the measure report.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Measure.group.name
Definition

Optional name or short description of this group.

Control0..1
Typestring
Measure.group.description
Definition

The human readable description of this population group.

Control0..1
Typestring
Measure.group.population
Definition

A population criteria for the measure.

Control0..*
Measure.group.population.type
Definition

The type of population criteria.

Control1..1
BindingMeasurePopulationType: The type of population (Required)
Typecode
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.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Measure.group.population.name
Definition

Optional name or short description of this population.

Control0..1
Typestring
Measure.group.population.description
Definition

The human readable description of this population criteria.

Control0..1
Typestring
Measure.group.population.criteria
Definition

The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria.

Control1..1
Typestring
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.

Control0..*
Measure.group.stratifier.identifier
Definition

The identifier for the stratifier used to coordinate the reported data back to this stratifier.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Measure.group.stratifier.criteria
Definition

The criteria for the stratifier. This must be the name of an expression defined within a referenced library.

Control0..1
Typestring
Measure.group.stratifier.path
Definition

The path to an element that defines the stratifier, specified as a valid FHIR resource path.

Control0..1
Typestring
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.

Control0..*
Measure.supplementalData.identifier
Definition

An identifier for the supplemental data.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
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.

Control0..*
BindingMeasureDataUsage: The intended usage for supplemental data elements in the measure (Required)
Typecode
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.

Control0..1
Typestring
Measure.supplementalData.path
Definition

The supplemental data to be supplied as part of the measure response, specified as a valid FHIR Resource Path.

Control0..1
Typestring