This page is part of the FHIR Specification (v3.0.2: STU 3). 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 R2
Clinical Quality Information Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Patient |
StructureDefinition for measurereport
{ "resourceType": "StructureDefinition", "id": "MeasureReport", "meta": { "lastUpdated": "2019-10-24T11:53:00+11:00" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "cqi" } ], "url": "http://hl7.org/fhir/StructureDefinition/MeasureReport", "name": "MeasureReport", "status": "draft", "date": "2019-10-24T11:53:00+11:00", "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" } ] } ], "description": "Base StructureDefinition for MeasureReport Resource", "fhirVersion": "3.0.2", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "resource", "abstract": false, "type": "MeasureReport", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource", "derivation": "specialization", "snapshot": { "element": [ { "id": "MeasureReport", "path": "MeasureReport", "short": "Results of a measure evaluation", "definition": "The MeasureReport resource contains the results of evaluating a 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": "workflow", "map": "Event" }, { "identity": "w5", "map": "clinical.general" } ] }, { "id": "MeasureReport.id", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.meta", "path": "MeasureReport.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": "MeasureReport.implicitRules", "path": "MeasureReport.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.", "comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "id": "MeasureReport.language", "path": "MeasureReport.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "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" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } }, { "id": "MeasureReport.text", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.contained", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.extension", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.modifierExtension", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.identifier", "path": "MeasureReport.identifier", "short": "Additional identifier for the Report", "definition": "A formal identifier that is used to identify this report when it is represented in other formats, or referenced in a specification, model, design or an instance.", "comment": "Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this {{title}} outside of FHIR, where the logical URL is not possible to use.", "requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] }, { "id": "MeasureReport.status", "path": "MeasureReport.status", "short": "complete | pending | error", "definition": "The report status. No data will be available until the report status is complete.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasureReportStatus" } ], "strength": "required", "description": "The status of the measure report", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-report-status" } }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "status" } ] }, { "id": "MeasureReport.type", "path": "MeasureReport.type", "short": "individual | patient-list | summary", "definition": "The type of measure report. This may be an individual report, which provides a single patient's score for the measure; a patient listing, which returns the list of patients that meet the various criteria in the measure; or a summary report, which returns a population count for each of the criteria in the measure.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasureReportType" } ], "strength": "required", "description": "The type of the measure report", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-report-type" } }, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "class" } ] }, { "id": "MeasureReport.measure", "path": "MeasureReport.measure", "short": "What measure was evaluated", "definition": "A reference to the Measure that was evaluated to produce this report.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Measure" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.definition" }, { "identity": "w5", "map": "what" } ] }, { "id": "MeasureReport.patient", "path": "MeasureReport.patient", "short": "What patient the report is for", "definition": "Optional Patient if the report was requested for a single patient.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "MeasureReport.date", "path": "MeasureReport.date", "short": "When the report was generated", "definition": "The date this measure report was generated.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrenceDateTime" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "MeasureReport.reportingOrganization", "path": "MeasureReport.reportingOrganization", "short": "Who is reporting the data", "definition": "Reporting Organization.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.source" } ] }, { "id": "MeasureReport.period", "path": "MeasureReport.period", "short": "What period the report covers", "definition": "The reporting period for which the report was calculated.", "min": 1, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true }, { "id": "MeasureReport.group", "path": "MeasureReport.group", "short": "Measure results for each group", "definition": "The results of the calculation, one for each population group in 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": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false }, { "id": "MeasureReport.group.id", "path": "MeasureReport.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": "MeasureReport.group.extension", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.group.modifierExtension", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.group.identifier", "path": "MeasureReport.group.identifier", "short": "What group of the measure", "definition": "The identifier of the population group as defined in the measure definition.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": false }, { "id": "MeasureReport.group.population", "path": "MeasureReport.group.population", "short": "The populations in the group", "definition": "The populations that make up the population group, one for each type of population appropriate 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": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false }, { "id": "MeasureReport.group.population.id", "path": "MeasureReport.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": "MeasureReport.group.population.extension", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.group.population.modifierExtension", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.group.population.identifier", "path": "MeasureReport.group.population.identifier", "short": "Population identifier as defined in the measure", "definition": "The identifier of the population being reported, as defined by the population element of the measure.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true }, { "id": "MeasureReport.group.population.code", "path": "MeasureReport.group.population.code", "short": "initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score", "definition": "The type of the population.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasurePopulation" } ], "strength": "extensible", "description": "The type of population (e.g. initial, numerator, denominator, etc.)", "valueSetUri": "http://hl7.org/fhir/ValueSet/measure-population" } }, { "id": "MeasureReport.group.population.count", "path": "MeasureReport.group.population.count", "short": "Size of the population", "definition": "The number of members of the population.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": false }, { "id": "MeasureReport.group.population.patients", "path": "MeasureReport.group.population.patients", "short": "For patient-list reports, the patients in this population", "definition": "This element refers to a List of patient level MeasureReport resources, one for each patient in this population.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/List" } ], "isSummary": false }, { "id": "MeasureReport.group.measureScore", "path": "MeasureReport.group.measureScore", "short": "What score this group achieved", "definition": "The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "id": "MeasureReport.group.stratifier", "path": "MeasureReport.group.stratifier", "short": "Stratification results", "definition": "When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by 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": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.id", "path": "MeasureReport.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": "MeasureReport.group.stratifier.extension", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.group.stratifier.modifierExtension", "path": "MeasureReport.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.", "comment": "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": "MeasureReport.group.stratifier.identifier", "path": "MeasureReport.group.stratifier.identifier", "short": "What stratifier of the group", "definition": "The identifier of this stratifier, as defined in the measure definition.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "StratifierGroup" } ], "path": "MeasureReport.group.stratifier.stratum", "short": "Stratum results, one for each unique value in the stratifier", "definition": "This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum.id", "path": "MeasureReport.group.stratifier.stratum.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": "MeasureReport.group.stratifier.stratum.extension", "path": "MeasureReport.group.stratifier.stratum.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.", "comment": "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": "MeasureReport.group.stratifier.stratum.modifierExtension", "path": "MeasureReport.group.stratifier.stratum.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.", "comment": "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": "MeasureReport.group.stratifier.stratum.value", "path": "MeasureReport.group.stratifier.stratum.value", "short": "The stratum value, e.g. male", "definition": "The value for this stratum, expressed as a string. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum.population", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "StratifierGroupPopulation" } ], "path": "MeasureReport.group.stratifier.stratum.population", "short": "Population results in this stratum", "definition": "The populations that make up the stratum, one for each type of population appropriate to 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": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum.population.id", "path": "MeasureReport.group.stratifier.stratum.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": "MeasureReport.group.stratifier.stratum.population.extension", "path": "MeasureReport.group.stratifier.stratum.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.", "comment": "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": "MeasureReport.group.stratifier.stratum.population.modifierExtension", "path": "MeasureReport.group.stratifier.stratum.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.", "comment": "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": "MeasureReport.group.stratifier.stratum.population.identifier", "path": "MeasureReport.group.stratifier.stratum.population.identifier", "short": "Population identifier as defined in the measure", "definition": "The identifier of the population being reported, as defined by the population element of the measure.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true }, { "id": "MeasureReport.group.stratifier.stratum.population.code", "path": "MeasureReport.group.stratifier.stratum.population.code", "short": "initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score", "definition": "The type of the population.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasurePopulation" } ], "strength": "extensible", "description": "The type of population (e.g. initial, numerator, denominator, etc.)", "valueSetUri": "http://hl7.org/fhir/ValueSet/measure-population" } }, { "id": "MeasureReport.group.stratifier.stratum.population.count", "path": "MeasureReport.group.stratifier.stratum.population.count", "short": "Size of the population", "definition": "The number of members of the population in this stratum.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum.population.patients", "path": "MeasureReport.group.stratifier.stratum.population.patients", "short": "For patient-list reports, the patients in this population", "definition": "This element refers to a List of patient level MeasureReport resources, one for each patient in this population in this stratum.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/List" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum.measureScore", "path": "MeasureReport.group.stratifier.stratum.measureScore", "short": "What score this stratum achieved", "definition": "The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "id": "MeasureReport.evaluatedResources", "path": "MeasureReport.evaluatedResources", "short": "What data was evaluated to produce the measure score", "definition": "A reference to a Bundle containing the Resources that were used in the evaluation of this report.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Bundle" } ], "isSummary": false } ] }, "differential": { "element": [ { "id": "MeasureReport", "path": "MeasureReport", "short": "Results of a measure evaluation", "definition": "The MeasureReport resource contains the results of evaluating a measure.", "min": 0, "max": "*", "mapping": [ { "identity": "workflow", "map": "Event" }, { "identity": "w5", "map": "clinical.general" } ] }, { "id": "MeasureReport.identifier", "path": "MeasureReport.identifier", "short": "Additional identifier for the Report", "definition": "A formal identifier that is used to identify this report when it is represented in other formats, or referenced in a specification, model, design or an instance.", "comment": "Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this {{title}} outside of FHIR, where the logical URL is not possible to use.", "requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "id" } ] }, { "id": "MeasureReport.status", "path": "MeasureReport.status", "short": "complete | pending | error", "definition": "The report status. No data will be available until the report status is complete.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasureReportStatus" } ], "strength": "required", "description": "The status of the measure report", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-report-status" } }, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "status" } ] }, { "id": "MeasureReport.type", "path": "MeasureReport.type", "short": "individual | patient-list | summary", "definition": "The type of measure report. This may be an individual report, which provides a single patient's score for the measure; a patient listing, which returns the list of patients that meet the various criteria in the measure; or a summary report, which returns a population count for each of the criteria in the measure.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasureReportType" } ], "strength": "required", "description": "The type of the measure report", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/measure-report-type" } }, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "class" } ] }, { "id": "MeasureReport.measure", "path": "MeasureReport.measure", "short": "What measure was evaluated", "definition": "A reference to the Measure that was evaluated to produce this report.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Measure" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.definition" }, { "identity": "w5", "map": "what" } ] }, { "id": "MeasureReport.patient", "path": "MeasureReport.patient", "short": "What patient the report is for", "definition": "Optional Patient if the report was requested for a single patient.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "MeasureReport.date", "path": "MeasureReport.date", "short": "When the report was generated", "definition": "The date this measure report was generated.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrenceDateTime" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "MeasureReport.reportingOrganization", "path": "MeasureReport.reportingOrganization", "short": "Who is reporting the data", "definition": "Reporting Organization.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "who.source" } ] }, { "id": "MeasureReport.period", "path": "MeasureReport.period", "short": "What period the report covers", "definition": "The reporting period for which the report was calculated.", "min": 1, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true }, { "id": "MeasureReport.group", "path": "MeasureReport.group", "short": "Measure results for each group", "definition": "The results of the calculation, one for each population group in the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": false }, { "id": "MeasureReport.group.identifier", "path": "MeasureReport.group.identifier", "short": "What group of the measure", "definition": "The identifier of the population group as defined in the measure definition.", "min": 1, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": false }, { "id": "MeasureReport.group.population", "path": "MeasureReport.group.population", "short": "The populations in the group", "definition": "The populations that make up the population group, one for each type of population appropriate for the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": false }, { "id": "MeasureReport.group.population.identifier", "path": "MeasureReport.group.population.identifier", "short": "Population identifier as defined in the measure", "definition": "The identifier of the population being reported, as defined by the population element of the measure.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true }, { "id": "MeasureReport.group.population.code", "path": "MeasureReport.group.population.code", "short": "initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score", "definition": "The type of the population.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasurePopulation" } ], "strength": "extensible", "description": "The type of population (e.g. initial, numerator, denominator, etc.)", "valueSetUri": "http://hl7.org/fhir/ValueSet/measure-population" } }, { "id": "MeasureReport.group.population.count", "path": "MeasureReport.group.population.count", "short": "Size of the population", "definition": "The number of members of the population.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": false }, { "id": "MeasureReport.group.population.patients", "path": "MeasureReport.group.population.patients", "short": "For patient-list reports, the patients in this population", "definition": "This element refers to a List of patient level MeasureReport resources, one for each patient in this population.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/List" } ], "isSummary": false }, { "id": "MeasureReport.group.measureScore", "path": "MeasureReport.group.measureScore", "short": "What score this group achieved", "definition": "The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "id": "MeasureReport.group.stratifier", "path": "MeasureReport.group.stratifier", "short": "Stratification results", "definition": "When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.identifier", "path": "MeasureReport.group.stratifier.identifier", "short": "What stratifier of the group", "definition": "The identifier of this stratifier, as defined in the measure definition.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "StratifierGroup" } ], "path": "MeasureReport.group.stratifier.stratum", "short": "Stratum results, one for each unique value in the stratifier", "definition": "This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum.value", "path": "MeasureReport.group.stratifier.stratum.value", "short": "The stratum value, e.g. male", "definition": "The value for this stratum, expressed as a string. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum.population", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "StratifierGroupPopulation" } ], "path": "MeasureReport.group.stratifier.stratum.population", "short": "Population results in this stratum", "definition": "The populations that make up the stratum, one for each type of population appropriate to the measure.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum.population.identifier", "path": "MeasureReport.group.stratifier.stratum.population.identifier", "short": "Population identifier as defined in the measure", "definition": "The identifier of the population being reported, as defined by the population element of the measure.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true }, { "id": "MeasureReport.group.stratifier.stratum.population.code", "path": "MeasureReport.group.stratifier.stratum.population.code", "short": "initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score", "definition": "The type of the population.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MeasurePopulation" } ], "strength": "extensible", "description": "The type of population (e.g. initial, numerator, denominator, etc.)", "valueSetUri": "http://hl7.org/fhir/ValueSet/measure-population" } }, { "id": "MeasureReport.group.stratifier.stratum.population.count", "path": "MeasureReport.group.stratifier.stratum.population.count", "short": "Size of the population", "definition": "The number of members of the population in this stratum.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum.population.patients", "path": "MeasureReport.group.stratifier.stratum.population.patients", "short": "For patient-list reports, the patients in this population", "definition": "This element refers to a List of patient level MeasureReport resources, one for each patient in this population in this stratum.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/List" } ], "isSummary": false }, { "id": "MeasureReport.group.stratifier.stratum.measureScore", "path": "MeasureReport.group.stratifier.stratum.measureScore", "short": "What score this stratum achieved", "definition": "The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.", "min": 0, "max": "1", "type": [ { "code": "decimal" } ], "isSummary": true }, { "id": "MeasureReport.evaluatedResources", "path": "MeasureReport.evaluatedResources", "short": "What data was evaluated to produce the measure score", "definition": "A reference to a Bundle containing the Resources that were used in the evaluation of this report.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Bundle" } ], "isSummary": false } ] } }
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.