Clinical Practice Guidelines
2.0.0-ballot - ballot
Clinical Practice Guidelines
2.0.0-ballot - ballot
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-ballot 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-group | Version: 2.0.0-ballot | |||
| Active as of 2024-04-14 | Computable Name: CPGGroup | |||
Defines an actual group of subjects, suitable for use in various contexts, such as a enrollment in a pathway or participant in a study
This is a domain case/instance profile
Examples:
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 |
0..* | Group | Group of multiple entities | |
  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: true |
| code |
S | 0..1 | CodeableConcept | Kind of Group members |
| name |
S | 1..1 | string | Label for Group |
| characteristic |
0..0 | |||
 member |
S | 0..* | BackboneElement | Who or what is in group |
  entity |
S | 1..1 | Reference(CPG Patient) | Reference to the group member |
| period |
S | 0..1 | Period | Period member belonged to the group |
 inactive |
S | 0..1 | boolean | If member is no longer in group |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group |
C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 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: true |
| code |
SΣ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. |
| name |
SΣ | 1..1 | string | Label for Group |
| member |
SC | 0..* | BackboneElement | Who or what is in group |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity |
S | 1..1 | Reference(CPG Patient) | Reference to the group member |
| period |
S | 0..1 | Period | Period member belonged to the group |
| inactive |
S | 0..1 | boolean | If member is no longer in group |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1from 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() | |
| 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" | ||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| 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: true | ||||
| code |
SΣ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (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 | ||||
| member |
SC | 0..* | BackboneElement | Who or what is in group | ||||
| 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 | ||||
| entity |
S | 1..1 | Reference(CPG Patient) | Reference to the group member | ||||
| period |
S | 0..1 | Period | Period member belonged to the group | ||||
| inactive |
S | 0..1 | boolean | If member is no longer in group | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1from 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() | |
| 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 |
0..* | Group | Group of multiple entities | |
| 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: true |
| code |
S | 0..1 | CodeableConcept | Kind of Group members |
| name |
S | 1..1 | string | Label for Group |
| characteristic |
0..0 | |||
| member |
S | 0..* | BackboneElement | Who or what is in group |
| entity |
S | 1..1 | Reference(CPG Patient) | Reference to the group member |
| period |
S | 0..1 | Period | Period member belonged to the group |
| inactive |
S | 0..1 | boolean | If member is no longer in group |
| Documentation for this format | ||||
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" |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| 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: true |
| code |
SΣ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. |
| name |
SΣ | 1..1 | string | Label for Group |
| member |
SC | 0..* | BackboneElement | Who or what is in group |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity |
S | 1..1 | Reference(CPG Patient) | Reference to the group member |
| period |
S | 0..1 | Period | Period member belonged to the group |
| inactive |
S | 0..1 | boolean | If member is no longer in group |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1from 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() | |
| 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" | ||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| 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: true | ||||
| code |
SΣ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (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 | ||||
| member |
SC | 0..* | BackboneElement | Who or what is in group | ||||
| 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 | ||||
| entity |
S | 1..1 | Reference(CPG Patient) | Reference to the group member | ||||
| period |
S | 0..1 | Period | Period member belonged to the group | ||||
| inactive |
S | 0..1 | boolean | If member is no longer in group | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1from 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() | |
| 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
IG © 2023+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.cpg#2.0.0-ballot based on FHIR 4.0.1. Generated 2024-04-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change