Release 4B 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B R4 R3 R2

FHIR Infrastructure icon Work Group Maturity Level : 1 3   Trial Use Security Category : Business Compartments : Device , Patient , Practitioner

Detailed Descriptions for the elements in the Group resource.

Invariants Defined on this element grp-1 Rule Can only have members if group is "actual" member.empty() or (actual = true) Invariants Affect this element grp-1 Rule Can only have members if group is "actual" member.empty() or (actual = true) Invariants Affect this element grp-1 Rule Can only have members if group is "actual" member.empty() or (actual = true)
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.

Short Display Group of multiple entities
Cardinality 0..*
Type DomainResource
Summary false
Comments

If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.

Group.identifier
Element Id Group.identifier
Definition

A unique business identifier for Business identifiers assigned to this group. participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server.

Short Display Business Identifier for this Group
Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Requirements

Allows identification of the group to be referenced from external specifications. as it is known by various participating systems and in a way that remains consistent across servers.

Summary true
Comments

Note: This is a business identifier, not a resource identifier (see discussion ). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.

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.

Short Display Whether this group's record is in active use
Cardinality 0..1
Type boolean
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid)
Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element
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.

Short Display person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Cardinality 1..1
Terminology Binding GroupType Group Type ( 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, PractitionerRole, Device, Medication CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Substance Specimen for the other types.). types.), or a Group of the resources of the appropriate type.

Group.actual Group.membership
Element Id Group.actual Group.membership
Definition

If true, indicates Basis for membership in the Group:

  • 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the resource refers criteria are considered to a specific group be members of real individuals. If false, the group, whether referenced by the group defines a set or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.
  • 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of intended individuals. the Group.member.
Short Display definitional | enumerated
Cardinality 1..1
Terminology Binding Group Membership Basis ( Required )
Type boolean code
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. element.

Summary true
Group.code
Element Id Group.code
Definition

Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.

Short Display Kind of Group members
Cardinality 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.

Short Display Label for Group
Cardinality 0..1
Type string
Requirements

Used to identify the group in human communication.

Summary true
Group.description
Element Id Group.description
Definition

Explanation of what the group represents and how it is intended to be used.

Short Display Natural language description of the group
Cardinality 0..1
Type markdown
Summary false
Group.quantity
Element Id Group.quantity
Definition

A count of the number of resource instances that are part of the group.

Short Display Number of members
Cardinality 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.managingEntity
Element Id Group.managingEntity
Definition

Entity responsible for defining and maintaining Group characteristics and/or registered members.

Short Display Entity that is the custodian of the Group's definition
Cardinality 0..1
Type Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole )
Summary true
Comments

This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.

Group.characteristic
Element Id Group.characteristic
Definition

Identifies traits whose presence r absence is shared by members of the group.

Short Display Include / Exclude group members by Trait
Cardinality 0..*
Requirements

Needs to be a generic mechanism for identifying what individuals can be part of a group.

Summary false true
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.

Short Display Kind of characteristic
Cardinality 1..1
Terminology Binding GroupCharacteristicKind :
Type CodeableConcept
Requirements

Need a formal way of identifying the characteristic being described.

Summary false true
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.

Short Display Value held by characteristic
Cardinality 1..1
Terminology Binding GroupCharacteristicValue :
Type CodeableConcept | boolean | Quantity | Range | Reference
[x] Note See Choice of Data Types Datatypes for further information about how to use [x]
Requirements

The value of the characteristic is what determines group membership.

Summary false true
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.

Short Display Group includes or excludes
Cardinality 1..1
Type boolean
Requirements

Sometimes group membership is determined by characteristics not possessed.

Summary false true
Comments

This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.

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.

Short Display Period over which characteristic is tested
Cardinality 0..1
Type Period
Summary false
Group.member
Element Id Group.member
Definition

Identifies the resource instances that are members of the group.

Short Display Who or what is in group
Cardinality 0..*
Requirements

Often the only thing of interest about a group is "who's in it".

Summary false
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. If the entity is another group, then the type must be the same.

Short Display Reference to the group member
Cardinality 1..1
Type Reference ( Patient CareTeam | RelatedPerson Device | Practitioner Group | PractitionerRole HealthcareService | Device Location | Medication Organization | Substance Patient | Group Practitioner | PractitionerRole | RelatedPerson | Specimen )
Summary false
Group.member.period
Element Id Group.member.period
Definition

The period that the member was in the group, if known.

Short Display Period member belonged to the group
Cardinality 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.

Summary false
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.

Short Display If member is no longer in group
Cardinality 0..1
Type boolean
Meaning if Missing Members are considered active unless explicitly specified otherwise
Requirements

Sometimes you don't know when someone stopped being in a group, but not when.

Summary false