This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
(v3.3.0:
R4
Ballot
2).
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
FHIR
Infrastructure
Work
Group
|
Maturity Level : 1 | Trial Use | Compartments : Device , Patient , Practitioner |
Detailed Descriptions for the elements in the Group resource.
| Group | |
| Element Id | 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
:
member.empty()
or
(actual
=
true),
xpath:
f:actual/@value=true()
or
not(exists(f:member)))
|
| Group.identifier | |
| Element Id | Group.identifier |
| Definition |
A unique business identifier for this group. |
| Note | This is a business identifer, not a resource identifier (see discussion ) |
| Control | 0..* |
| Type | Identifier |
| Requirements |
Allows the group to be referenced from external specifications. |
| Summary | true |
| Group.active | |
| Element Id | Group.active |
| Definition |
Indicates whether the record for the group is available for use or is merely being retained for historical purposes. |
| Control | 0..1 |
| Type | boolean |
|
|
|
| Requirements |
Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists). |
| Summary | true |
| Group.type | |
| Element Id | Group.type |
| Definition |
Identifies the broad classification of the kind of resources the group includes. |
| Control | 1..1 |
| Terminology Binding | GroupType ( Required ) |
| Type | code |
| Requirements |
Identifies what type of resources the group is made up of. |
| Summary | true |
| Comments |
Group
members
SHALL
be
of
the
appropriate
resource
type
(Patient
for
person
or
animal;
or
Practitioner,
Device,
|
| Group.actual | |
| Element Id | 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
|
| Summary | true |
| Invariants |
Affect
this
element
grp-1 : Can only have members if group is
:
member.empty()
or
(actual
=
true),
xpath:
f:actual/@value=true()
or
not(exists(f:member)))
|
| Group.code | |
| Element Id | Group.code |
| Definition |
Provides
a
specific
type
of
resource
the
group
includes;
e.g.
|
| Control | 0..1 |
| Terminology Binding | GroupKind : |
| Type | CodeableConcept |
| Summary | true |
| Comments |
This would generally be omitted for Person resources. |
| Group.name | |
| Element Id | 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 | |
| Element Id | Group.quantity |
| Definition |
A count of the number of resource instances that are part of the group. |
| Control | 0..1 |
| Type | unsignedInt |
| Requirements |
Group size is a common defining characteristic. |
| Summary | true |
| Comments |
Note that the quantity may be less than the number of members if some of the members are not active. |
| Group.characteristic | |
| Element Id | 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. |
| Comments |
All the identified characteristics must be true for an entity to a member of the group. |
| Group.characteristic.code | |
| Element Id | Group.characteristic.code |
| Definition |
A code that identifies the kind of trait being asserted. |
| Control | 1..1 |
| Terminology Binding | GroupCharacteristicKind : |
| Type | CodeableConcept |
| Requirements |
Need a formal way of identifying the characteristic being described. |
| Group.characteristic.value[x] | |
| Element Id | 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 |
| Terminology Binding | GroupCharacteristicValue : |
| Type | CodeableConcept | boolean | Quantity | Range |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 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 | |
| Element Id | 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 (Reason: Not known why this is labelled a modifier) |
| Requirements |
Sometimes group membership is determined by characteristics not possessed. |
| Comments |
This
is
labeled
as
|
| Group.characteristic.period | |
| Element Id | Group.characteristic.period |
| Definition |
The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. |
| Control | 0..1 |
| Type | Period |
| Group.member | |
| Element Id | Group.member |
| Definition |
Identifies the resource instances that are members of the group. |
| Control | 0..* |
| Requirements |
Often
the
only
thing
of
interest
about
a
group
is
|
| Invariants |
Affect
this
element
grp-1 : Can only have members if group is
:
member.empty()
or
(actual
=
true),
xpath:
f:actual/@value=true()
or
not(exists(f:member)))
|
| Group.member.entity | |
| Element Id | Group.member.entity |
| Definition |
A reference to the entity that is a member of the group. Must be consistent with Group.type. |
| Control | 1..1 |
| Type | Reference ( Patient | Practitioner | PractitionerRole | Device | Medication | Substance ) |
| Group.member.period | |
| Element Id | Group.member.period |
| Definition |
The period that the member was in the group, if known. |
| Control | 0..1 |
| Type | Period |
| Meaning if Missing | The member is in the group at this time |
| Requirements |
Need to track who was in a group at a particular time. |
| Group.member.inactive | |
| Element Id | Group.member.inactive |
| Definition |
A flag to indicate that the member is no longer in the group, but previously may have been a member. |
| Control | 0..1 |
| Type | boolean |
|
|
|
| Requirements |
Sometimes you don't know when someone stopped being in a group, but not when. |