This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Clinical Quality Information | Maturity Level: 0 | Trial Use | Use Context: Any |
Definitions for the shareablemeasure Profile.
Measure | |||||||||||||
Element Id | Measure | ||||||||||||
Definition | The Measure resource provides the definition of a quality measure. | ||||||||||||
Short Display | A quality measure definition | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Invariants |
| ||||||||||||
Measure.id | |||||||||||||
Element Id | Measure.id | ||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||||||
Short Display | Logical id of this artifact | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. | ||||||||||||
Measure.meta | |||||||||||||
Element Id | Measure.meta | ||||||||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||||||||
Short Display | Metadata about the resource | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Meta | ||||||||||||
Invariants |
| ||||||||||||
Measure.implicitRules | |||||||||||||
Element Id | Measure.implicitRules | ||||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||
Short Display | A set of rules under which this content was created | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Is Modifier | true (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation) | ||||||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. | ||||||||||||
Invariants |
| ||||||||||||
Measure.language | |||||||||||||
Element Id | Measure.language | ||||||||||||
Definition | The base language in which the resource is written. | ||||||||||||
Short Display | Language of the resource content | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | IETF language tag for a human language The codes SHALL be taken from All Languages | ||||||||||||
Type | code | ||||||||||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||||||||||
Invariants |
| ||||||||||||
Measure.text | |||||||||||||
Element Id | Measure.text | ||||||||||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||||||||||
Short Display | Text summary of the resource, for human interpretation | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: dom-6 | ||||||||||||
Type | Narrative | ||||||||||||
Alternate Names | narrative, html, xhtml, display | ||||||||||||
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||||||||||
Invariants |
| ||||||||||||
Measure.contained | |||||||||||||
Element Id | Measure.contained | ||||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. | ||||||||||||
Short Display | Contained, inline Resources | ||||||||||||
Cardinality | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 | ||||||||||||
Type | Resource | ||||||||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||||||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. | ||||||||||||
Measure.extension | |||||||||||||
Element Id | Measure.extension | ||||||||||||
Definition | An Extension | ||||||||||||
Short Display | Extension | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Invariants |
| ||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||
Measure.extension(knowledgeCapability) | |||||||||||||
Element Id | Measure.extension:knowledgeCapability | ||||||||||||
Definition | Defines a knowledge capability afforded by this knowledge artifact. | ||||||||||||
Short Display | shareable | computable | publishable | executable | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension(KnowledgeCapability) | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Measure.extension(knowledgeRepresentationLevel) | |||||||||||||
Element Id | Measure.extension:knowledgeRepresentationLevel | ||||||||||||
Definition | Defines a knowledge representation level provided by this knowledge artifact. | ||||||||||||
Short Display | narrative | semi-structured | structured | executable | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension(KnowledgeRepresentationLevel) | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Measure.extension(artifactComment) | |||||||||||||
Element Id | Measure.extension:artifactComment | ||||||||||||
Definition | A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user. | ||||||||||||
Short Display | Additional documentation, review, or usage guidance | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension(ArtifactComment) | ||||||||||||
Must Support | true | ||||||||||||
Invariants |
| ||||||||||||
Measure.modifierExtension | |||||||||||||
Element Id | Measure.modifierExtension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Short Display | Extensions that cannot be ignored | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.url | |||||||||||||
Element Id | Measure.url | ||||||||||||
Definition | An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers. | ||||||||||||
Short Display | Canonical identifier for this measure, represented as a URI (globally unique) | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Allows the measure to be referenced by a single globally unique identifier. | ||||||||||||
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. | ||||||||||||
Invariants |
| ||||||||||||
Measure.identifier | |||||||||||||
Element Id | 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. | ||||||||||||
Short Display | Additional identifier for the measure | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Identifier | ||||||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||||||
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this measure outside of FHIR, where it is not possible to use the logical URI. | ||||||||||||
Invariants |
| ||||||||||||
Measure.version | |||||||||||||
Element Id | 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 can be placed in a lexicographical sequence. 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. | ||||||||||||
Short Display | Business version of the measure | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Comments | There may be different measure instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the measure with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||||||
Invariants |
| ||||||||||||
Measure.versionAlgorithm[x] | |||||||||||||
Element Id | Measure.versionAlgorithm[x] | ||||||||||||
Definition | Indicates the mechanism used to compare versions to determine which is more current. | ||||||||||||
Short Display | How to compare versions | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | null The codes SHALL be taken from Version Algorithm; other codes may be used where these codes are not suitable | ||||||||||||
Type | Choice of: string, Coding | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Must Support | true | ||||||||||||
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. | ||||||||||||
Invariants |
| ||||||||||||
Measure.name | |||||||||||||
Element Id | 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. | ||||||||||||
Short Display | Name for this measure (computer friendly) | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: cnl-0 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||||||||||
Invariants |
| ||||||||||||
Measure.title | |||||||||||||
Element Id | Measure.title | ||||||||||||
Definition | A short, descriptive, user-friendly title for the measure. | ||||||||||||
Short Display | Name for this measure (human friendly) | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||
Invariants |
| ||||||||||||
Measure.subtitle | |||||||||||||
Element Id | Measure.subtitle | ||||||||||||
Definition | An explanatory or alternate title for the measure giving additional information about its content. | ||||||||||||
Short Display | Subordinate title of the measure | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants |
| ||||||||||||
Measure.status | |||||||||||||
Element Id | Measure.status | ||||||||||||
Definition | The status of this measure. Enables tracking the life-cycle of the content. | ||||||||||||
Short Display | draft | active | retired | unknown | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | The lifecycle status of an artifact. The codes SHALL be taken from PublicationStatus | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||
Comments | Allows filtering of measures that are appropriate for use versus not. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Measure.experimental | |||||||||||||
Element Id | Measure.experimental | ||||||||||||
Definition | A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. | ||||||||||||
Short Display | For testing purposes, not real usage | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level measure. | ||||||||||||
Comments | Allows filtering of measures that are appropriate for use versus not. | ||||||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||||||
Invariants |
| ||||||||||||
Measure.subject[x] | |||||||||||||
Element Id | Measure.subject[x] | ||||||||||||
Definition | The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything. | ||||||||||||
Short Display | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). The codes SHALL be taken from Participant Resource Types; other codes may be used where these codes are not suitable | ||||||||||||
Type | Choice of: CodeableConcept, Reference(Group) | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Comments | The subject of the measure is critical in interpreting the criteria definitions, as the logic in the measures is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. | ||||||||||||
Meaning if Missing | Patient | ||||||||||||
Invariants |
| ||||||||||||
Measure.basis | |||||||||||||
Element Id | Measure.basis | ||||||||||||
Definition | The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. | ||||||||||||
Short Display | Population basis | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | null The codes SHALL be taken from All FHIR Types | ||||||||||||
Type | code | ||||||||||||
Requirements | Allows non-subject-based measures to be specified. Note that because the binding is to all fhir types, it is possible to specify abstract types such as Resource or DomainResource as the basis for a measure. Authoring environments may wish to constrain this further, depending on content needs. | ||||||||||||
Comments | For a subject-based measure, the population basis is simply boolean; all the criteria are expressed as true/false conditions that determine membership of an individual case in the population. For non-subject-based measures, the population basis can be any resource type, and the criteria are queries that return the subject's contribution to the population as a list of that resource type. For example, for a procedure-based measure, the population criteria would return lists of procedures that should be included in each population. | ||||||||||||
Meaning if Missing | boolean | ||||||||||||
Invariants |
| ||||||||||||
Measure.date | |||||||||||||
Element Id | Measure.date | ||||||||||||
Definition | The date (and optionally time) when the measure was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes. | ||||||||||||
Short Display | Date last changed | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Alternate Names | Revision Date | ||||||||||||
Comments | The date is often not tracked until the resource is published, but may be present on draft content. 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 or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Measure.publisher | |||||||||||||
Element Id | Measure.publisher | ||||||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the measure. | ||||||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Helps establish the "authority/credibility" of the measure. May also allow for contact. | ||||||||||||
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. | ||||||||||||
Invariants |
| ||||||||||||
Measure.contact | |||||||||||||
Element Id | Measure.contact | ||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||
Short Display | Contact details for the publisher | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Measure.description | |||||||||||||
Element Id | Measure.description | ||||||||||||
Definition | A free text natural language description of the measure from a consumer's perspective. | ||||||||||||
Short Display | Natural language description of the measure | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | markdown | ||||||||||||
Must Support | true | ||||||||||||
Comments | This description can be used to capture details such as 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 (e.g. the language of the measure is presumed to be the predominant language in the place the measure was created). | ||||||||||||
Invariants |
| ||||||||||||
Measure.useContext | |||||||||||||
Element Id | Measure.useContext | ||||||||||||
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances. | ||||||||||||
Short Display | The context that the content is intended to support | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | UsageContext | ||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||
Invariants |
| ||||||||||||
Measure.jurisdiction | |||||||||||||
Element Id | Measure.jurisdiction | ||||||||||||
Definition | A legal or geographic region in which the measure is intended to be used. | ||||||||||||
Short Display | Intended jurisdiction for measure (if applicable) | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | Countries and regions within which this artifact is targeted for use. The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
Comments | It may be possible for the measure to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) | ||||||||||||
Invariants |
| ||||||||||||
Measure.purpose | |||||||||||||
Element Id | Measure.purpose | ||||||||||||
Definition | Explanation of why this measure is needed and why it has been designed as it has. | ||||||||||||
Short Display | Why this measure is defined | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Comments | This element does not describe the usage of the measure. Instead, it provides 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. | ||||||||||||
Invariants |
| ||||||||||||
Measure.usage | |||||||||||||
Element Id | Measure.usage | ||||||||||||
Definition | A detailed description, from a clinical perspective, of how the measure is used. | ||||||||||||
Short Display | Describes the clinical usage of the measure | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Requirements | Measure developers must be able to provide additional guidance for implementers to understand the intent with greater specificity than that provided in the population criteria of the measure. This element provides detailed guidance, where the usage element provides a summary of the guidance. | ||||||||||||
Alternate Names | guidance | ||||||||||||
Comments | This metadata element was typically referred to as Guidance in HQMF | ||||||||||||
Invariants |
| ||||||||||||
Measure.copyright | |||||||||||||
Element Id | 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. | ||||||||||||
Short Display | Use and/or publishing restrictions | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the measure and/or its content. | ||||||||||||
Alternate Names | License, Restrictions | ||||||||||||
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element. | ||||||||||||
Invariants |
| ||||||||||||
Measure.copyrightLabel | |||||||||||||
Element Id | Measure.copyrightLabel | ||||||||||||
Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). | ||||||||||||
Short Display | Copyright holder and year(s) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||||||
Comments | The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. | ||||||||||||
Invariants |
| ||||||||||||
Measure.approvalDate | |||||||||||||
Element Id | Measure.approvalDate | ||||||||||||
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | ||||||||||||
Short Display | When the measure was approved by publisher | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | date | ||||||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Measure.lastReviewDate | |||||||||||||
Element Id | Measure.lastReviewDate | ||||||||||||
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | ||||||||||||
Short Display | When the measure was last reviewed by the publisher | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | date | ||||||||||||
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. | ||||||||||||
Comments | If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Measure.effectivePeriod | |||||||||||||
Element Id | Measure.effectivePeriod | ||||||||||||
Definition | The period during which the measure content was or is planned to be in active use. | ||||||||||||
Short Display | When the measure is expected to be used | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Period | ||||||||||||
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the measure are or are expected to be used instead. | ||||||||||||
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 might be published in 2015. See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Measure.topic | |||||||||||||
Element Id | Measure.topic | ||||||||||||
Definition | Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching. | ||||||||||||
Short Display | The category of the measure, such as Education, Treatment, Assessment, etc | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | High-level categorization of the definition, used for searching, sorting, and filtering. For example codes, see Definition Topic | ||||||||||||
Type | CodeableConcept | ||||||||||||
Requirements | Repositories must be able to determine how to categorize the measure so that it can be found by topical searches. | ||||||||||||
Comments | DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) | ||||||||||||
Invariants |
| ||||||||||||
Measure.author | |||||||||||||
Element Id | Measure.author | ||||||||||||
Definition | An individiual or organization primarily involved in the creation and maintenance of the content. | ||||||||||||
Short Display | Who authored the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Invariants |
| ||||||||||||
Measure.editor | |||||||||||||
Element Id | Measure.editor | ||||||||||||
Definition | An individual or organization primarily responsible for internal coherence of the content. | ||||||||||||
Short Display | Who edited the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Invariants |
| ||||||||||||
Measure.reviewer | |||||||||||||
Element Id | Measure.reviewer | ||||||||||||
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. | ||||||||||||
Short Display | Who reviewed the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Comments | See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Measure.endorser | |||||||||||||
Element Id | Measure.endorser | ||||||||||||
Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. | ||||||||||||
Short Display | Who endorsed the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Comments | See guidance around (not) making local changes to elements here. | ||||||||||||
Invariants |
| ||||||||||||
Measure.relatedArtifact | |||||||||||||
Element Id | Measure.relatedArtifact | ||||||||||||
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. | ||||||||||||
Short Display | Additional documentation, citations, etc | ||||||||||||
Cardinality | 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. | ||||||||||||
Invariants |
| ||||||||||||
Measure.library | |||||||||||||
Element Id | Measure.library | ||||||||||||
Definition | A reference to a Library resource containing the formal logic used by the measure. | ||||||||||||
Short Display | Logic used by the measure | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | canonical(Library) | ||||||||||||
Invariants |
| ||||||||||||
Measure.disclaimer | |||||||||||||
Element Id | Measure.disclaimer | ||||||||||||
Definition | Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure. | ||||||||||||
Short Display | Disclaimer for use of the measure or its referenced content | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Requirements | Some organizations require that notices and disclosures be included when publishing measures that reference their intellecutal property. | ||||||||||||
Invariants |
| ||||||||||||
Measure.scoring | |||||||||||||
Element Id | Measure.scoring | ||||||||||||
Definition | Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. | ||||||||||||
Short Display | proportion | ratio | continuous-variable | cohort | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | The scoring type of the measure. The codes SHALL be taken from MeasureScoring | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Measure.scoringUnit | |||||||||||||
Element Id | Measure.scoringUnit | ||||||||||||
Definition | Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit. | ||||||||||||
Short Display | What units? | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | null For example codes, see Measure Scoring Unit | ||||||||||||
Type | CodeableConcept | ||||||||||||
Requirements | When the unit cannot be inferred directly from the calculation logic, this element allows the specification of the desired units of measure of the output. | ||||||||||||
Comments | When this element is specified, implementations are expected to report measure scores in the specified units. Note that this may involve unit conversion if the expected units are different than the units of the resulting score calculation. In this case, unit conversions SHALL be performed according to the unit conversion semantics specified by UCUM. | ||||||||||||
Invariants |
| ||||||||||||
Measure.compositeScoring | |||||||||||||
Element Id | Measure.compositeScoring | ||||||||||||
Definition | If this is a composite measure, the scoring method used to combine the component measures to determine the composite score. | ||||||||||||
Short Display | opportunity | all-or-nothing | linear | weighted | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | The composite scoring method of the measure. The codes SHALL be taken from Composite Measure Scoring; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Measure.type | |||||||||||||
Element Id | Measure.type | ||||||||||||
Definition | Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. | ||||||||||||
Short Display | process | outcome | structure | patient-reported-outcome | composite | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | The type of measure (includes codes from 2.16.840.1.113883.1.11.20368). The codes SHALL be taken from Measure Type; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Measure.riskAdjustment | |||||||||||||
Element Id | 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. | ||||||||||||
Short Display | How risk adjustment is applied for this measure | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Comments | Describes the method of adjusting for clinical severity and conditions present at the start of care that can influence patient outcomes for making valid comparisons of outcome measures across providers. Indicates whether a measure is subject to the statistical process for reducing, removing, or clarifying the influences of confounding factors to allow for more useful comparisons. | ||||||||||||
Invariants |
| ||||||||||||
Measure.rateAggregation | |||||||||||||
Element Id | Measure.rateAggregation | ||||||||||||
Definition | Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result. | ||||||||||||
Short Display | How is rate aggregation performed for this measure | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Comments | The measure rate for an organization or clinician is based upon the entities’ aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level). | ||||||||||||
Invariants |
| ||||||||||||
Measure.rationale | |||||||||||||
Element Id | Measure.rationale | ||||||||||||
Definition | Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence. | ||||||||||||
Short Display | Detailed description of why the measure exists | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Requirements | Measure developers need to be able to provide a detailed description of the purpose of the measure. This element provides detailed rationale, where the purpose element provides a summary of the rationale. | ||||||||||||
Invariants |
| ||||||||||||
Measure.clinicalRecommendationStatement | |||||||||||||
Element Id | Measure.clinicalRecommendationStatement | ||||||||||||
Definition | Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure. | ||||||||||||
Short Display | Summary of clinical guidelines | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Invariants |
| ||||||||||||
Measure.improvementNotation | |||||||||||||
Element Id | Measure.improvementNotation | ||||||||||||
Definition | Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). | ||||||||||||
Short Display | increase | decrease | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. The codes SHALL be taken from Measure Improvement Notation | ||||||||||||
Type | CodeableConcept | ||||||||||||
Requirements | Measure consumers and implementers must be able to determine how to interpret a measure score. | ||||||||||||
Invariants |
| ||||||||||||
Measure.term | |||||||||||||
Element Id | Measure.term | ||||||||||||
Definition | Provides a description of an individual term used within the measure. | ||||||||||||
Short Display | Defined terms used in the measure documentation | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Requirements | Measure developers must be able to provide precise definitions of terms used within measure descriptions and guidance to help communicate the intent of the measure. | ||||||||||||
Invariants |
| ||||||||||||
Measure.term.id | |||||||||||||
Element Id | Measure.term.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | string | ||||||||||||
Measure.term.extension | |||||||||||||
Element Id | Measure.term.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.term.modifierExtension | |||||||||||||
Element Id | Measure.term.modifierExtension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.term.code | |||||||||||||
Element Id | Measure.term.code | ||||||||||||
Definition | A codeable representation of the defined term. | ||||||||||||
Short Display | What term? | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Codeable representations of measure definition terms. For example codes, see Measure Definition Example | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Measure.term.definition | |||||||||||||
Element Id | Measure.term.definition | ||||||||||||
Definition | Provides a definition for the term as used within the measure. | ||||||||||||
Short Display | Meaning of the term | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Invariants |
| ||||||||||||
Measure.guidance | |||||||||||||
Element Id | Measure.guidance | ||||||||||||
Definition | Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure. | ||||||||||||
Short Display | Additional guidance for implementers (deprecated) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Requirements | Measure developers must be able to provide additional guidance for implementers to understand the intent with greater specificity than that provided in the population criteria of the measure. This element provides detailed guidance, where the usage element provides a summary of the guidance. | ||||||||||||
Comments | NOTE: This element is deprecated in favor of the usage element | ||||||||||||
Invariants |
| ||||||||||||
Measure.group | |||||||||||||
Element Id | Measure.group | ||||||||||||
Definition | A group of population criteria for the measure. | ||||||||||||
Short Display | Population criteria group | ||||||||||||
Cardinality | 0..* This element is affected by the following invariants: mea-1 | ||||||||||||
Type | BackboneElement | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.id | |||||||||||||
Element Id | Measure.group.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | string | ||||||||||||
Measure.group.extension | |||||||||||||
Element Id | Measure.group.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.modifierExtension | |||||||||||||
Element Id | Measure.group.modifierExtension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.linkId | |||||||||||||
Element Id | Measure.group.linkId | ||||||||||||
Definition | An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. | ||||||||||||
Short Display | Unique id for group in measure | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | MeasureReport does not require omitted groups to be included. | ||||||||||||
Comments | This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.code | |||||||||||||
Element Id | Measure.group.code | ||||||||||||
Definition | Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures. | ||||||||||||
Short Display | Meaning of the group | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Example of measure groups. For example codes, see Measure Group Example | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.description | |||||||||||||
Element Id | Measure.group.description | ||||||||||||
Definition | The human readable description of this population group. | ||||||||||||
Short Display | Summary description | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.type | |||||||||||||
Element Id | Measure.group.type | ||||||||||||
Definition | Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. | ||||||||||||
Short Display | process | outcome | structure | patient-reported-outcome | composite | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | null The codes SHALL be taken from Measure Type; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
Comments | When specified at the group level, defines the measure type for this specific group. If not specified, the measureType of the group is determined by the root type element | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.subject[x] | |||||||||||||
Element Id | Measure.group.subject[x] | ||||||||||||
Definition | The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything. | ||||||||||||
Short Display | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.). The codes SHALL be taken from Participant Resource Types; other codes may be used where these codes are not suitable | ||||||||||||
Type | Choice of: CodeableConcept, Reference(Group) | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Comments | The subject of the measure is critical in interpreting the criteria definitions, as the logic in the measures is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. | ||||||||||||
Meaning if Missing | Patient | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.basis | |||||||||||||
Element Id | Measure.group.basis | ||||||||||||
Definition | The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. | ||||||||||||
Short Display | Population basis | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | null The codes SHALL be taken from All FHIR Types | ||||||||||||
Type | code | ||||||||||||
Requirements | Allows non-subject-based measures to be specified | ||||||||||||
Comments | When specified at the group level, defines the population basis for this specific group. If not specified, the basis for the group is determined by the root basis element | ||||||||||||
Meaning if Missing | boolean | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.scoring | |||||||||||||
Element Id | Measure.group.scoring | ||||||||||||
Definition | Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. | ||||||||||||
Short Display | proportion | ratio | continuous-variable | cohort | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | null The codes SHALL be taken from MeasureScoring | ||||||||||||
Type | CodeableConcept | ||||||||||||
Comments | When specified at the group level, defines the scoring for this specific group. If not specified, scoring for this group is determined by the root scoring element | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.scoringUnit | |||||||||||||
Element Id | Measure.group.scoringUnit | ||||||||||||
Definition | Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit. | ||||||||||||
Short Display | What units? | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | null For example codes, see Measure Scoring Unit | ||||||||||||
Type | CodeableConcept | ||||||||||||
Requirements | When the unit cannot be inferred directly from the calculation logic, this element allows the specification of the desired units of measure of the output. | ||||||||||||
Comments | When specified at the group level, this defines the scoringUnit for this specific group. If not specified, the scoringUnit for this group is determined by the root scoringUnit element. As with the root element, when this element is specified, implementations are expected to report measure scores in the specified units. Note that this may involve unit conversion if the expected units are different than the units of the resulting score calculation. In this case, unit conversions SHALL be performed according to the unit conversion semantics specified by UCUM. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.rateAggregation | |||||||||||||
Element Id | Measure.group.rateAggregation | ||||||||||||
Definition | Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result. | ||||||||||||
Short Display | How is rate aggregation performed for this measure | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Comments | The measure rate for an organization or clinician is based upon the entities’ aggregate data and summarizes the performance of the entity over a given time period (e.g., monthly, quarterly, yearly). The aggregated data are derived from the results of a specific measure algorithm and, if appropriate, the application of specific risk adjustment models. Can also be used to describe how to risk adjust the data based on supplemental data elements described in the eMeasure (e.g., pneumonia hospital measures antibiotic selection in the ICU versus non-ICU and then the roll-up of the two). This could be applied to aggregated cohort measure definitions (e.g., CDC's aggregate reporting for TB at the state level). | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.improvementNotation | |||||||||||||
Element Id | Measure.group.improvementNotation | ||||||||||||
Definition | Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). | ||||||||||||
Short Display | increase | decrease | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | null The codes SHALL be taken from Measure Improvement Notation | ||||||||||||
Type | CodeableConcept | ||||||||||||
Requirements | Measure consumers and implementers must be able to determine how to interpret a measure score. | ||||||||||||
Comments | When specified at the group level, this element defines the improvementNotation for this specific group. If not specified, improvementNotation for this group is determined by the root improvementNotation element | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.library | |||||||||||||
Element Id | Measure.group.library | ||||||||||||
Definition | A reference to a Library resource containing the formal logic used by the measure group. | ||||||||||||
Short Display | Logic used by the measure group | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | canonical(Library) | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.population | |||||||||||||
Element Id | Measure.group.population | ||||||||||||
Definition | A population criteria for the measure. | ||||||||||||
Short Display | Population criteria | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.population.id | |||||||||||||
Element Id | Measure.group.population.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | string | ||||||||||||
Measure.group.population.extension | |||||||||||||
Element Id | Measure.group.population.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.population.modifierExtension | |||||||||||||
Element Id | Measure.group.population.modifierExtension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.population.linkId | |||||||||||||
Element Id | Measure.group.population.linkId | ||||||||||||
Definition | An identifier that is unique within the Measure allowing linkage to the equivalent population in a MeasureReport resource. | ||||||||||||
Short Display | Unique id for population in measure | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | MeasureReport does not require omitted populations to be included. | ||||||||||||
Comments | This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.population.code | |||||||||||||
Element Id | Measure.group.population.code | ||||||||||||
Definition | The type of population criteria. | ||||||||||||
Short Display | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | The type of population. The codes SHALL be taken from Measure Population Type; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.population.description | |||||||||||||
Element Id | Measure.group.population.description | ||||||||||||
Definition | The human readable description of this population criteria. | ||||||||||||
Short Display | The human readable description of this population criteria | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.population.criteria | |||||||||||||
Element Id | Measure.group.population.criteria | ||||||||||||
Definition | An expression that specifies the criteria for the population, typically the name of an expression in a library. | ||||||||||||
Short Display | The criteria that defines this population | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Expression | ||||||||||||
Comments | In the case of a continuous-variable or ratio measure, this may be the name of a function that calculates the value of the individual observation for each patient or event in the population. For these types of measures, individual observations are reported as observation resources included in the evaluatedResources bundle for each patient. See the MeasureReport resource or the Quality Reporting topic for more information. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.population.groupDefinition | |||||||||||||
Element Id | Measure.group.population.groupDefinition | ||||||||||||
Definition | A Group resource that defines this population as a set of characteristics. | ||||||||||||
Short Display | A group resource that defines this population | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Reference(Group) | ||||||||||||
Comments | Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group resource SHALL be a definitional (as opposed to an actual) group. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.population.inputPopulationId | |||||||||||||
Element Id | Measure.group.population.inputPopulationId | ||||||||||||
Definition | The id of a population element in this measure that provides the input for this population criteria. In most cases, the scoring structure of the measure implies specific relationships (e.g. the Numerator uses the Denominator as the source in a proportion scoring). In some cases, however, multiple possible choices exist and must be resolved explicitly. For example in a ratio measure with multiple initial populations, the denominator must specify which population should be used as the starting point. | ||||||||||||
Short Display | Which population | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | For ratio and continuous variable measures, the source populations must be specified explicitly when they cannot be unambiguously determined from the scoring structure. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.population.aggregateMethod | |||||||||||||
Element Id | Measure.group.population.aggregateMethod | ||||||||||||
Definition | Specifies which method should be used to aggregate measure observation values. For most scoring types, this is implied by scoring (e.g. a proportion measure counts members of the populations). For continuous variables, however, this information must be specified to ensure correct calculation. | ||||||||||||
Short Display | Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | null The codes SHALL be taken from Measure Aggregate Method; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
Requirements | For continuous variable measures, specifications must be able to indicate the aggregation method to be used for tallying results from individual observations. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier | |||||||||||||
Element Id | 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. | ||||||||||||
Short Display | Stratifier criteria for the measure | ||||||||||||
Cardinality | 0..* This element is affected by the following invariants: mea-1 | ||||||||||||
Type | BackboneElement | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.id | |||||||||||||
Element Id | Measure.group.stratifier.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | string | ||||||||||||
Measure.group.stratifier.extension | |||||||||||||
Element Id | Measure.group.stratifier.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.modifierExtension | |||||||||||||
Element Id | Measure.group.stratifier.modifierExtension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.linkId | |||||||||||||
Element Id | Measure.group.stratifier.linkId | ||||||||||||
Definition | An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. | ||||||||||||
Short Display | Unique id for stratifier in measure | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | MeasureReport does not require omitted stratifiers to be included. | ||||||||||||
Comments | This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.code | |||||||||||||
Element Id | Measure.group.stratifier.code | ||||||||||||
Definition | Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. | ||||||||||||
Short Display | Meaning of the stratifier | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: mea-1 | ||||||||||||
Terminology Binding | Meaning of the stratifier. For example codes, see Measure Stratifier Example | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.description | |||||||||||||
Element Id | Measure.group.stratifier.description | ||||||||||||
Definition | The human readable description of this stratifier criteria. | ||||||||||||
Short Display | The human readable description of this stratifier | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: mea-1 | ||||||||||||
Type | markdown | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.criteria | |||||||||||||
Element Id | Measure.group.stratifier.criteria | ||||||||||||
Definition | An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element. | ||||||||||||
Short Display | How the measure should be stratified | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: mea-1 | ||||||||||||
Type | Expression | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.groupDefinition | |||||||||||||
Element Id | Measure.group.stratifier.groupDefinition | ||||||||||||
Definition | A Group resource that defines this population as a set of characteristics. | ||||||||||||
Short Display | A group resource that defines this population | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Reference(Group) | ||||||||||||
Comments | Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group SHALL be a definitional (as opposed to an actual) group. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.component | |||||||||||||
Element Id | Measure.group.stratifier.component | ||||||||||||
Definition | A component of 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. | ||||||||||||
Short Display | Stratifier criteria component for the measure | ||||||||||||
Cardinality | 0..* This element is affected by the following invariants: mea-1 | ||||||||||||
Type | BackboneElement | ||||||||||||
Comments | Stratifiers are defined either as a single criteria, or as a set of component criteria. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.component.id | |||||||||||||
Element Id | Measure.group.stratifier.component.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | string | ||||||||||||
Measure.group.stratifier.component.extension | |||||||||||||
Element Id | Measure.group.stratifier.component.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.component.modifierExtension | |||||||||||||
Element Id | Measure.group.stratifier.component.modifierExtension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.component.linkId | |||||||||||||
Element Id | Measure.group.stratifier.component.linkId | ||||||||||||
Definition | An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. | ||||||||||||
Short Display | Unique id for stratifier component in measure | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | MeasureReport does not require omitted stratifier components to be included. | ||||||||||||
Comments | This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.component.code | |||||||||||||
Element Id | Measure.group.stratifier.component.code | ||||||||||||
Definition | Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures. | ||||||||||||
Short Display | Meaning of the stratifier component | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Meaning of the stratifier. For example codes, see Measure Stratifier Example | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.component.description | |||||||||||||
Element Id | Measure.group.stratifier.component.description | ||||||||||||
Definition | The human readable description of this stratifier criteria component. | ||||||||||||
Short Display | The human readable description of this stratifier component | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.component.criteria | |||||||||||||
Element Id | Measure.group.stratifier.component.criteria | ||||||||||||
Definition | An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element. | ||||||||||||
Short Display | Component of how the measure should be stratified | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Expression | ||||||||||||
Invariants |
| ||||||||||||
Measure.group.stratifier.component.groupDefinition | |||||||||||||
Element Id | Measure.group.stratifier.component.groupDefinition | ||||||||||||
Definition | A Group resource that defines this population as a set of characteristics. | ||||||||||||
Short Display | A group resource that defines this population | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Reference(Group) | ||||||||||||
Comments | Note that this approach can only be used for measures where the basis is of the same type as the populations (e.g. a Patient-based measure, rather than an Encounter-based measure). In addition, the referenced Group SHALL be a definitional (as opposed to an actual) group. | ||||||||||||
Invariants |
| ||||||||||||
Measure.supplementalData | |||||||||||||
Element Id | 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. | ||||||||||||
Short Display | What other data should be reported with the measure | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Comments | Note that supplemental data are reported as resources for each patient and referenced in the supplementalData element of the MeasureReport. If the supplementalData expression results in a value other than a resource, it is reported using an Observation resource, typically contained in the resulting MeasureReport. See the MeasureReport resource and the Quality Reporting topic for more information. | ||||||||||||
Invariants |
| ||||||||||||
Measure.supplementalData.id | |||||||||||||
Element Id | Measure.supplementalData.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Type | string | ||||||||||||
Measure.supplementalData.extension | |||||||||||||
Element Id | Measure.supplementalData.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.supplementalData.modifierExtension | |||||||||||||
Element Id | Measure.supplementalData.modifierExtension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
Measure.supplementalData.linkId | |||||||||||||
Element Id | Measure.supplementalData.linkId | ||||||||||||
Definition | An identifier that is unique within the Measure allowing linkage to the equivalent item in a MeasureReport resource. | ||||||||||||
Short Display | Unique id for supplementalData in measure | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | MeasureReport does not require omitted supplementalData to be included. | ||||||||||||
Comments | This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such | ||||||||||||
Invariants |
| ||||||||||||
Measure.supplementalData.code | |||||||||||||
Element Id | Measure.supplementalData.code | ||||||||||||
Definition | Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures. | ||||||||||||
Short Display | Meaning of the supplemental data | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Meaning of the supplemental data. For example codes, see Measure Supplemental Data Example | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Measure.supplementalData.usage | |||||||||||||
Element Id | 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. | ||||||||||||
Short Display | supplemental-data | risk-adjustment-factor | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | The intended usage for supplemental data elements in the measure. The codes SHALL be taken from Measure Data Usage; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
Measure.supplementalData.description | |||||||||||||
Element Id | Measure.supplementalData.description | ||||||||||||
Definition | The human readable description of this supplemental data. | ||||||||||||
Short Display | The human readable description of this supplemental data | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Invariants |
| ||||||||||||
Measure.supplementalData.criteria | |||||||||||||
Element Id | Measure.supplementalData.criteria | ||||||||||||
Definition | The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element. | ||||||||||||
Short Display | Expression describing additional data to be reported | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Expression | ||||||||||||
Invariants |
|