This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Detailed Descriptions for the elements in the Group resource.
Group | |
Definition | Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization. |
Control | 1..1 |
Invariants | Defined on this element grp-1: Can only have members if group is "actual" (xpath: f:actual/@value='true' or not(exists(f:member))) grp-4: Can't have more members associated with the group than the value specified for "quantity" (xpath: not(f:quantity) or not(f:member) or not(f:quantity>count(f:member))) |
To Do | We need determiner codes that indicate we're talking about a group even when we haven't specified a specific quantity. |
Group.identifier | |
Definition | A unique business identifier for this group. |
Control | 0..1 |
Type | Identifier |
Requirements | Allows the group to be referenced. |
Summary | true |
Group.type | |
Definition | Identifies the broad classification of the kind of resources the group includes. |
Control | 1..1 |
Binding | GroupType: Required: http://hl7.org/fhir/group-type (Types of resources that are part of group) |
Type | code |
Requirements | Identifies what type of resources the group is made up of. |
Summary | true |
Group.actual | |
Definition | If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals. |
Control | 1..1 |
Type | boolean |
Requirements | There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag. |
Summary | true |
Invariants | Affect this element grp-1: Can only have members if group is "actual" (xpath: f:actual/@value='true' or not(exists(f:member))) |
Group.code | |
Definition | Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc. |
Control | 0..1 |
Binding | GroupKind: Kind of particular resource. E.g. cow, syringe, lake, etc. |
Type | CodeableConcept |
Summary | true |
Comments | This would generally be omitted for Person resources. |
Group.name | |
Definition | A label assigned to the group for human identification and communication. |
Control | 0..1 |
Type | string |
Requirements | Used to identify the group in human communication. |
Summary | true |
Group.quantity | |
Definition | A count of the number of resource instances that are part of the group. |
Control | 0..1 |
Type | integer |
Requirements | Group size is a common defining characteristic. |
Summary | true |
Group.characteristic | |
Definition | Identifies the traits shared by members of the group. |
Control | 0..* |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Group.characteristic.code | |
Definition | A code that identifies the kind of trait being asserted. |
Control | 1..1 |
Binding | GroupCharacteristicKind: List of characteristics used to describe group members. E.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Requirements | Need a formal way of identifying the characteristic being described. |
Group.characteristic.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Control | 1..1 |
Binding | GroupCharacteristicValue: Value of descriptive member characteristic. E.g. red, male, pneumonia, caucasian, etc. |
Type | CodeableConcept|boolean|Quantity|Range |
Requirements | The value of the characteristic is what determines group membership. |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Group.characteristic.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Control | 1..1 |
Type | boolean |
Is Modifier | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Group.member | |
Definition | Identifies the resource instances that are members of the group. |
Control | 0..* |
Type | Reference(Patient | Practitioner | Device | Medication | Substance) |
Requirements | Often the only thing of interest about a group is "who's in it". |
Invariants | Defined on this element grp-3: Member resource types SHALL agree with group type (xpath: lower-case(f:type/@value)=parent::f:Group/f:type/@value or (f:type/@value='Patient' and parent::f:Group/f:type/@value=('animal','person'))) Affect this element grp-1: Can only have members if group is "actual" (xpath: f:actual/@value='true' or not(exists(f:member))) |