Quality Measure Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-cqm/ and changes regularly. See the Directory of published versions
Page standards status: Trial-use | Maturity Level: 4 |
Definitions for the cqm-populationBasis extension.
Guidance on how to interpret the contents of this table can be foundhere
0. Extension | |
Definition | The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. Optional Extension Element - found in all resources. |
Short | What type of populationOptional Extensions Element |
Comments | In Health Quality Measure Format, this was referred to as the Item Count metadata attribute. If the populationBasis is specified as a data requirement, the type SHALL be present, profile and codeFilter MAY be present, and no other elements are allowed. This usage allows population basis to be stated with more specificity, e.g. CT Scans, rather than just DiagnosticReport. |
Control | 0..* This element is affected by the following invariants: ele-1 |
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() )popBasis-1: If DataRequirement.type is present, it may only contain the elements 'profile' and 'codeFilter'. ( value.exists() and value.is(DataRequirement) implies ( value.as(DataRequirement).type.exists() and value.as(DataRequirement).limit.empty() and value.as(DataRequirement).sort.empty() and value.as(DataRequirement).dateFilter.empty() and value.as(DataRequirement).subject.empty() and value.as(DataRequirement).mustSupport.empty()) )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
2. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-populationBasis |
4. Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 0..1 |
Binding | The codes SHALL be taken from For codes, see FHIRAllTypes (required to http://hl7.org/fhir/ValueSet/all-types )The type of elements in the population |
Type | Choice of: code, DataRequirement, date, Meta, Address, Attachment, integer, Count, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
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())) |
Guidance on how to interpret the contents of this table can be foundhere
0. Extension | |
Definition | The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. |
Short | What type of population |
Comments | In Health Quality Measure Format, this was referred to as the Item Count metadata attribute. If the populationBasis is specified as a data requirement, the type SHALL be present, profile and codeFilter MAY be present, and no other elements are allowed. This usage allows population basis to be stated with more specificity, e.g. CT Scans, rather than just DiagnosticReport. |
Control | 0..* |
Invariants | popBasis-1: If DataRequirement.type is present, it may only contain the elements 'profile' and 'codeFilter'. (value.exists() and value.is(DataRequirement) implies ( value.as(DataRequirement).type.exists() and value.as(DataRequirement).limit.empty() and value.as(DataRequirement).sort.empty() and value.as(DataRequirement).dateFilter.empty() and value.as(DataRequirement).subject.empty() and value.as(DataRequirement).mustSupport.empty()) ) |
2. Extension.url | |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Fixed Value | http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-populationBasis |
4. Extension.value[x] | |
Binding | The codes SHALL be taken from FHIRAllTypes (required to http://hl7.org/fhir/ValueSet/all-types )The type of elements in the population |
Type | Choice of: code, DataRequirement, date, Meta, Address, Attachment, integer, Count, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
0. Extension | |
Definition | The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. |
Short | What type of population |
Comments | In Health Quality Measure Format, this was referred to as the Item Count metadata attribute. If the populationBasis is specified as a data requirement, the type SHALL be present, profile and codeFilter MAY be present, and no other elements are allowed. This usage allows population basis to be stated with more specificity, e.g. CT Scans, rather than just DiagnosticReport. |
Control | 0..* This element is affected by the following invariants: ele-1 |
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() )popBasis-1: If DataRequirement.type is present, it may only contain the elements 'profile' and 'codeFilter'. ( value.exists() and value.is(DataRequirement) implies ( value.as(DataRequirement).type.exists() and value.as(DataRequirement).limit.empty() and value.as(DataRequirement).sort.empty() and value.as(DataRequirement).dateFilter.empty() and value.as(DataRequirement).subject.empty() and value.as(DataRequirement).mustSupport.empty()) ) |
2. Extension.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 |
4. Extension.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 Extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org/fhir/uv/cqm/StructureDefinition/cqm-populationBasis |
8. Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 0..1 |
Binding | The codes SHALL be taken from FHIRAllTypes (required to http://hl7.org/fhir/ValueSet/all-types )The type of elements in the population |
Type | Choice of: code, DataRequirement |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
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()) ) |