Snapshot 3: Connectathon 32 Base
AdministrationThis page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). 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: 0 | Trial Use | Security Category: Business | 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.
The Group resource is used in one of two ways:
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.
There are a number of mechanisms in FHIR for communicating collections of resources:
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.
Structure
| Name | Flags | Card. | Type | Description & Constraints  |
|---|---|---|---|---|
  Group | TU | DomainResource | Group of multiple entities Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
  identifier | Σ | 0..* | Identifier | Unique id |
 active | ?!Σ | 0..1 | boolean | Whether this group's record is in active use |
| type | Σ | 1..1 | code | person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen GroupType (Required) |
| membership | Σ | 1..1 | code | definitional | enumerated GroupMembershipBasis (Required) |
| code | Σ | 0..1 | CodeableConcept | Kind of Group members GroupKind (Example) |
| name | Σ | 0..1 | string | Label for Group |
| description | 0..1 | markdown | Natural language description of the group | |
| quantity | Σ | 0..1 | unsignedInt | Number of members |
 managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition |
  characteristic | Σ | 0..* | BackboneElement | Include / Exclude group members by Trait |
 code | Σ | 1..1 | CodeableConcept | Kind of characteristic GroupCharacteristicKind (Example) |
 value[x] | Σ | 1..1 | Value held by characteristic GroupCharacteristicValue (Example) | |
| valueCodeableConcept | CodeableConcept | |||
| valueBoolean | boolean | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
 valueReference | Reference() | |||
| exclude | Σ | 1..1 | boolean | Group includes or excludes |
| period | 0..1 | Period | Period over which characteristic is tested | |
 member | 0..* | BackboneElement | Who or what is in group | |
 entity | 1..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) | 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 | |
| Documentation for this format | ||||
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<Group xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Unique id --></identifier> <active value="[boolean]"/><!-- 0..1 Whether this group's record is in active use --> <type value="[code]"/><!-- 1..1 person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen --> <membership value="[code]"/><!-- 1..1 definitional | enumerated --> <code><!-- 0..1 CodeableConcept Kind of Group members --></code> <name value="[string]"/><!-- 0..1 Label for Group --> <description value="[markdown]"/><!-- 0..1 Natural language description of the group --> <quantity value="[unsignedInt]"/><!-- 0..1 Number of members --> <managingEntity><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole| RelatedPerson) Entity that is the custodian of the Group's definition --></managingEntity> <characteristic> <!-- 0..* Include / Exclude group members by Trait --> <code><!-- 1..1 CodeableConcept Kind of characteristic --></code> <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range|Reference 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(CareTeam|Device|Group|HealthcareService|Location| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|Specimen) 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>
JSON Template
{
"resourceType" : "Group",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Unique id
"active" : <boolean>, // Whether this group's record is in active use
"type" : "<code>", // R! person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
"membership" : "<code>", // R! definitional | enumerated
"code" : { CodeableConcept }, // Kind of Group members
"name" : "<string>", // Label for Group
"description" : "<markdown>", // Natural language description of the group
"quantity" : "<unsignedInt>", // Number of members
"managingEntity" : { Reference(Organization|Practitioner|PractitionerRole|
RelatedPerson) }, // Entity that is the custodian of the Group's definition
"characteristic" : [{ // Include / Exclude group members by Trait
"code" : { CodeableConcept }, // R! Kind of characteristic
// value[x]: Value held by characteristic. One of these 5:
"valueCodeableConcept" : { CodeableConcept },
"valueBoolean" : <boolean>,
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueReference" : { Reference },
"exclude" : <boolean>, // R! Group includes or excludes
"period" : { Period } // Period over which characteristic is tested
}],
"member" : [{ // Who or what is in group
"entity" : { Reference(CareTeam|Device|Group|HealthcareService|Location|
Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|Specimen) }, // R! Reference to the group member
"period" : { Period }, // Period member belonged to the group
"inactive" : <boolean> // If member is no longer in group
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R4
| Group | |
| Group.active |
|
| Group.membership |
|
| Group.description |
|
| Group.member.entity |
|
| Group.actual |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | TU | DomainResource | Group of multiple entities Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| identifier | Σ | 0..* | Identifier | Unique id |
| active | ?!Σ | 0..1 | boolean | Whether this group's record is in active use |
| type | Σ | 1..1 | code | person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen GroupType (Required) |
| membership | Σ | 1..1 | code | definitional | enumerated GroupMembershipBasis (Required) |
| code | Σ | 0..1 | CodeableConcept | Kind of Group members GroupKind (Example) |
| name | Σ | 0..1 | string | Label for Group |
| description | 0..1 | markdown | Natural language description of the group | |
| quantity | Σ | 0..1 | unsignedInt | Number of members |
| managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition |
| characteristic | Σ | 0..* | BackboneElement | Include / Exclude group members by Trait |
| code | Σ | 1..1 | CodeableConcept | Kind of characteristic GroupCharacteristicKind (Example) |
| value[x] | Σ | 1..1 | Value held by characteristic GroupCharacteristicValue (Example) | |
| valueCodeableConcept | CodeableConcept | |||
| valueBoolean | boolean | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueReference | Reference() | |||
| exclude | Σ | 1..1 | boolean | Group includes or excludes |
| period | 0..1 | Period | Period over which characteristic is tested | |
| member | 0..* | BackboneElement | Who or what is in group | |
| entity | 1..1 | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) | 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 | |
| Documentation for this format | ||||
See the Extensions for this resource
XML Template
<Group xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "Group",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Unique id
"active" : <boolean>, // Whether this group's record is in active use
"type" : "<code>", // R! person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
"membership" : "<code>", // R! definitional | enumerated
"code" : { CodeableConcept }, // Kind of Group members
"name" : "<string>", // Label for Group
"description" : "<markdown>", // Natural language description of the group
"quantity" : "<unsignedInt>", // Number of members
"managingEntity" : { Reference(Organization|Practitioner|PractitionerRole|
RelatedPerson) }, // Entity that is the custodian of the Group's definition
"characteristic" : [{ // Include / Exclude group members by Trait
"code" : { CodeableConcept }, // R! Kind of characteristic
// value[x]: Value held by characteristic. One of these 5:
"valueCodeableConcept" : { CodeableConcept },
"valueBoolean" : <boolean>,
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueReference" : { Reference },
"exclude" : <boolean>, // R! Group includes or excludes
"period" : { Period } // Period over which characteristic is tested
}],
"member" : [{ // Who or what is in group
"entity" : { Reference(CareTeam|Device|Group|HealthcareService|Location|
Organization|Patient|Practitioner|PractitionerRole|RelatedPerson|Specimen) }, // R! Reference to the group member
"period" : { Period }, // Period member belonged to the group
"inactive" : <boolean> // If member is no longer in group
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since Release 4
| Group | |
| Group.active |
|
| Group.membership |
|
| Group.description |
|
| Group.member.entity |
|
| Group.actual |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Group.type | Types of resources that are part of group. | Required | GroupType |
| Group.membership | Basis for membership in a group | Required | GroupMembershipBasis |
| Group.code | Example | ?? | |
| Group.characteristic.code | Example | ?? | |
| Group.characteristic.value[x] | Example | ?? |
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.
For operations to assist in adding to, removing from, or filtering contents of large Groups, see Operations for Large Resources.
Membership testing is used to test for active members of a Group. At a minimum, servers supporting membership testing on Group resources SHALL be able to correctly identify active enumerated entities. Active enumerated entities in a group are entities:
Group.member.entity,Group.member.inactive with a value of true, andGroup.member.period (e.g., either the element is not present or has a period covering 'now').
Membership testing MAY also be applied to characteristic-defined Groups. If supported,
membership testing is based on the characteristic testing of the Group. Any entity meeting
the required characteristics is considered to be active.
Servers SHOULD declare whether they support only the enumerated or characteristic group filters. Servers MAY impose additional membership constraints (e.g. based on modifier extensions).
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 | Expression | In Common |
| characteristic | token | Kind of characteristic | Group.characteristic.code | |
| characteristic-reference | reference | An entity referenced in a characteristic | (Group.characteristic.value as Reference) | |
| characteristic-value | composite | A composite of both characteristic and value | On Group.characteristic: characteristic: code value: (value as CodeableConcept) | (value as boolean) | |
| code | token | The kind of resources contained | Group.code | |
| exclude | token | Group includes or excludes | Group.characteristic.exclude | |
| identifier | token | Unique id | Group.identifier | |
| managing-entity | reference | Entity that is the custodian of the Group's definition | Group.managingEntity (Practitioner, Organization, PractitionerRole, RelatedPerson) | |
| member | reference | Reference to the group member | Group.member.entity (Practitioner, Group, Specimen, Organization, CareTeam, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location) | |
| membership | token | Definitional or enumerated group | Group.membership | |
| name | string | A portion of the Group's name | Group.name | |
| type | token | The type of resources the group contains | Group.type | |
| value | token | Value held by characteristic | (Group.characteristic.value as CodeableConcept) | (Group.characteristic.value as boolean) |
FHIR ®© HL7.org 2011+. FHIR R5 Snapshot 3, hl7.fhir.core#5.0.0-snapshot3 generated on Wed, Dec 14, 2022 07:16+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change