This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v5.0.0-ballot: STU5 (v5.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.0.0. For a full list of available versions, see the Directory of published versions
Active as of 2018-06-19 |
Definitions for the datax-measurereport-deqm resource profile.
Guidance on how to interpret the contents of this table can be found here
0. MeasureReport | |
Must Support | false |
2. MeasureReport.extension:updatetype | |
Slice Name | updatetype |
Control | 1..1 |
Type | Extension(DEQM Submit Data Update Type Extension) (Extension Type: code) |
Must Support | true |
4. MeasureReport.extension:software | |
Slice Name | software |
Control | 0..* |
Type | Extension(CRMI Software System) (Extension Type: Reference(CRMI Software System Device)) |
Must Support | true |
6. MeasureReport.extension:vendor | |
Slice Name | vendor |
Control | 0..1 |
Type | Extension(DEQM Reporting Vendor Extension) (Extension Type: Reference(QICore Organization)) |
Must Support | true |
8. MeasureReport.extension:location | |
Slice Name | location |
Control | 0..* |
Type | Extension(DEQM Data Location Extension) (Extension Type: Reference(QICore Location)) |
10. MeasureReport.extension:message | |
Slice Name | message |
Short | Messages encountered while creating the report |
Control | 0..1 |
Type | Extension(Messages) (Extension Type: Reference(OperationOutcome)) |
Must Support | true |
12. MeasureReport.extension:inputParameters | |
Slice Name | inputParameters |
Control | 0..1 |
Type | Extension(Input parameters) (Extension Type: Reference(Parameters)) |
Must Support | true |
14. MeasureReport.status | |
Binding | The codes SHALL be taken from MeasureReportStatus (required to http://hl7.org/fhir/ValueSet/measure-report-status ) |
Must Support | true |
16. MeasureReport.type | |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Fixed Value | data-collection |
18. MeasureReport.measure | |
Must Support | true |
Requirements | This will indicate the measure being reported on. For example, the cannonical uri location for the MRP measure. |
20. MeasureReport.subject | |
Control | 1..1 |
Type | Reference(QICore Patient, QICore Practitioner, QICore PractitionerRole, QICore Location, QICore Device, QICore RelatedPerson, Group) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
22. MeasureReport.date | |
Control | 1..1 |
Must Support | true |
24. MeasureReport.reporter | |
Definition | The organization where the measure was completed. |
Short | The organization where the measure was completed |
Control | 1..1 |
Type | Reference(QICore Organization) |
Must Support | true |
26. MeasureReport.reporter.extension:group | |
Slice Name | group |
Control | 0..1 |
Type | Extension(DEQM Reporter Group Extension) (Extension Type: Reference(Group)) |
Must Support | true |
28. MeasureReport.period | |
Control | 1..1 This element is affected by the following invariants: deqm-1 |
Type | Period |
Must Support | true |
Invariants | deqm-1: Date precision SHALL be at least to day ( YYYY-MM-DD ) (start.toString().length()>9 and end.toString().length()>9 ) |
30. MeasureReport.period.start | |
Control | 1..1 |
Must Support | true |
32. MeasureReport.period.end | |
Control | 1..1 |
Must Support | true |
34. MeasureReport.group | |
36. MeasureReport.group.population | |
38. MeasureReport.group.population.extension:description | |
Slice Name | description |
Short | Description of the population |
Control | 0..1 |
Type | Extension(Measure Report Population Description) (Extension Type: markdown) |
Must Support | true |
40. MeasureReport.group.measureScore | |
Control | 0..0 |
42. MeasureReport.group.stratifier | |
Control | 0..0 |
44. MeasureReport.evaluatedResource | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. MeasureReport | |
Definition | The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation. |
Short | Results of a measure evaluation |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) mrp-1: Measure Reports used for data collection SHALL NOT communicate group and score information ( (type != 'data-collection') or group.exists().not() )mrp-2: Stratifiers SHALL be either a single criteria or a set of criteria components ( group.stratifier.stratum.all(value.exists() xor component.exists()) )mrp-1: Measure Reports used for data collection SHALL NOT communicate group and score information ((type != 'data-collection') or group.exists().not()) mrp-2: Stratifiers SHALL be either a single criteria or a set of criteria components (group.stratifier.stratum.all(value.exists() xor component.exists())) |
2. MeasureReport.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. MeasureReport.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional content defined by implementations |
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. |
Control | 10..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on MeasureReport.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. MeasureReport.extension:updatetype | |
Slice Name | updatetype |
Definition | Optional Extension Element - found in all resources. |
Short | Optional Extensions Element |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(DEQM Submit Data Update Type Extension) (Extension Type: code) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
8. MeasureReport.extension:software | |
Slice Name | software |
Definition | Specifies the software systems used in the packaging and testing of knowledge artifacts. Specifically to support explicitly stating which versions of the various software components were used in the authoring, packaging, and testing. |
Short | Extension |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(CRMI Software System) (Extension Type: Reference(CRMI Software System Device)) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
10. MeasureReport.extension:vendor | |
Slice Name | vendor |
Definition | A reference to the vendor who queried the data, calculated results and/or generated the report. |
Short | Vendor information |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(DEQM Reporting Vendor Extension) (Extension Type: Reference(QICore Organization)) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
12. MeasureReport.extension:location | |
Slice Name | location |
Definition | Location from which reported data was gathered. This extension is used to provide the location(s) from which reported data was gathered in a MeasureReport, such as individual, summary and data exchange measure report. |
Short | Location(s) from which reported data was gathered |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(DEQM Data Location Extension) (Extension Type: Reference(QICore Location)) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
14. MeasureReport.extension:message | |
Slice Name | message |
Definition | An OperationOutcome resource with information, warning, or error messages that were generated as part of processing an operation. |
Short | Messages encountered while creating the report |
Control | 0..1 |
Type | Extension(Messages) (Extension Type: Reference(OperationOutcome)) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
16. MeasureReport.extension:inputParameters | |
Slice Name | inputParameters |
Definition | Specifies the input parameters to the operation (such as a test case description or a data requirements or evaluate operation). This extension can be used as part of the result of an operation to indicate what the parameters were, but it can also be used as part of the definition of a test case to specify what the input parameters are expected to be for the test case. |
Short | What parameters |
Control | 0..1 |
Type | Extension(Input parameters) (Extension Type: Reference(Parameters)) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
18. MeasureReport.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
20. MeasureReport.status | |
Definition | The MeasureReport status. No data will be available until the MeasureReport status is complete. |
Short | complete | pending | error |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from MeasureReportStatushttp://hl7.org/fhir/ValueSet/measure-report-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/measure-report-status ) |
Type | code |
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. MeasureReport.type | |
Definition | The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure. |
Short | individual | subject-list | summary | data-collection |
Comments | Data-collection reports are used only to communicate data-of-interest for a measure. They do not necessarily include all the data for a particular subject or population, but they may. |
Control | 1..1 This element is affected by the following invariants: mrp-1 |
Binding | The codes SHALL be taken from MeasureReportTypehttp://hl7.org/fhir/ValueSet/measure-report-type|4.0.1 (required to http://hl7.org/fhir/ValueSet/measure-report-type|4.0.1 )The type of the measure report. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Fixed Value | data-collection |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. MeasureReport.measure | |
Definition | A reference to the Measure that was calculated to produce this report. |
Short | What measure was calculated |
Control | 1..1 |
Type | canonical(Measure) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | This will indicate the measure being reported on. For example, the cannonical uri location for the MRP measure. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. MeasureReport.subject | |
Definition | Optional subject identifying the individual or individuals the report is for. |
Short | What individual(s) the report is for |
Control | 10..1 |
Type | Reference(QICore Patient, QICore Practitioner, QICore PractitionerRole, QICore Location, QICore Device, QICore RelatedPerson, Group, Patient, Practitioner, PractitionerRole, Location, Device, RelatedPerson) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. MeasureReport.date | |
Definition | The date this measure report was generated. |
Short | When the report was generated |
Control | 10..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. MeasureReport.reporter | |
Definition | The organization where the measure was completed. The individual, location, or organization that is reporting the data. |
Short | The organization where the measure was completedWho is reporting the data |
Control | 10..1 |
Type | Reference(QICore Organization, Practitioner, PractitionerRole, Location, Organization) |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. MeasureReport.reporter.extension:group | |
Slice Name | group |
Definition | Group of practitioners responsible for a report. This extension is used to provide the capability to allow the participating practitioners to be documented. |
Short | Group of practitioners responsible for a report |
Control | 0..1 |
Type | Extension(DEQM Reporter Group Extension) (Extension Type: Reference(Group)) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
34. MeasureReport.period | |
Definition | The reporting period for which the report was calculated. |
Short | What period the report covers |
Control | 1..1 This element is affected by the following invariants: deqm-1 |
Type | Period |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) deqm-1: Date precision SHALL be at least to day ( YYYY-MM-DD ) ( start.toString().length()>9 and end.toString().length()>9 ) |
36. MeasureReport.period.start | |
Definition | The start of the period. The boundary is inclusive. |
Short | Starting time with inclusive boundary |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Control | 10..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. MeasureReport.period.end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Short | End time with inclusive boundary, if not ongoing |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Control | 10..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. MeasureReport.improvementNotation | |
Definition | Whether improvement in the measure is noted by an increase or decrease in the measure score. |
Short | increase | decrease |
Comments | This element is typically defined by the measure, but reproduced here to ensure the measure score can be interpreted. The element is labeled as a modifier because it changes the interpretation of the reported measure score. |
Control | 0..1 |
Binding | The codes SHALL be taken from MeasureImprovementNotationhttp://hl7.org/fhir/ValueSet/measure-improvement-notation|4.0.1 (required to http://hl7.org/fhir/ValueSet/measure-improvement-notation|4.0.1 )Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. |
Type | CodeableConcept |
Is Modifier | true because Improvement notation determines how to interpret the measure score (i.e. whether an increase is an improvement) |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. MeasureReport.group | |
Definition | The results of the calculation, one for each population group in the measure. |
Short | Measure results for each group |
Control | 0..* This element is affected by the following invariants: mrp-1 |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. MeasureReport.group.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
46. MeasureReport.group.population | |
Definition | The populations that make up the population group, one for each type of population appropriate for the measure. |
Short | The populations in the group |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
48. MeasureReport.group.population.extension:description | |
Slice Name | description |
Definition | A description of the group, population, stratifier, or supplemental data definition on which it appears. This is typically a restatement of the description of the corresponding element in the Measure being reported, but may also include additional information gathered by the reporting process. |
Short | Description of the population |
Control | 0..1 |
Type | Extension(Measure Report Population Description) (Extension Type: markdown) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
50. MeasureReport.group.population.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
52. MeasureReport.group.measureScore | |
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. |
Short | What score this group achieved |
Control | 0..01 |
Type | Quantity |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
54. MeasureReport.group.stratifier | |
Definition | When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure. |
Short | Stratification results |
Control | 0..0* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
57. MeasureReport.evaluatedResource | |
Definition | A reference to a Bundle containing the Resources that were used in the calculation of this measure. |
Short | What data was used to calculate the measure score |
Control | 0..* |
Type | Reference(Resource) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. MeasureReport | |||||
Definition | The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation. | ||||
Short | Results of a measure evaluation | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Must Support | false | ||||
Summary | false | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() )mrp-1: Measure Reports used for data collection SHALL NOT communicate group and score information ( (type != 'data-collection') or group.exists().not() )mrp-2: Stratifiers SHALL be either a single criteria or a set of criteria components ( group.stratifier.stratum.all(value.exists() xor component.exists()) ) | ||||
2. MeasureReport.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. MeasureReport.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. MeasureReport.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Short | A set of rules under which this content was created | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
8. MeasureReport.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
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). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
10. MeasureReport.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Short | Text summary of the resource, for human interpretation | ||||
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 information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. MeasureReport.contained | |||||
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. | ||||
Short | Contained, inline Resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. MeasureReport.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 1..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on MeasureReport.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
16. MeasureReport.extension:updatetype | |||||
Slice Name | updatetype | ||||
Definition | Optional Extension Element - found in all resources. | ||||
Short | Optional Extensions Element | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(DEQM Submit Data Update Type Extension) (Extension Type: code) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
18. MeasureReport.extension:software | |||||
Slice Name | software | ||||
Definition | Specifies the software systems used in the packaging and testing of knowledge artifacts. Specifically to support explicitly stating which versions of the various software components were used in the authoring, packaging, and testing. | ||||
Short | Extension | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(CRMI Software System) (Extension Type: Reference(CRMI Software System Device)) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
20. MeasureReport.extension:vendor | |||||
Slice Name | vendor | ||||
Definition | A reference to the vendor who queried the data, calculated results and/or generated the report. | ||||
Short | Vendor information | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(DEQM Reporting Vendor Extension) (Extension Type: Reference(QICore Organization)) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
22. MeasureReport.extension:location | |||||
Slice Name | location | ||||
Definition | Location from which reported data was gathered. This extension is used to provide the location(s) from which reported data was gathered in a MeasureReport, such as individual, summary and data exchange measure report. | ||||
Short | Location(s) from which reported data was gathered | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(DEQM Data Location Extension) (Extension Type: Reference(QICore Location)) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
24. MeasureReport.extension:message | |||||
Slice Name | message | ||||
Definition | An OperationOutcome resource with information, warning, or error messages that were generated as part of processing an operation. | ||||
Short | Messages encountered while creating the report | ||||
Control | 0..1 | ||||
Type | Extension(Messages) (Extension Type: Reference(OperationOutcome)) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
26. MeasureReport.extension:inputParameters | |||||
Slice Name | inputParameters | ||||
Definition | Specifies the input parameters to the operation (such as a test case description or a data requirements or evaluate operation). This extension can be used as part of the result of an operation to indicate what the parameters were, but it can also be used as part of the definition of a test case to specify what the input parameters are expected to be for the test case. | ||||
Short | What parameters | ||||
Control | 0..1 | ||||
Type | Extension(Input parameters) (Extension Type: Reference(Parameters)) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
28. MeasureReport.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
30. MeasureReport.identifier | |||||
Definition | A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance. | ||||
Short | Additional identifier for the MeasureReport | ||||
Comments | 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. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. MeasureReport.status | |||||
Definition | The MeasureReport status. No data will be available until the MeasureReport status is complete. | ||||
Short | complete | pending | error | ||||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from MeasureReportStatus (required to http://hl7.org/fhir/ValueSet/measure-report-status ) | ||||
Type | code | ||||
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
34. MeasureReport.type | |||||
Definition | The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure. | ||||
Short | individual | subject-list | summary | data-collection | ||||
Comments | Data-collection reports are used only to communicate data-of-interest for a measure. They do not necessarily include all the data for a particular subject or population, but they may. | ||||
Control | 1..1 This element is affected by the following invariants: mrp-1 | ||||
Binding | The codes SHALL be taken from MeasureReportType (required to http://hl7.org/fhir/ValueSet/measure-report-type|4.0.1 )The type of the measure report. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Fixed Value | data-collection | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
36. MeasureReport.measure | |||||
Definition | A reference to the Measure that was calculated to produce this report. | ||||
Short | What measure was calculated | ||||
Control | 1..1 | ||||
Type | canonical(Measure) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | This will indicate the measure being reported on. For example, the cannonical uri location for the MRP measure. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
38. MeasureReport.subject | |||||
Definition | Optional subject identifying the individual or individuals the report is for. | ||||
Short | What individual(s) the report is for | ||||
Control | 1..1 | ||||
Type | Reference(QICore Patient, QICore Practitioner, QICore PractitionerRole, QICore Location, QICore Device, QICore RelatedPerson, Group) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
40. MeasureReport.date | |||||
Definition | The date this measure report was generated. | ||||
Short | When the report was generated | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. MeasureReport.reporter | |||||
Definition | The organization where the measure was completed. | ||||
Short | The organization where the measure was completed | ||||
Control | 1..1 | ||||
Type | Reference(QICore Organization) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. MeasureReport.reporter.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
46. MeasureReport.reporter.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on MeasureReport.reporter.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
48. MeasureReport.reporter.extension:group | |||||
Slice Name | group | ||||
Definition | Group of practitioners responsible for a report. This extension is used to provide the capability to allow the participating practitioners to be documented. | ||||
Short | Group of practitioners responsible for a report | ||||
Control | 0..1 | ||||
Type | Extension(DEQM Reporter Group Extension) (Extension Type: Reference(Group)) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
50. MeasureReport.reporter.reference | |||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
Short | Literal reference, Relative, internal or absolute URL | ||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
52. MeasureReport.reporter.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Short | Type the reference refers to (e.g. "Patient") | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. MeasureReport.reporter.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Short | Logical reference, when literal reference is not known | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. MeasureReport.reporter.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Short | Text alternative for the resource | ||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. MeasureReport.period | |||||
Definition | The reporting period for which the report was calculated. | ||||
Short | What period the report covers | ||||
Control | 1..1 This element is affected by the following invariants: deqm-1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )deqm-1: Date precision SHALL be at least to day ( YYYY-MM-DD ) ( start.toString().length()>9 and end.toString().length()>9 ) | ||||
60. MeasureReport.period.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
62. MeasureReport.period.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on MeasureReport.period.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
64. MeasureReport.period.start | |||||
Definition | The start of the period. The boundary is inclusive. | ||||
Short | Starting time with inclusive boundary | ||||
Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
Control | 1..1 This element is affected by the following invariants: per-1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
66. MeasureReport.period.end | |||||
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||
Short | End time with inclusive boundary, if not ongoing | ||||
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||
Control | 1..1 This element is affected by the following invariants: per-1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
68. MeasureReport.improvementNotation | |||||
Definition | Whether improvement in the measure is noted by an increase or decrease in the measure score. | ||||
Short | increase | decrease | ||||
Comments | This element is typically defined by the measure, but reproduced here to ensure the measure score can be interpreted. The element is labeled as a modifier because it changes the interpretation of the reported measure score. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from MeasureImprovementNotation (required to http://hl7.org/fhir/ValueSet/measure-improvement-notation|4.0.1 )Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. | ||||
Type | CodeableConcept | ||||
Is Modifier | true because Improvement notation determines how to interpret the measure score (i.e. whether an increase is an improvement) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
70. MeasureReport.group | |||||
Definition | The results of the calculation, one for each population group in the measure. | ||||
Short | Measure results for each group | ||||
Control | 0..* This element is affected by the following invariants: mrp-1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
72. MeasureReport.group.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
74. MeasureReport.group.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
76. MeasureReport.group.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
78. MeasureReport.group.code | |||||
Definition | The meaning of the population group as defined in the measure definition. | ||||
Short | Meaning of the group | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
80. MeasureReport.group.population | |||||
Definition | The populations that make up the population group, one for each type of population appropriate for the measure. | ||||
Short | The populations in the group | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
82. MeasureReport.group.population.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
84. MeasureReport.group.population.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on MeasureReport.group.population.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
86. MeasureReport.group.population.extension:description | |||||
Slice Name | description | ||||
Definition | A description of the group, population, stratifier, or supplemental data definition on which it appears. This is typically a restatement of the description of the corresponding element in the Measure being reported, but may also include additional information gathered by the reporting process. | ||||
Short | Description of the population | ||||
Control | 0..1 | ||||
Type | Extension(Measure Report Population Description) (Extension Type: markdown) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
88. MeasureReport.group.population.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
90. MeasureReport.group.population.code | |||||
Definition | The type of the population. | ||||
Short | initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from MeasurePopulationType (extensible to http://hl7.org/fhir/ValueSet/measure-population )The type of population (e.g. initial, numerator, denominator, etc.). | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
92. MeasureReport.group.population.count | |||||
Definition | The number of members of the population. | ||||
Short | Size of the population | ||||
Control | 0..1 | ||||
Type | integer | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
94. MeasureReport.group.population.subjectResults | |||||
Definition | This element refers to a List of subject level MeasureReport resources, one for each subject in this population. | ||||
Short | For subject-list reports, the subject results in this population | ||||
Control | 0..1 | ||||
Type | Reference(List) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
96. MeasureReport.group.measureScore | |||||
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. | ||||
Short | What score this group achieved | ||||
Control | 0..0 | ||||
Type | Quantity | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
98. MeasureReport.group.stratifier | |||||
Definition | When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure. | ||||
Short | Stratification results | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
123. MeasureReport.evaluatedResource | |||||
Definition | A reference to a Bundle containing the Resources that were used in the calculation of this measure. | ||||
Short | What data was used to calculate the measure score | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |