STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 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

8.14 Resource Group - Content

FHIR Infrastructure Work Group Maturity Level : 1 Compartments : Device , Patient , Practitioner

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.

8.14.1 Scope and Usage

8.14.1.1 Use Cases

The group resource is used in one of two ways:

  1. To define a group of specific people, animals, devices, etc. that is being tracked, examined or otherwise referenced as part of healthcare-related activities
  2. To define a set of *possible* people, animals, devices, etc. that are of interest for some intended future healthcare-related activities

Examples of the former could include group therapy or treatment sessions, exposed entities tracked as part of public health, etc. The latter might be used to define expected subjects for a clinical study.

Both use cases are handled by a single resource because the data elements captured tend to be similar.

8.14.2 Boundaries and Relationships

There are five mechanisms in FHIR for communicating collections of resources:

  • The List resource - enumerates a flat collection of resources and provides features for managing the collection. While a particular List instance may represent a "snapshot", from a business process perspective the notion of "List" is dynamic – items are added and removed over time. The list resource references other resources. Lists may be curated and have specific business meaning.
  • This Group resource - defines a group of specific people, animals, devices, etc. by enumerating them, or by describing qualities that group members have. The group resource refers to other resources, possibly implicitly. Groups are intended to be acted upon or observed as a whole; e.g. performing therapy on a group, calculating risk for a group, etc. This resource will commonly be used for public health (e.g. describing an at-risk population), clinical trials (e.g. defining a test subject pool) and similar purposes.
  • The Bundle resource - is an infrastructure container for a group of resources. It does not have narrative and is used to group collections of resources for transmission, persistence or processing (e.g. messages, documents, transactions, query responses, etc.) The content of bundles is typically algorithmically determined for a particular exchange or persistence purpose.
  • The Composition resource - defines a set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. The composition resource provides the basic structure of a FHIR document . The full content of the document is expressed using a bundle. Compositions will often reference Lists as the focus of particular sections.
  • The DomainResource . contained element - allows multiple resources to be nested inside any DomainResource. This is a special type of grouping where the grouped resources lose independent existence - they no longer have their own identifiers, can't easily be queried independently, etc. Use of this grouping is a technical mechanism for managing the independence of resources and has no impact on meaning. Contained, bundles and remotely referenced resources convey the same meaning.

This resource is referenced by CarePlan , CareTeam , ClinicalImpression , Communication , CommunicationRequest , Condition , Consent , Contract , DeviceUseRequest , DiagnosticReport , DiagnosticRequest , DocumentManifest , DocumentReference , Flag , Goal , GuidanceResponse , List , Media , MedicationStatement , Observation , Procedure , ProcedureRequest , RequestGroup , ResearchStudy , RiskAssessment , Specimen and Task

8.14.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . Group I DomainResource Group of multiple entities
Can only have members if group is "actual"
. . . identifier Σ 0..* Identifier Unique id
. . . type Σ 1..1 code person | animal | practitioner | device | medication | substance
GroupType ( Required )
. . . actual Σ I 1..1 boolean Descriptive or actual
. . . active Σ 0..1 boolean Whether this group's record is in active use
. . . code Σ 0..1 CodeableConcept Kind of Group members
. . . name Σ 0..1 string Label for Group
. . . quantity Σ 0..1 unsignedInt Number of members
. . . characteristic 0..* BackboneElement Trait of group members
. . . . code 1..1 CodeableConcept Kind of characteristic
. . . . value[x] 1..1 Value held by characteristic
. . . . . valueCodeableConcept CodeableConcept
. . . . . valueBoolean boolean
. . . . . valueQuantity Quantity
. . . . . valueRange Range
. . . . exclude ?! 1..1 boolean Group includes or excludes
. . . . period 0..1 Period Period over which characteristic is tested
. . . member I 0..* BackboneElement Who or what is in group
. . . . entity 1..1 Reference ( Patient | Practitioner | Device | Medication | Substance ) Reference to the group member
. . . . period 0..1 Period Period member belonged to the group
. . . . inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

UML Diagram ( Legend )

Group ( DomainResource ) A unique business identifier for this group identifier : Identifier [0..*] Identifies the broad classification of the kind of resources the group includes type : code [1..1] « Types of resources that are part of group (Strength=Required) GroupType ! » If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals actual : boolean [1..1] Indicates whether the record for the group is available for use or is merely being retained for historical purposes active : boolean [0..1] Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc code : CodeableConcept [0..1] A label assigned to the group for human identification and communication name : string [0..1] A count of the number of resource instances that are part of the group quantity : unsignedInt [0..1] Characteristic A code that identifies the kind of trait being asserted code : CodeableConcept [1..1] The value of the trait that holds (or does not hold - see 'exclude') for members of the group value[x] : Type [1..1] « CodeableConcept | boolean | Quantity | Range » If true, indicates the characteristic is one that is NOT held by members of the group (this element modifies the meaning of other elements) exclude : boolean [1..1] The period over which the characteristic is tested; e.g. the patient had an operation during the month of June period : Period [0..1] Member A reference to the entity that is a member of the group. Must be consistent with Group.type entity : Reference [1..1] « Patient | Practitioner | Device | Medication | Substance » The period that the member was in the group, if known period : Period [0..1] A flag to indicate that the member is no longer in the group, but previously may have been a member inactive : boolean [0..1] Identifies the traits shared by members of the group characteristic [0..*] Identifies the resource instances that are members of the group member [0..*]

XML Template 

<Group xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique id --></identifier>
 <type value="[code]"/><!-- 1..1 person | animal | practitioner | device | medication | substance -->
 <actual value="[boolean]"/><!-- ?? 1..1 Descriptive or actual -->
 <active value="[boolean]"/><!-- 0..1 Whether this group's record is in active use -->
 <code><!-- 0..1 CodeableConcept Kind of Group members --></code>
 <name value="[string]"/><!-- 0..1 Label for Group -->
 <quantity value="[unsignedInt]"/><!-- 0..1 Number of members -->
 <characteristic>  <!-- 0..* Trait of group members -->
  <code><!-- 1..1 CodeableConcept Kind of characteristic --></code>
  <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range Value held by characteristic --></value[x]>
  <exclude value="[boolean]"/><!-- 1..1 Group includes or excludes -->
  <period><!-- 0..1 Period Period over which characteristic is tested --></period>
 </characteristic>
 <member>  <!-- ?? 0..* Who or what is in group -->
  <entity><!-- 1..1 Reference(Patient|Practitioner|Device|Medication|Substance) Reference to the group member --></entity>
  <period><!-- 0..1 Period Period member belonged to the group --></period>
  <inactive value="[boolean]"/><!-- 0..1 If member is no longer in group -->
 </member>
</Group>

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Group;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Group.identifier [ Identifier ], ... ; # 0..* Unique id
  fhir:Group.type [ code ]; # 1..1 person | animal | practitioner | device | medication | substance
  fhir:Group.actual [ boolean ]; # 1..1 Descriptive or actual
  fhir:Group.active [ boolean ]; # 0..1 Whether this group's record is in active use
  fhir:Group.code [ CodeableConcept ]; # 0..1 Kind of Group members
  fhir:Group.name [ string ]; # 0..1 Label for Group
  fhir:Group.quantity [ unsignedInt ]; # 0..1 Number of members
  fhir:Group.characteristic [ # 0..* Trait of group members
    fhir:Group.characteristic.code [ CodeableConcept ]; # 1..1 Kind of characteristic
    # Group.characteristic.value[x] : 1..1 Value held by characteristic. One of these 4
      fhir:Group.characteristic.valueCodeableConcept [ CodeableConcept ]
      fhir:Group.characteristic.valueBoolean [ boolean ]
      fhir:Group.characteristic.valueQuantity [ Quantity ]
      fhir:Group.characteristic.valueRange [ Range ]
    fhir:Group.characteristic.exclude [ boolean ]; # 1..1 Group includes or excludes
    fhir:Group.characteristic.period [ Period ]; # 0..1 Period over which characteristic is tested
  ], ...;
  fhir:Group.member [ # 0..* Who or what is in group
    fhir:Group.member.entity [ Reference(Patient|Practitioner|Device|Medication|Substance) ]; # 1..1 Reference to the group member
    fhir:Group.member.period [ Period ]; # 0..1 Period member belonged to the group
    fhir:Group.member.inactive [ boolean ]; # 0..1 If member is no longer in group
  ], ...;
]

Changes since DSTU2

Group
Group.active added Element

See the Full Difference for further information

Structure

Name Flags Card. Type Description & Constraints doco
. . Group I DomainResource Group of multiple entities
Can only have members if group is "actual"
. . . identifier Σ 0..* Identifier Unique id
. . . type Σ 1..1 code person | animal | practitioner | device | medication | substance
GroupType ( Required )
. . . actual Σ I 1..1 boolean Descriptive or actual
. . . active Σ 0..1 boolean Whether this group's record is in active use
. . . code Σ 0..1 CodeableConcept Kind of Group members
. . . name Σ 0..1 string Label for Group
. . . quantity Σ 0..1 unsignedInt Number of members
. . . characteristic 0..* BackboneElement Trait of group members
. . . . code 1..1 CodeableConcept Kind of characteristic
. . . . value[x] 1..1 Value held by characteristic
. . . . . valueCodeableConcept CodeableConcept
. . . . . valueBoolean boolean
. . . . . valueQuantity Quantity
. . . . . valueRange Range
. . . . exclude ?! 1..1 boolean Group includes or excludes
. . . . period 0..1 Period Period over which characteristic is tested
. . . member I 0..* BackboneElement Who or what is in group
. . . . entity 1..1 Reference ( Patient | Practitioner | Device | Medication | Substance ) Reference to the group member
. . . . period 0..1 Period Period member belonged to the group
. . . . inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

UML Diagram ( Legend )

Group ( DomainResource ) A unique business identifier for this group identifier : Identifier [0..*] Identifies the broad classification of the kind of resources the group includes type : code [1..1] « Types of resources that are part of group (Strength=Required) GroupType ! » If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals actual : boolean [1..1] Indicates whether the record for the group is available for use or is merely being retained for historical purposes active : boolean [0..1] Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc code : CodeableConcept [0..1] A label assigned to the group for human identification and communication name : string [0..1] A count of the number of resource instances that are part of the group quantity : unsignedInt [0..1] Characteristic A code that identifies the kind of trait being asserted code : CodeableConcept [1..1] The value of the trait that holds (or does not hold - see 'exclude') for members of the group value[x] : Type [1..1] « CodeableConcept | boolean | Quantity | Range » If true, indicates the characteristic is one that is NOT held by members of the group (this element modifies the meaning of other elements) exclude : boolean [1..1] The period over which the characteristic is tested; e.g. the patient had an operation during the month of June period : Period [0..1] Member A reference to the entity that is a member of the group. Must be consistent with Group.type entity : Reference [1..1] « Patient | Practitioner | Device | Medication | Substance » The period that the member was in the group, if known period : Period [0..1] A flag to indicate that the member is no longer in the group, but previously may have been a member inactive : boolean [0..1] Identifies the traits shared by members of the group characteristic [0..*] Identifies the resource instances that are members of the group member [0..*]

XML Template 

<Group xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Unique id --></identifier>
 <type value="[code]"/><!-- 1..1 person | animal | practitioner | device | medication | substance -->
 <actual value="[boolean]"/><!-- ?? 1..1 Descriptive or actual -->
 <active value="[boolean]"/><!-- 0..1 Whether this group's record is in active use -->
 <code><!-- 0..1 CodeableConcept Kind of Group members --></code>
 <name value="[string]"/><!-- 0..1 Label for Group -->
 <quantity value="[unsignedInt]"/><!-- 0..1 Number of members -->
 <characteristic>  <!-- 0..* Trait of group members -->
  <code><!-- 1..1 CodeableConcept Kind of characteristic --></code>
  <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range Value held by characteristic --></value[x]>
  <exclude value="[boolean]"/><!-- 1..1 Group includes or excludes -->
  <period><!-- 0..1 Period Period over which characteristic is tested --></period>
 </characteristic>
 <member>  <!-- ?? 0..* Who or what is in group -->
  <entity><!-- 1..1 Reference(Patient|Practitioner|Device|Medication|Substance) Reference to the group member --></entity>
  <period><!-- 0..1 Period Period member belonged to the group --></period>
  <inactive value="[boolean]"/><!-- 0..1 If member is no longer in group -->
 </member>
</Group>

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Group;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Group.identifier [ Identifier ], ... ; # 0..* Unique id
  fhir:Group.type [ code ]; # 1..1 person | animal | practitioner | device | medication | substance
  fhir:Group.actual [ boolean ]; # 1..1 Descriptive or actual
  fhir:Group.active [ boolean ]; # 0..1 Whether this group's record is in active use
  fhir:Group.code [ CodeableConcept ]; # 0..1 Kind of Group members
  fhir:Group.name [ string ]; # 0..1 Label for Group
  fhir:Group.quantity [ unsignedInt ]; # 0..1 Number of members
  fhir:Group.characteristic [ # 0..* Trait of group members
    fhir:Group.characteristic.code [ CodeableConcept ]; # 1..1 Kind of characteristic
    # Group.characteristic.value[x] : 1..1 Value held by characteristic. One of these 4
      fhir:Group.characteristic.valueCodeableConcept [ CodeableConcept ]
      fhir:Group.characteristic.valueBoolean [ boolean ]
      fhir:Group.characteristic.valueQuantity [ Quantity ]
      fhir:Group.characteristic.valueRange [ Range ]
    fhir:Group.characteristic.exclude [ boolean ]; # 1..1 Group includes or excludes
    fhir:Group.characteristic.period [ Period ]; # 0..1 Period over which characteristic is tested
  ], ...;
  fhir:Group.member [ # 0..* Who or what is in group
    fhir:Group.member.entity [ Reference(Patient|Practitioner|Device|Medication|Substance) ]; # 1..1 Reference to the group member
    fhir:Group.member.period [ Period ]; # 0..1 Period member belonged to the group
    fhir:Group.member.inactive [ boolean ]; # 0..1 If member is no longer in group
  ], ...;
]

Changes since DSTU2

Group
Group.active added Element

See the Full Difference for further information

 

Alternate definitions: Master Definition ( XML , JSON ), XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ), JSON-LD (for RDF as JSON-LD ),

8.14.3.1 Terminology Bindings

Path Definition Type Reference
Group.type Types of resources that are part of group Required GroupType
Group.code Kind of particular resource; e.g. cow, syringe, lake, etc. Unknown No details provided yet
Group.characteristic.code List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. Unknown No details provided yet
Group.characteristic.value[x] Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. Unknown No details provided yet

8.14.3.2 Constraints

  • grp-1 : Can only have members if group is "actual" ( expression : member.empty() or (actual = true) )

8.14.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Paths In Common
actual token Descriptive or actual Group.actual
characteristic token Kind of characteristic Group.characteristic.code
characteristic-value composite A composite of both characteristic and value
code token The kind of resources contained Group.code
exclude token Group includes or excludes Group.characteristic.exclude
identifier token Unique id Group.identifier
member reference Reference to the group member Group.member.entity
( Practitioner , Device , Medication , Patient , Substance )
type token The type of resources the group contains Group.type
value token Value held by characteristic Group.characteristic.value[x]