Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI GroupDefinition

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-groupdefinition Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: CRMIGroupDefinition

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

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
gdf-1: Group definition must have either an expression or characteristics, but not both
... library S0..1canonical(Library)A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... expression SC0..1ExpressionAn dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
... identifier S0..*IdentifierUnique id
... type S1..1codeperson | animal | practitioner | device | medication | substance
Fixed Value: person
... actual S1..1booleanDescriptive or actual
Fixed Value: false
... code S0..1CodeableConceptKind of Group members
... name S1..1stringLabel for Group
... characteristic SC0..*BackboneElementInclude / Exclude group members by Trait
... member 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
gdf-1errorGroupGroup definition must have either an expression or characteristics, but not both
: extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
gdf-1: Group definition must have either an expression or characteristics, but not both
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... library S0..1canonical(Library)A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... expression SC0..1ExpressionAn dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
... identifier SΣ0..*IdentifierUnique id
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣC1..1booleanDescriptive or actual
Fixed Value: false
... code SΣ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ1..1stringLabel for Group
... characteristic SC0..*BackboneElementInclude / Exclude group members by Trait
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

.... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Group.typerequiredFixed Value: person
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gdf-1errorGroupGroup definition must have either an expression or characteristics, but not both
: extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
gdf-1: Group definition must have either an expression or characteristics, but not both
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... library S0..1canonical(Library)A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... expression SC0..1ExpressionAn dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique id
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣC1..1booleanDescriptive or actual
Fixed Value: false
... code SΣ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ1..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... characteristic SC0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

.... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Group.typerequiredFixed Value: person
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Group

Summary

Mandatory: 1 element
Must-Support: 9 elements
Fixed Value: 2 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Maturity: 3

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
gdf-1: Group definition must have either an expression or characteristics, but not both
... library S0..1canonical(Library)A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... expression SC0..1ExpressionAn dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
... identifier S0..*IdentifierUnique id
... type S1..1codeperson | animal | practitioner | device | medication | substance
Fixed Value: person
... actual S1..1booleanDescriptive or actual
Fixed Value: false
... code S0..1CodeableConceptKind of Group members
... name S1..1stringLabel for Group
... characteristic SC0..*BackboneElementInclude / Exclude group members by Trait
... member 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
gdf-1errorGroupGroup 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
gdf-1: Group definition must have either an expression or characteristics, but not both
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... library S0..1canonical(Library)A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... expression SC0..1ExpressionAn dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
... identifier SΣ0..*IdentifierUnique id
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣC1..1booleanDescriptive or actual
Fixed Value: false
... code SΣ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ1..1stringLabel for Group
... characteristic SC0..*BackboneElementInclude / Exclude group members by Trait
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

.... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Group.typerequiredFixed Value: person
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gdf-1errorGroupGroup definition must have either an expression or characteristics, but not both
: extension('http://hl7.org/fhir/StructureDefinition/cqf-expression').exists() xor characteristic.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
gdf-1: Group definition must have either an expression or characteristics, but not both
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... library S0..1canonical(Library)A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... expression SC0..1ExpressionAn dynamic expression
URL: http://hl7.org/fhir/StructureDefinition/cqf-expression
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierUnique id
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣC1..1booleanDescriptive or actual
Fixed Value: false
... code SΣ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ1..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... characteristic SC0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

.... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Group.typerequiredFixed Value: person
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Group

Summary

Mandatory: 1 element
Must-Support: 9 elements
Fixed Value: 2 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron