FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work GroupMaturity Level: 3 Trial UseSecurity Category: Business 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.

Short Display Group of multiple entities
Cardinality 0..*
Type CanonicalResource
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.

Invariants
Defined on this element
cnl-2Rule Group.type SHALL be defined if Group.membership is either 'definitional' or 'enumerated'Group.type.exists() or (Group.membership = 'conceptual')
Group.url
Element Id Group.url
Definition

An absolute URI that is used to identify this Group when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Group is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Group is stored on different servers.

Short Display Canonical identifier for this Group, represented as an absolute URI (globally unique)
Cardinality 0..1
Type uri
Requirements

Allows the Group to be referenced by a single globally unique identifier.

Summary true
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ] $')
Group.identifier
Element Id Group.identifier
Definition

Business identifiers assigned to this 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 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.version
Element Id Group.version
Definition

The identifier that is used to identify this version of the Group when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Group author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence without additional knowledge.

Short Display Business version of the Group
Note This is a business versionId, not a resource version id (see discussion)
Cardinality 0..1
Type string
Summary true
Comments

There may be different Groups that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the Group with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

Group.versionAlgorithm[x]
Element Id Group.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short Display How to compare versions
Cardinality 0..1
Terminology Binding Version Algorithm (Extensible)
Type string|Coding
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

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.title
Element Id Group.title
Definition

A short, descriptive, user-friendly title for the Group.

Short Display Name for this Group (human friendly)
Cardinality 0..1
Type string
Summary true
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Group.status
Element Id Group.status
Definition

The current state of this Group.

Short Display draft | active | retired | unknown
Cardinality 0..1
Terminology Binding PublicationStatus (Required)
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired Group without due consideration)
Requirements

Enables tracking the life-cycle of the content and filtering of Groups that are appropriate for use versus not.

Summary true
Comments

A nominal state-transition diagram can be found in the Definition pattern documentation.

Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

See guidance around (not) making local changes to elements here.

Group.experimental
Element Id Group.experimental
Definition

A Boolean value to indicate that this Group is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.

Short Display For testing purposes, not real usage
Cardinality 0..1
Type boolean
Meaning if Missing If absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level Group.

Summary true
Comments

Allows filtering of Groups that are appropriate for use versus not.

Group.date
Element Id Group.date
Definition

The date (and optionally time) when the Group was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the Group changes.

Short Display Date last changed
Cardinality 0..1
Type dateTime
Alternate Names Revision Date
Summary true
Comments

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the Group. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

Group.publisher
Element Id Group.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the Group.

Short Display Name of the publisher/steward (organization or individual)
Cardinality 0..1
Type string
Requirements

Helps establish the "authority/credibility" of the Group. May also allow for contact.

Summary true
Comments

Usually an organization but may be an individual. The publisher (or steward) of the Group is the organization or individual primarily responsible for the maintenance and upkeep of the Group. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the Group. This item SHOULD be populated unless the information is available from context.

Group.contact
Element Id Group.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short Display Contact details for the publisher
Cardinality 0..*
Type ContactDetail
Summary true
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

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.useContext
Element Id Group.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Groups.

Short Display The context that the content is intended to support
Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.

Group.purpose
Element Id Group.purpose
Definition

Explanation of why this Group is needed and why it has been designed as it has.

Short Display Why this Group is defined
Cardinality 0..1
Type markdown
Summary false
Comments

This element does not describe the usage of the Group. Instead, it provides traceability of "why" the resource is either needed or "why" it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Group.

Group.copyright
Element Id Group.copyright
Definition

A copyright statement relating to the Group and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Group.

Short Display Use and/or publishing restrictions
Cardinality 0..1
Type markdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the Group and/or its content.

Alternate Names License; Restrictions
Summary false
Comments

The short copyright declaration (e.g. (c) '2015 xyz organization' should be sent in the copyrightLabel element.

Group.copyrightLabel
Element Id Group.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short Display Copyright holder and year(s)
Cardinality 0..1
Type string
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summary false
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

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 0..1
Terminology Binding 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, CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Specimen for the other types.), or a Group of the resources of the appropriate type.

Group.membership
Element Id Group.membership
Definition

Basis for membership in the Group:

  • 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group 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.
  • 'conceptual': The Group.characteristics specified are both necessary and sufficient to determine membership. The 'conceptual' Group is a 'definitional' Group in which the Group.type is not bound to FHIR types.
  • 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.
Short Display definitional | conceptual | enumerated
Cardinality 1..1
Terminology Binding Group Membership Basis (Required)
Type 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 element.

Summary true
Group.code
Element Id Group.code
Definition

A code that describes the use of the group. The use of the group usually dictates what kind of entities can be members of the group.

Short Display Use of the Group (and by implication, kind of members)
Cardinality 0..1
Terminology Binding Group Code (Extensible)
Type CodeableConcept
Summary true
Comments

The types of entities that can be members needs to align with Group.type

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.combinationMethod
Element Id Group.combinationMethod
Definition

Used to specify how two or more characteristics are combined.

Short Display all-of | any-of | at-least | at-most | except-subset
Cardinality 0..1
Terminology Binding Group Characteristic Combination (Required)
Type code
Is Modifier true (Reason: Changing the combinationMethod from all-of to any other value changes the interpretation of multiple characteristics.)
Summary true
Group.combinationThreshold
Element Id Group.combinationThreshold
Definition

Provides the value of "n" when "at-least" or "at-most" codes are used for combinationMethod.

Short Display Provides the value of "n" when "at-least" or "at-most" codes are used
Cardinality 0..1
Type positiveInt
Summary false
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 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 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|uri|Expression
[x] Note See Choice of Datatypes for further information about how to use [x]
Requirements

The value of the characteristic is what determines group membership.

Summary 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 true
Comments

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

Group.characteristic.description
Element Id Group.characteristic.description
Definition

A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.

Short Display Natural language description of the characteristic
Cardinality 0..1
Type markdown
Requirements

Need to be able to describe characteristics in natural language so that end users can understand the criteria.

Summary false
Group.characteristic.method
Element Id Group.characteristic.method
Definition

Method for how the characteristic value was determined.

Short Display Method for how the characteristic value was determined
Cardinality 0..*
Terminology Binding Definition Method (Example)
Type CodeableConcept
Summary false
Group.characteristic.determinedBy[x]
Element Id Group.characteristic.determinedBy[x]
Definition

Defines the characteristic (without using type and value) by either a Reference or an Expression.

Short Display Defines the characteristic
Cardinality 0..1
Type Reference(Device | DeviceDefinition | DeviceMetric)|Expression
[x] Note See Choice of Datatypes for further information about how to use [x]
Requirements

The value of the characteristic is what determines group membership.

Summary false
Group.characteristic.offset
Element Id Group.characteristic.offset
Definition

Defines the reference point for comparison when other than 0.

Short Display Reference point for comparison
Cardinality 0..1
Terminology Binding Characteristic Offset (Example)
Type CodeableConcept
Is Modifier true (Reason: If offset is present it must be included to interpret the characteristic value.)
Summary true
Group.characteristic.instances[x]
Element Id Group.characteristic.instances[x]
Definition

Number of occurrences meeting the characteristic.

Short Display Number of occurrences meeting the characteristic
Cardinality 0..1
Type Quantity|Range
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
Group.characteristic.duration[x]
Element Id Group.characteristic.duration[x]
Definition

Length of time in which the characteristic is met.

Short Display Length of time in which the characteristic is met
Cardinality 0..1
Type Duration|Range
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
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.characteristic.timing
Element Id Group.characteristic.timing
Definition

Timing in which the characteristic is determined.

Short Display Timing in which the characteristic is determined
Cardinality 0..*
Type RelativeTime
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(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen)
Summary false
Group.member.involvement
Element Id Group.member.involvement
Definition

A code that describes how a user is involved in the group. Some groups (e.g. exposure-group) typically don't have variance between members, or it is not tracked, while for other groups (e.g. family, household) this may be meaningful.

Short Display Code that describes how user is part of the group
Cardinality 0..*
Terminology Binding Group Involvement (Example)
Type CodeableConcept
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