Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1

Publication Build: This will be filled in by the publication tooling

## Resource Profile: CRMI GroupDefinition

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

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:

- Examples for this Resource Profile: ANCInclusionCriteria

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

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
library | S | 0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library
expression | S | 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
managingEntity |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
profile | S | 0..1 | canonical() | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
characteristic | S | 0..* | BackboneElement | Include / Exclude group members by Trait
member |  |  |  |
entity |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
profile | S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
extension |  | 0..0 |  |
value[x] | C | 1..1 | canonical() | Value of extension gdf-2: Reference must be to a structure definition
Documentation for this format

#### Constraints

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() |
gdf-2 | error | Group.member.entity.extension:profile.value[x] | Reference must be to a structure definition : resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition') |

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
library | S | 0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library
expression | S | 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: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
name | S Σ | 1..1 | string | Label for Group
managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition
Slices for extension |  |  |  | Content/Rules for all slices
profile | S | 0..1 | canonical() | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
characteristic | S | 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: (unbound) (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: (unbound) (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
member | C | 0..* | BackboneElement | Who or what is in group
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
entity |  | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member
Slices for extension |  |  |  | Content/Rules for all slices
profile | S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference"
value[x] | C | 1..1 | canonical() | Value of extension gdf-2: Reference must be to a structure definition
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Group.type | required | Fixed Value: person `http://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 |

#### Constraints

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() |
gdf-2 | error | Group.member.entity.extension:profile.value[x] | Reference must be to a structure definition : resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition') |
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
library | S | 0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library
expression | S | 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: (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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
profile | S | 0..1 | canonical() | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
characteristic | S | 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: (unbound) (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: (unbound) (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
member | C | 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 |  | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
profile | S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference"
value[x] | C | 1..1 | canonical() | Value of extension gdf-2: Reference must be to a structure definition
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
period |  | 0..1 | Period | Period member belonged to the group
inactive |  | 0..1 | boolean | If member is no longer in group
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Group.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Group.type | required | Fixed Value: person `http://hl7.org/fhir/ValueSet/group-type|4.0.1` from the FHIR Standard
Group.code | example |
Group.managingEntity.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Group.characteristic.code | example |
Group.characteristic.value[x] | example |
Group.member.entity.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard

#### Constraints

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() |
gdf-2 | error | Group.member.entity.extension:profile.value[x] | Reference must be to a structure definition : resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition') |
grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |

This structure is derived from Group

Summary

Mandatory: 1 element
Must-Support: 11 elements
Fixed: 2 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/cqf-library
- http://hl7.org/fhir/StructureDefinition/cqf-expression
- http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference

Maturity: 3

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
library | S | 0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library
expression | S | 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
managingEntity |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
profile | S | 0..1 | canonical() | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
characteristic | S | 0..* | BackboneElement | Include / Exclude group members by Trait
member |  |  |  |
entity |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
profile | S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
extension |  | 0..0 |  |
value[x] | C | 1..1 | canonical() | Value of extension gdf-2: Reference must be to a structure definition
Documentation for this format

#### Constraints

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() |
gdf-2 | error | Group.member.entity.extension:profile.value[x] | Reference must be to a structure definition : resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition') |

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
library | S | 0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library
expression | S | 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: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
name | S Σ | 1..1 | string | Label for Group
managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition
Slices for extension |  |  |  | Content/Rules for all slices
profile | S | 0..1 | canonical() | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
characteristic | S | 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: (unbound) (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: (unbound) (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
member | C | 0..* | BackboneElement | Who or what is in group
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
entity |  | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member
Slices for extension |  |  |  | Content/Rules for all slices
profile | S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference"
value[x] | C | 1..1 | canonical() | Value of extension gdf-2: Reference must be to a structure definition
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Group.type | required | Fixed Value: person `http://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 |

#### Constraints

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() |
gdf-2 | error | Group.member.entity.extension:profile.value[x] | Reference must be to a structure definition : resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition') |
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
library | S | 0..1 | canonical(Library) | A library containing logic used by the artifact URL: http://hl7.org/fhir/StructureDefinition/cqf-library
expression | S | 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: (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
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
profile | S | 0..1 | canonical() | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
characteristic | S | 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: (unbound) (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: (unbound) (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
member | C | 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 |  | 1..1 | Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) | Reference to the group member
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
profile | S | 0..1 | (Complex) | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference"
value[x] | C | 1..1 | canonical() | Value of extension gdf-2: Reference must be to a structure definition
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
period |  | 0..1 | Period | Period member belonged to the group
inactive |  | 0..1 | boolean | If member is no longer in group
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Group.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Group.type | required | Fixed Value: person `http://hl7.org/fhir/ValueSet/group-type|4.0.1` from the FHIR Standard
Group.code | example |
Group.managingEntity.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Group.characteristic.code | example |
Group.characteristic.value[x] | example |
Group.member.entity.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard

#### Constraints

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() |
gdf-2 | error | Group.member.entity.extension:profile.value[x] | Reference must be to a structure definition : resolve().conformsTo('http://hl7.org/fhir/StructureDefinition/StructureDefinition') |
grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) |

This structure is derived from Group

Summary

Mandatory: 1 element
Must-Support: 11 elements
Fixed: 2 elements
Prohibited: 1 element

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/cqf-library
- http://hl7.org/fhir/StructureDefinition/cqf-expression
- http://hl7.org/fhir/StructureDefinition/artifact-canonicalReference

Maturity: 3

Other representations of profile: CSV, Excel, Schematron