This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v4.3.0:
R4B
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
).
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
R4B
R4
R3
R2
FHIR
Infrastructure
Work
Group
|
Maturity Level : 1 | 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.
This resource is referenced by DataRequirement , UsageContext , ActivityDefinition , AdverseEvent , CarePlan , CareTeam , ChargeItem , ClinicalImpression , ClinicalUseDefinition , Communication , CommunicationRequest , Condition , Consent , Contract , DeviceRequest , DeviceUseStatement , DiagnosticReport , DocumentManifest , DocumentReference , Encounter , EventDefinition , Evidence , EvidenceReport , EvidenceVariable , Flag , Goal , itself, GuidanceResponse , ImagingStudy , Invoice , Library , List , Measure , MeasureReport , Media , MedicationAdministration , MedicationDispense , MedicationRequest , MedicationStatement , Observation , PlanDefinition , Procedure , RequestGroup , ResearchDefinition , ResearchElementDefinition , ResearchStudy , RiskAssessment , ServiceRequest , Specimen and Task .
This resource does not implement any patterns.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
|
DomainResource |
Group
of
multiple
entities
+ Rule: Can only have members if group is "actual" Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Unique
id
|
|
Σ | 0..1 | boolean | Whether this group's record is in active use |
|
Σ | 1..1 | code |
person
|
animal
|
practitioner
|
device
|
medication
|
substance
GroupType ( Required ) |
|
Σ I | 1..1 | boolean | Descriptive or actual |
|
Σ | 0..1 | CodeableConcept |
Kind
of
Group
members
GroupKind ( Example ) |
|
Σ | 0..1 | string | Label for Group |
|
Σ | 0..1 | unsignedInt | Number of members |
|
Σ | 0..1 | Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole ) | Entity that is the custodian of the Group's definition |
|
0..* | BackboneElement |
Include
/
Exclude
group
members
by
Trait
|
|
|
1..1 | CodeableConcept |
Kind
of
characteristic
GroupCharacteristicKind ( Example ) |
|
|
1..1 |
Value
held
by
characteristic
GroupCharacteristicValue ( Example ) |
||
|
CodeableConcept | |||
|
boolean | |||
|
Quantity | |||
|
Range | |||
|
Reference () | |||
|
1..1 | boolean | Group includes or excludes | |
|
0..1 | Period | Period over which characteristic is tested | |
|
I | 0..* | BackboneElement |
Who
or
what
is
in
group
|
|
1..1 | Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Medication | Substance | Group ) | Reference to the group member | |
|
0..1 | Period | Period member belonged to the group | |
|
0..1 | boolean | If member is no longer in group | |
Documentation
for
this
format
|
||||
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 | medication | substance --> <actual value="[boolean]"/><!--
1..1 Descriptive or actual --> <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 -->
<| </managingEntity><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><entity><!-- 1..1 Reference(Device|Group|Medication|Patient|Practitioner| PractitionerRole|RelatedPerson|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>
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 | medication | substance
"actual" : <boolean>, // C? R! Descriptive or actual
"code" : { CodeableConcept }, // Kind of Group members
"name" : "<string>", // Label for 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" : [{ // C? Who or what is in group
"|
"entity" : { Reference(Device|Group|Medication|Patient|Practitioner|
PractitionerRole|RelatedPerson|Substance) }, // 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/> .[ 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.active [ boolean ]; # 0..1 Whether this group's record is in active use fhir:Group.type [ code ]; # 1..1 person | animal | practitioner | device | medication | substance fhir:Group.actual [ boolean ]; # 1..1 Descriptive or actual 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:fhir:Group.managingEntity [ Reference(Organization|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Entity that is the custodian of the Group's definition fhir:Group.characteristic [ # 0..* Include / Exclude group members by Trait fhir:Group.characteristic.code [ CodeableConcept ]; # 1..1 Kind of characteristic # Group.characteristic.value[x] : 1..1 Value held by characteristic. One of these 5 fhir:Group.characteristic.valueCodeableConcept [ CodeableConcept ] fhir:Group.characteristic.valueBoolean [ boolean ] fhir:Group.characteristic.valueQuantity [ Quantity ] fhir:Group.characteristic.valueRange [ Range ] fhir:Group.characteristic.valueReference [ Reference ] 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 groupfhir:fhir:Group.member.entity [ Reference(Device|Group|Medication|Patient|Practitioner|PractitionerRole|RelatedPerson| 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
R3
R4
| Group | |
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions between R3 and R4
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
|
|---|---|---|---|---|
|
|
DomainResource |
Group
of
multiple
entities
+ Rule: Can only have members if group is "actual" Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Unique
id
|
|
Σ | 0..1 | boolean | Whether this group's record is in active use |
|
Σ | 1..1 | code |
person
|
animal
|
practitioner
|
device
|
medication
|
substance
GroupType ( Required ) |
|
Σ I | 1..1 | boolean | Descriptive or actual |
|
Σ | 0..1 | CodeableConcept |
Kind
of
Group
members
GroupKind ( Example ) |
|
Σ | 0..1 | string | Label for Group |
|
Σ | 0..1 | unsignedInt | Number of members |
|
Σ | 0..1 | Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole ) | Entity that is the custodian of the Group's definition |
|
0..* | BackboneElement |
Include
/
Exclude
group
members
by
Trait
|
|
|
1..1 | CodeableConcept |
Kind
of
characteristic
GroupCharacteristicKind ( Example ) |
|
|
1..1 |
Value
held
by
characteristic
GroupCharacteristicValue ( Example ) |
||
|
CodeableConcept | |||
|
boolean | |||
|
Quantity | |||
|
Range | |||
|
Reference () | |||
|
1..1 | boolean | Group includes or excludes | |
|
0..1 | Period | Period over which characteristic is tested | |
|
I | 0..* | BackboneElement |
Who
or
what
is
in
group
|
|
1..1 | Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole | Device | Medication | Substance | Group ) | Reference to the group member | |
|
0..1 | Period | Period member belonged to the group | |
|
0..1 | boolean | If member is no longer in group | |
Documentation
for
this
format
|
||||
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 | medication | substance --> <actual value="[boolean]"/><!--
1..1 Descriptive or actual --> <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 -->
<| </managingEntity><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><entity><!-- 1..1 Reference(Device|Group|Medication|Patient|Practitioner| PractitionerRole|RelatedPerson|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>
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 | medication | substance
"actual" : <boolean>, // C? R! Descriptive or actual
"code" : { CodeableConcept }, // Kind of Group members
"name" : "<string>", // Label for 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" : [{ // C? Who or what is in group
"|
"entity" : { Reference(Device|Group|Medication|Patient|Practitioner|
PractitionerRole|RelatedPerson|Substance) }, // 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/> .[ 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.active [ boolean ]; # 0..1 Whether this group's record is in active use fhir:Group.type [ code ]; # 1..1 person | animal | practitioner | device | medication | substance fhir:Group.actual [ boolean ]; # 1..1 Descriptive or actual 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:fhir:Group.managingEntity [ Reference(Organization|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Entity that is the custodian of the Group's definition fhir:Group.characteristic [ # 0..* Include / Exclude group members by Trait fhir:Group.characteristic.code [ CodeableConcept ]; # 1..1 Kind of characteristic # Group.characteristic.value[x] : 1..1 Value held by characteristic. One of these 5 fhir:Group.characteristic.valueCodeableConcept [ CodeableConcept ] fhir:Group.characteristic.valueBoolean [ boolean ] fhir:Group.characteristic.valueQuantity [ Quantity ] fhir:Group.characteristic.valueRange [ Range ] fhir:Group.characteristic.valueReference [ Reference ] 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 groupfhir:fhir:Group.member.entity [ Reference(Device|Group|Medication|Patient|Practitioner|PractitionerRole|RelatedPerson| 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
Release
3
4
| Group | |
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions between R3 and R4
See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Group.type |
|
Required | GroupType |
| Group.code |
|
|
|
| Group.characteristic.code |
|
|
|
| Group.characteristic.value[x] |
|
|
|
| id | Level | Location | Description | Expression |
| grp-1 | Rule | (base) | Can only have members if group is "actual" | member.empty() or (actual = true) |
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.
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 |
| 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 |
On
Group.characteristic:
characteristic: code 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 | |
| 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 , Device , Medication , Patient , Substance , PractitionerRole , RelatedPerson ) |
|
| 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) |