Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-draft built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-groupdefinition | Version: 2.0.0-draft | |||
Active as of 2024-10-03 | Computable Name: CPGGroupDefinition |
Represents the definition of a group of subjects, suitable for use in various contexts, such as a cohort definition, a recommendation inclusion or exclusion criteria, the members of a study, or a population criteria
This is a domain definition profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Group
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | C | 0..* | Group | Group of multiple entities gdf-1: Group definition must have either an expression or characteristics, but not both |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
expression | SC | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
identifier | S | 0..* | Identifier | Unique id |
active | S | 0..1 | boolean | Whether this group's record is in active use |
type | S | 1..1 | code | person | animal | practitioner | device | medication | substance Fixed Value: person |
actual | S | 1..1 | boolean | Descriptive or actual Fixed Value: false |
code | S | 0..1 | CodeableConcept | Kind of Group members |
name | S | 1..1 | string | Label for Group |
characteristic | SC | 0..* | BackboneElement | Include / Exclude group members by Trait |
member | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
gdf-1 | error | Group | Group definition must have either an expression or characteristics, but not both : extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" gdf-1: Group definition must have either an expression or characteristics, but not both |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
expression | SC | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Unique id |
active | SΣ | 0..1 | boolean | Whether this group's record is in active use |
type | SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
actual | SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: false |
code | SΣ | 0..1 | CodeableConcept | Kind of Group members Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc. |
name | SΣ | 1..1 | string | Label for Group |
characteristic | SC | 0..* | BackboneElement | Include / Exclude group members by Trait |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | CodeableConcept | Kind of characteristic Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |
value[x] | 1..1 | Value held by characteristic Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||
valueCodeableConcept | CodeableConcept | |||
valueBoolean | boolean | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueReference | Reference(Any) | |||
exclude | 1..1 | boolean | Group includes or excludes | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard | |
Group.code | example | ||
Group.characteristic.code | example | ||
Group.characteristic.value[x] | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Group | 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 | error | Group | 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 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Group | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
gdf-1 | error | Group | Group definition must have either an expression or characteristics, but not both : extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists() | |
grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Group | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" gdf-1: Group definition must have either an expression or characteristics, but not both | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
expression | SC | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Unique id | ||||
active | SΣ | 0..1 | boolean | Whether this group's record is in active use | ||||
type | SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person | ||||
actual | SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: false | ||||
code | SΣ | 0..1 | CodeableConcept | Kind of Group members Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
name | SΣ | 1..1 | string | Label for Group | ||||
quantity | Σ | 0..1 | unsignedInt | Number of members | ||||
managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
characteristic | SC | 0..* | BackboneElement | Include / Exclude group members by Trait | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | Kind of characteristic Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
value[x] | 1..1 | Value held by characteristic Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
valueCodeableConcept | CodeableConcept | |||||||
valueBoolean | boolean | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueReference | Reference(Any) | |||||||
exclude | 1..1 | boolean | Group includes or excludes | |||||
period | 0..1 | Period | Period over which characteristic is tested | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard | ||||
Group.code | example | |||||
Group.characteristic.code | example | |||||
Group.characteristic.value[x] | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Group | 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 | error | Group | 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 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Group | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
gdf-1 | error | Group | Group definition must have either an expression or characteristics, but not both : extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists() | |
grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
This structure is derived from Group
Differential View
This structure is derived from Group
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | C | 0..* | Group | Group of multiple entities gdf-1: Group definition must have either an expression or characteristics, but not both |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
expression | SC | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
identifier | S | 0..* | Identifier | Unique id |
active | S | 0..1 | boolean | Whether this group's record is in active use |
type | S | 1..1 | code | person | animal | practitioner | device | medication | substance Fixed Value: person |
actual | S | 1..1 | boolean | Descriptive or actual Fixed Value: false |
code | S | 0..1 | CodeableConcept | Kind of Group members |
name | S | 1..1 | string | Label for Group |
characteristic | SC | 0..* | BackboneElement | Include / Exclude group members by Trait |
member | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
gdf-1 | error | Group | Group definition must have either an expression or characteristics, but not both : extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" gdf-1: Group definition must have either an expression or characteristics, but not both |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
expression | SC | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Unique id |
active | SΣ | 0..1 | boolean | Whether this group's record is in active use |
type | SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
actual | SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: false |
code | SΣ | 0..1 | CodeableConcept | Kind of Group members Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc. |
name | SΣ | 1..1 | string | Label for Group |
characteristic | SC | 0..* | BackboneElement | Include / Exclude group members by Trait |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | CodeableConcept | Kind of characteristic Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |
value[x] | 1..1 | Value held by characteristic Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||
valueCodeableConcept | CodeableConcept | |||
valueBoolean | boolean | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueReference | Reference(Any) | |||
exclude | 1..1 | boolean | Group includes or excludes | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard | |
Group.code | example | ||
Group.characteristic.code | example | ||
Group.characteristic.value[x] | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Group | 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 | error | Group | 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 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Group | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
gdf-1 | error | Group | Group definition must have either an expression or characteristics, but not both : extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists() | |
grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Group | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" gdf-1: Group definition must have either an expression or characteristics, but not both | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
expression | SC | 0..1 | Expression | An dynamic expression URL: http://hl7.org/fhir/StructureDefinition/cqf-expression | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Unique id | ||||
active | SΣ | 0..1 | boolean | Whether this group's record is in active use | ||||
type | SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person | ||||
actual | SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: false | ||||
code | SΣ | 0..1 | CodeableConcept | Kind of Group members Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
name | SΣ | 1..1 | string | Label for Group | ||||
quantity | Σ | 0..1 | unsignedInt | Number of members | ||||
managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
characteristic | SC | 0..* | BackboneElement | Include / Exclude group members by Trait | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | Kind of characteristic Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
value[x] | 1..1 | Value held by characteristic Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
valueCodeableConcept | CodeableConcept | |||||||
valueBoolean | boolean | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueReference | Reference(Any) | |||||||
exclude | 1..1 | boolean | Group includes or excludes | |||||
period | 0..1 | Period | Period over which characteristic is tested | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard | ||||
Group.code | example | |||||
Group.characteristic.code | example | |||||
Group.characteristic.value[x] | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Group | 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 | error | Group | 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 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Group | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
gdf-1 | error | Group | Group definition must have either an expression or characteristics, but not both : extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists() | |
grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |
This structure is derived from Group
Other representations of profile: CSV, Excel, Schematron