This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
StructureDefinition for measure
{ "resourceType": "StructureDefinition", "id": "Measure", "meta": { "lastUpdated": "2016-12-06T12:22:34.981+11:00" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 0 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "cqi" } ], "url": "http://hl7.org/fhir/StructureDefinition/Measure", "name": "Measure", "status": "draft", "publisher": "Health Level Seven International (Clinical Quality Information)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/cqi/index.cfm" } ] } ], "date": "2016-12-06T12:22:34+11:00", "description": "Base StructureDefinition for Measure Resource", "fhirVersion": "1.8.0", "mapping": [ { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" }, { "identity": "objimpl", "uri": "http://hl7.org/fhir/object-implementation", "name": "Object Implementation Information" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "resource", "abstract": false, "type": "Measure", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource", "_baseDefinition": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super", "valueString": "MetadataResource" } ] }, "derivation": "specialization", "snapshot": { "element": [ { "id": "Measure", "path": "Measure", "short": "A quality measure definition", "definition": "The Measure resource provides the definition of a quality measure.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "w5", "map": "clinical.general" } ] }, { "id": "Measure.id", "path": "Measure.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "isSummary": true }, { "id": "Measure.meta", "path": "Measure.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "isSummary": true }, { "id": "Measure.implicitRules", "path": "Measure.implicitRules", "short": "A set of rules under which this content was created", "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.", "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 as much as possible.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "id": "Measure.language", "path": "Measure.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } }, { "id": "Measure.text", "path": "Measure.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may 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.", "comments": "Contained resources do not have 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 in formation is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Measure.contained", "path": "Measure.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Measure.extension", "path": "Measure.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Measure.modifierExtension", "path": "Measure.modifierExtension", "short": "Extensions that cannot be ignored", "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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Measure.url", "path": "Measure.url", "short": "Logical uri to reference this measure (globally unique)", "definition": "An absolute URL that is used to identify this measure when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published. The URL SHOULD include the major version of the measure. For more information see [Technical and Business Versions](resource.html#versions).", "comments": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.", "requirements": "Allows the measure to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] }, { "id": "Measure.identifier", "path": "Measure.identifier", "short": "Additional identifier for the measure", "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.", "comments": "Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this measure outside of FHIR, where the logical URL is not possible to use.", "requirements": "Allows externally provided and/or useable business identifiers to be easily associated with the module.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] }, { "id": "Measure.version", "path": "Measure.version", "short": "Business version of the measure", "definition": "The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", "comments": "There may be multiple different instances of a measure that have the same identifier but different versions.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id.version" } ] }, { "id": "Measure.name", "path": "Measure.name", "short": "Name for this measure (Computer friendly)", "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.", "comments": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.", "requirements": "Support human navigation & code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.title", "path": "Measure.title", "short": "Name for this measure (Human friendly)", "definition": "A short, descriptive, user-friendly title for the measure.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.status", "path": "Measure.status", "short": "draft | active | retired", "definition": "The status of this measure. Enables tracking the life-cycle of the content.", "comments": "Allows filtering of measure that are appropriate for use vs. not.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "The lifecycle status of a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] }, { "id": "Measure.experimental", "path": "Measure.experimental", "short": "If for testing purposes, not real usage", "definition": "A flag to indicate that this measure is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comments": "Allows filtering of measure that are appropriate for use vs. not.", "requirements": "Enables experimental content to be developed following the same life-cycle as a production-level measure would.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "w5", "map": "class" } ] }, { "id": "Measure.date", "path": "Measure.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the measure was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.", "comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the measure. Additional specific dates may be added as extensions.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.recorded" } ] }, { "id": "Measure.description", "path": "Measure.description", "short": "Natural language description of the measure", "definition": "A free text natural language description of the measure from the consumer's perspective.", "comments": "This description can be used to capture details such as why the measure was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ] }, { "id": "Measure.purpose", "path": "Measure.purpose", "short": "Why this measure is defined", "definition": "Explains why this measure is needed and why it has been designed as it has.", "comments": "This element does not describe the usage of the measure (See, e.g, the comments element, or relatedArtifacts), rather it's for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] }, { "id": "Measure.usage", "path": "Measure.usage", "short": "Describes the clinical usage of the measure", "definition": "A detailed description of how the measure is used from a clinical perspective.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.approvalDate", "path": "Measure.approvalDate", "short": "When measure approved by publisher", "definition": "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.", "comments": "The date may be more recent than the approval date because of minor changes / editorial corrections.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Measure.lastReviewDate", "path": "Measure.lastReviewDate", "short": "Last review date for the measure", "definition": "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.", "comments": "If specified, this is usually after the approval date.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Measure.effectivePeriod", "path": "Measure.effectivePeriod", "short": "The effective date range for the measure", "definition": "The period during which the measure content was or is planned to be effective.", "comments": "The effective period for a measure determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Measure.useContext", "path": "Measure.useContext", "short": "Content intends to support these contexts", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.", "comments": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true }, { "id": "Measure.jurisdiction", "path": "Measure.jurisdiction", "short": "Intended jurisdiction for measure (if applicable)", "definition": "A jurisdiction in which the measure is intended to be used.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "extensible", "description": "Countries and regions within which this artifact is targeted for use", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } }, { "id": "Measure.topic", "path": "Measure.topic", "short": "Descriptional topics for the measure", "definition": "Clinical topics related to the content of the measure.", "requirements": "Repositories must be able to determine how to categorize the measure so that it can be found by topical searches.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ] }, { "id": "Measure.contributor", "path": "Measure.contributor", "short": "A content contributor", "definition": "A contributor to the content of the measure, including authors, editors, reviewers, and endorsers.", "requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the measure.", "min": 0, "max": "*", "type": [ { "code": "Contributor" } ] }, { "id": "Measure.publisher", "path": "Measure.publisher", "short": "Name of the publisher (Organization or individual)", "definition": "The name of the individual or organization that published the measure.", "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.", "requirements": "Helps establish the \"authority/credibility\" of the measure. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.witness" } ] }, { "id": "Measure.contact", "path": "Measure.contact", "short": "Contact details for the publisher", "definition": "Contact details to assist a user in finding and communicating with the publisher.", "comments": "May be a web site, an email address, a telephone number, etc.", "min": 0, "max": "*", "type": [ { "code": "ContactDetail" } ], "isSummary": true }, { "id": "Measure.copyright", "path": "Measure.copyright", "short": "Use and/or publishing restrictions", "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.", "requirements": "Consumers of the library must be able to determine any legal restrictions on the use of the measure and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Measure.relatedArtifact", "path": "Measure.relatedArtifact", "short": "Related artifacts for the measure", "definition": "Related artifacts such as additional documentation, justification, or bibliographic references.", "comments": "Each related artifact is either an attachment, or a reference to another resource, but not both.", "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.", "min": 0, "max": "*", "type": [ { "code": "RelatedArtifact" } ] }, { "id": "Measure.library", "path": "Measure.library", "short": "Logic used by the measure", "definition": "A reference to a Library resource containing the formal logic used by the measure.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Library" } ] }, { "id": "Measure.disclaimer", "path": "Measure.disclaimer", "short": "Disclaimer for the measure", "definition": "A disclaimer for the use of the measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true }, { "id": "Measure.scoring", "path": "Measure.scoring", "short": "proportion | ratio | continuous-variable | cohort", "definition": "The measure scoring type, e.g. proportion, CV.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "The scoring type of the measure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-scoring" } } }, { "id": "Measure.compositeScoring", "path": "Measure.compositeScoring", "short": "opportunity | all-or-nothing | linear | weighted", "definition": "If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "The composite scoring method of the measure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/composite-measure-scoring" } } }, { "id": "Measure.type", "path": "Measure.type", "short": "process | outcome | structure | patient-reported-outcome | composite", "definition": "The measure type, e.g. process, outcome.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "The type of measure (includes codes from 2.16.840.1.113883.1.11.20368)", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-type" } } }, { "id": "Measure.riskAdjustment", "path": "Measure.riskAdjustment", "short": "How is risk adjustment applied for this measure", "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.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.rateAggregation", "path": "Measure.rateAggregation", "short": "How is rate aggregation performed for this measure", "definition": "A description of the rate aggregation for the measure.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.rationale", "path": "Measure.rationale", "short": "Why does this measure exist", "definition": "The rationale for the measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true }, { "id": "Measure.clinicalRecommendationStatement", "path": "Measure.clinicalRecommendationStatement", "short": "Clinical recommendation", "definition": "The clinical recommendation statement for the measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true }, { "id": "Measure.improvementNotation", "path": "Measure.improvementNotation", "short": "Improvement notation for the measure, e.g. higher score indicates better quality", "definition": "Improvement notation for the measure, e.g. higher score indicates better quality.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.definition", "path": "Measure.definition", "short": "A natural language definition of the measure", "definition": "A narrative description of the complete measure calculation.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true }, { "id": "Measure.guidance", "path": "Measure.guidance", "short": "The guidance for the measure", "definition": "Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true }, { "id": "Measure.set", "path": "Measure.set", "short": "The measure set, e.g. Preventive Care and Screening", "definition": "The measure set, e.g. Preventive Care and Screening.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.group", "path": "Measure.group", "short": "Population criteria group", "definition": "A group of population criteria for the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "children().count() > id.count()", "xpath": "@value|f:*|h:div", "source": "Element" } ] }, { "id": "Measure.group.id", "path": "Measure.group.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Measure.group.extension", "path": "Measure.group.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Measure.group.modifierExtension", "path": "Measure.group.modifierExtension", "short": "Extensions that cannot be ignored", "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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Measure.group.identifier", "path": "Measure.group.identifier", "short": "Unique identifier", "definition": "A unique identifier for the group. This identifier will used to report data for the group in the measure report.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ] }, { "id": "Measure.group.name", "path": "Measure.group.name", "short": "Short name", "definition": "Optional name or short description of this group.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.description", "path": "Measure.group.description", "short": "Summary description", "definition": "The human readable description of this population group.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.population", "path": "Measure.group.population", "short": "Population criteria", "definition": "A population criteria for the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "children().count() > id.count()", "xpath": "@value|f:*|h:div", "source": "Element" } ] }, { "id": "Measure.group.population.id", "path": "Measure.group.population.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Measure.group.population.extension", "path": "Measure.group.population.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Measure.group.population.modifierExtension", "path": "Measure.group.population.modifierExtension", "short": "Extensions that cannot be ignored", "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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Measure.group.population.type", "path": "Measure.group.population.type", "short": "initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation", "definition": "The type of population criteria.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "The type of population", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-population" } } }, { "id": "Measure.group.population.identifier", "path": "Measure.group.population.identifier", "short": "Unique identifier", "definition": "A unique identifier for the population criteria. This identifier is used to report data against this criteria within the measure report.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ] }, { "id": "Measure.group.population.name", "path": "Measure.group.population.name", "short": "Short name", "definition": "Optional name or short description of this population.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.population.description", "path": "Measure.group.population.description", "short": "The human readable description of this population criteria", "definition": "The human readable description of this population criteria.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.population.criteria", "path": "Measure.group.population.criteria", "short": "The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria", "definition": "The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria.", "min": 1, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.stratifier", "path": "Measure.group.stratifier", "short": "Stratifier criteria for the measure", "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.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "children().count() > id.count()", "xpath": "@value|f:*|h:div", "source": "Element" } ] }, { "id": "Measure.group.stratifier.id", "path": "Measure.group.stratifier.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Measure.group.stratifier.extension", "path": "Measure.group.stratifier.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Measure.group.stratifier.modifierExtension", "path": "Measure.group.stratifier.modifierExtension", "short": "Extensions that cannot be ignored", "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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Measure.group.stratifier.identifier", "path": "Measure.group.stratifier.identifier", "short": "The identifier for the stratifier used to coordinate the reported data back to this stratifier", "definition": "The identifier for the stratifier used to coordinate the reported data back to this stratifier.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ] }, { "id": "Measure.group.stratifier.criteria", "path": "Measure.group.stratifier.criteria", "short": "Stratifier criteria", "definition": "The criteria for the stratifier. This must be the name of an expression defined within a referenced library.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.stratifier.path", "path": "Measure.group.stratifier.path", "short": "Path to the stratifier", "definition": "The path to an element that defines the stratifier, specified as a valid FHIR resource path.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.supplementalData", "path": "Measure.supplementalData", "short": "Supplemental data", "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.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "children().count() > id.count()", "xpath": "@value|f:*|h:div", "source": "Element" } ] }, { "id": "Measure.supplementalData.id", "path": "Measure.supplementalData.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Measure.supplementalData.extension", "path": "Measure.supplementalData.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Measure.supplementalData.modifierExtension", "path": "Measure.supplementalData.modifierExtension", "short": "Extensions that cannot be ignored", "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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.", "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Measure.supplementalData.identifier", "path": "Measure.supplementalData.identifier", "short": "Identifier, unique within the measure", "definition": "An identifier for the supplemental data.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ] }, { "id": "Measure.supplementalData.usage", "path": "Measure.supplementalData.usage", "short": "supplemental-data | risk-adjustment-factor", "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.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "The intended usage for supplemental data elements in the measure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-data-usage" } } }, { "id": "Measure.supplementalData.criteria", "path": "Measure.supplementalData.criteria", "short": "Supplemental data criteria", "definition": "The criteria for the supplemental data. This must be the name of a valid expression defined within a referenced library, and defines the data to be returned for this element.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.supplementalData.path", "path": "Measure.supplementalData.path", "short": "Path to the supplemental data element", "definition": "The supplemental data to be supplied as part of the measure response, specified as a valid FHIR Resource Path.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] }, "differential": { "element": [ { "id": "Measure", "path": "Measure", "short": "A quality measure definition", "definition": "The Measure resource provides the definition of a quality measure.", "min": 0, "max": "*", "mapping": [ { "identity": "w5", "map": "clinical.general" } ] }, { "id": "Measure.url", "path": "Measure.url", "short": "Logical uri to reference this measure (globally unique)", "definition": "An absolute URL that is used to identify this measure when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published. The URL SHOULD include the major version of the measure. For more information see [Technical and Business Versions](resource.html#versions).", "comments": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.", "requirements": "Allows the measure to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] }, { "id": "Measure.identifier", "path": "Measure.identifier", "short": "Additional identifier for the measure", "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.", "comments": "Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this measure outside of FHIR, where the logical URL is not possible to use.", "requirements": "Allows externally provided and/or useable business identifiers to be easily associated with the module.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "id" } ] }, { "id": "Measure.version", "path": "Measure.version", "short": "Business version of the measure", "definition": "The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", "comments": "There may be multiple different instances of a measure that have the same identifier but different versions.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id.version" } ] }, { "id": "Measure.name", "path": "Measure.name", "short": "Name for this measure (Computer friendly)", "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.", "comments": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.", "requirements": "Support human navigation & code generation.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.title", "path": "Measure.title", "short": "Name for this measure (Human friendly)", "definition": "A short, descriptive, user-friendly title for the measure.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.status", "path": "Measure.status", "short": "draft | active | retired", "definition": "The status of this measure. Enables tracking the life-cycle of the content.", "comments": "Allows filtering of measure that are appropriate for use vs. not.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "The lifecycle status of a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "w5", "map": "status" } ] }, { "id": "Measure.experimental", "path": "Measure.experimental", "short": "If for testing purposes, not real usage", "definition": "A flag to indicate that this measure is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comments": "Allows filtering of measure that are appropriate for use vs. not.", "requirements": "Enables experimental content to be developed following the same life-cycle as a production-level measure would.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "w5", "map": "class" } ] }, { "id": "Measure.date", "path": "Measure.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the measure was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.", "comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the measure. Additional specific dates may be added as extensions.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "when.recorded" } ] }, { "id": "Measure.description", "path": "Measure.description", "short": "Natural language description of the measure", "definition": "A free text natural language description of the measure from the consumer's perspective.", "comments": "This description can be used to capture details such as why the measure was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ] }, { "id": "Measure.purpose", "path": "Measure.purpose", "short": "Why this measure is defined", "definition": "Explains why this measure is needed and why it has been designed as it has.", "comments": "This element does not describe the usage of the measure (See, e.g, the comments element, or relatedArtifacts), rather it's for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] }, { "id": "Measure.usage", "path": "Measure.usage", "short": "Describes the clinical usage of the measure", "definition": "A detailed description of how the measure is used from a clinical perspective.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.approvalDate", "path": "Measure.approvalDate", "short": "When measure approved by publisher", "definition": "The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.", "comments": "The date may be more recent than the approval date because of minor changes / editorial corrections.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Measure.lastReviewDate", "path": "Measure.lastReviewDate", "short": "Last review date for the measure", "definition": "The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.", "comments": "If specified, this is usually after the approval date.", "min": 0, "max": "1", "type": [ { "code": "date" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Measure.effectivePeriod", "path": "Measure.effectivePeriod", "short": "The effective date range for the measure", "definition": "The period during which the measure content was or is planned to be effective.", "comments": "The effective period for a measure determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Measure.useContext", "path": "Measure.useContext", "short": "Content intends to support these contexts", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.", "comments": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true }, { "id": "Measure.jurisdiction", "path": "Measure.jurisdiction", "short": "Intended jurisdiction for measure (if applicable)", "definition": "A jurisdiction in which the measure is intended to be used.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "extensible", "description": "Countries and regions within which this artifact is targeted for use", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } } }, { "id": "Measure.topic", "path": "Measure.topic", "short": "Descriptional topics for the measure", "definition": "Clinical topics related to the content of the measure.", "requirements": "Repositories must be able to determine how to categorize the measure so that it can be found by topical searches.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ] }, { "id": "Measure.contributor", "path": "Measure.contributor", "short": "A content contributor", "definition": "A contributor to the content of the measure, including authors, editors, reviewers, and endorsers.", "requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the measure.", "min": 0, "max": "*", "type": [ { "code": "Contributor" } ] }, { "id": "Measure.publisher", "path": "Measure.publisher", "short": "Name of the publisher (Organization or individual)", "definition": "The name of the individual or organization that published the measure.", "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.", "requirements": "Helps establish the \"authority/credibility\" of the measure. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.witness" } ] }, { "id": "Measure.contact", "path": "Measure.contact", "short": "Contact details for the publisher", "definition": "Contact details to assist a user in finding and communicating with the publisher.", "comments": "May be a web site, an email address, a telephone number, etc.", "min": 0, "max": "*", "type": [ { "code": "ContactDetail" } ], "isSummary": true }, { "id": "Measure.copyright", "path": "Measure.copyright", "short": "Use and/or publishing restrictions", "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.", "requirements": "Consumers of the library must be able to determine any legal restrictions on the use of the measure and/or its content.", "alias": [ "License", "Restrictions" ], "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "objimpl", "map": "no-gen-base" } ] }, { "id": "Measure.relatedArtifact", "path": "Measure.relatedArtifact", "short": "Related artifacts for the measure", "definition": "Related artifacts such as additional documentation, justification, or bibliographic references.", "comments": "Each related artifact is either an attachment, or a reference to another resource, but not both.", "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.", "min": 0, "max": "*", "type": [ { "code": "RelatedArtifact" } ] }, { "id": "Measure.library", "path": "Measure.library", "short": "Logic used by the measure", "definition": "A reference to a Library resource containing the formal logic used by the measure.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Library" } ] }, { "id": "Measure.disclaimer", "path": "Measure.disclaimer", "short": "Disclaimer for the measure", "definition": "A disclaimer for the use of the measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true }, { "id": "Measure.scoring", "path": "Measure.scoring", "short": "proportion | ratio | continuous-variable | cohort", "definition": "The measure scoring type, e.g. proportion, CV.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "The scoring type of the measure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-scoring" } } }, { "id": "Measure.compositeScoring", "path": "Measure.compositeScoring", "short": "opportunity | all-or-nothing | linear | weighted", "definition": "If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "The composite scoring method of the measure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/composite-measure-scoring" } } }, { "id": "Measure.type", "path": "Measure.type", "short": "process | outcome | structure | patient-reported-outcome | composite", "definition": "The measure type, e.g. process, outcome.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "The type of measure (includes codes from 2.16.840.1.113883.1.11.20368)", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-type" } } }, { "id": "Measure.riskAdjustment", "path": "Measure.riskAdjustment", "short": "How is risk adjustment applied for this measure", "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.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.rateAggregation", "path": "Measure.rateAggregation", "short": "How is rate aggregation performed for this measure", "definition": "A description of the rate aggregation for the measure.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.rationale", "path": "Measure.rationale", "short": "Why does this measure exist", "definition": "The rationale for the measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true }, { "id": "Measure.clinicalRecommendationStatement", "path": "Measure.clinicalRecommendationStatement", "short": "Clinical recommendation", "definition": "The clinical recommendation statement for the measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true }, { "id": "Measure.improvementNotation", "path": "Measure.improvementNotation", "short": "Improvement notation for the measure, e.g. higher score indicates better quality", "definition": "Improvement notation for the measure, e.g. higher score indicates better quality.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.definition", "path": "Measure.definition", "short": "A natural language definition of the measure", "definition": "A narrative description of the complete measure calculation.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true }, { "id": "Measure.guidance", "path": "Measure.guidance", "short": "The guidance for the measure", "definition": "Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "isSummary": true }, { "id": "Measure.set", "path": "Measure.set", "short": "The measure set, e.g. Preventive Care and Screening", "definition": "The measure set, e.g. Preventive Care and Screening.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Measure.group", "path": "Measure.group", "short": "Population criteria group", "definition": "A group of population criteria for the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ] }, { "id": "Measure.group.identifier", "path": "Measure.group.identifier", "short": "Unique identifier", "definition": "A unique identifier for the group. This identifier will used to report data for the group in the measure report.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ] }, { "id": "Measure.group.name", "path": "Measure.group.name", "short": "Short name", "definition": "Optional name or short description of this group.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.description", "path": "Measure.group.description", "short": "Summary description", "definition": "The human readable description of this population group.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.population", "path": "Measure.group.population", "short": "Population criteria", "definition": "A population criteria for the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ] }, { "id": "Measure.group.population.type", "path": "Measure.group.population.type", "short": "initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation", "definition": "The type of population criteria.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "The type of population", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-population" } } }, { "id": "Measure.group.population.identifier", "path": "Measure.group.population.identifier", "short": "Unique identifier", "definition": "A unique identifier for the population criteria. This identifier is used to report data against this criteria within the measure report.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ] }, { "id": "Measure.group.population.name", "path": "Measure.group.population.name", "short": "Short name", "definition": "Optional name or short description of this population.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.population.description", "path": "Measure.group.population.description", "short": "The human readable description of this population criteria", "definition": "The human readable description of this population criteria.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.population.criteria", "path": "Measure.group.population.criteria", "short": "The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria", "definition": "The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria.", "min": 1, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.stratifier", "path": "Measure.group.stratifier", "short": "Stratifier criteria for the measure", "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.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ] }, { "id": "Measure.group.stratifier.identifier", "path": "Measure.group.stratifier.identifier", "short": "The identifier for the stratifier used to coordinate the reported data back to this stratifier", "definition": "The identifier for the stratifier used to coordinate the reported data back to this stratifier.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ] }, { "id": "Measure.group.stratifier.criteria", "path": "Measure.group.stratifier.criteria", "short": "Stratifier criteria", "definition": "The criteria for the stratifier. This must be the name of an expression defined within a referenced library.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.group.stratifier.path", "path": "Measure.group.stratifier.path", "short": "Path to the stratifier", "definition": "The path to an element that defines the stratifier, specified as a valid FHIR resource path.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.supplementalData", "path": "Measure.supplementalData", "short": "Supplemental data", "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.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ] }, { "id": "Measure.supplementalData.identifier", "path": "Measure.supplementalData.identifier", "short": "Identifier, unique within the measure", "definition": "An identifier for the supplemental data.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ] }, { "id": "Measure.supplementalData.usage", "path": "Measure.supplementalData.usage", "short": "supplemental-data | risk-adjustment-factor", "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.", "min": 0, "max": "*", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "The intended usage for supplemental data elements in the measure", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-data-usage" } } }, { "id": "Measure.supplementalData.criteria", "path": "Measure.supplementalData.criteria", "short": "Supplemental data criteria", "definition": "The criteria for the supplemental data. This must be the name of a valid expression defined within a referenced library, and defines the data to be returned for this element.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "Measure.supplementalData.path", "path": "Measure.supplementalData.path", "short": "Path to the supplemental data element", "definition": "The supplemental data to be supplied as part of the measure response, specified as a valid FHIR Resource Path.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.