This
page
is
part
of
the
FHIR
Specification
(v1.0.2:
DSTU
2).
The
current
version
which
supercedes
this
version
is
This page is part of the FHIR Specification (v1.6.0:
STU
3 Ballot 4). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
5.17
8.14
Resource
Group
-
Content
Resource Group - Content
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.
5.17.1
Scope
and
Usage
8.14.1
Scope and Usage
5.17.1.1
Use
Cases
8.14.1.1
Use Cases
The
group
resource
is
used
in
one
of
two
ways:
To
define
a
group
of
specific
people,
animals,
devices,
etc.
that
is
being
tracked,
examined
or
otherwise
referenced
as
part
of
healthcare-related
activities
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.
The group resource is used in one of two ways:
To define a group of specific people, animals, devices, etc. that is being tracked, examined or otherwise referenced as part of healthcare-related activities
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.
5.17.2
Boundaries
and
Relationships
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
There are five mechanisms in FHIR for communicating collections of resources:
The
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
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
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
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
is
expressed
using
a
bundle.
Compositions
will
often
reference
Lists
as
the
focus
of
particular
sections.
The
. 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
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
,
DiagnosticOrder
,
,
DeviceUseRequest
,
DiagnosticReport
,
,
DiagnosticRequest
,
DocumentManifest
,
,
DocumentReference
,
,
Flag
,
,
Goal
,
,
GuidanceResponse
,
List
,
,
Media
,
,
Observation
,
Order
,
,
Procedure
,
,
ProcedureRequest
,
,
RiskAssessment
and
,
Specimen
and
Task
5.17.3
Resource
Content
8.14.3
Resource Content
UML
Diagram
UML Diagram
(
Legend
)
Group
(
(
DomainResource
)
<del class="diff-old">A
unique
business
identifier
for
this
group
</del>
<ins class="diff-chg">A unique business identifier for this group
</ins>
identifier
:
:
Identifier
[0..*]
[0..*]
<del class="diff-old">Identifies
the
broad
classification
of
the
kind
of
resources
the
group
includes
</del>
<ins class="diff-chg">Identifies the broad classification of the kind of resources the group includes
</ins>
type
:
:
code
[1..1]
«
[1..1] «
<del class="diff-old">Types
of
resources
that
are
part
of
group
(Strength=Required)
</del>
<ins class="diff-chg">Types of resources that are part of group (Strength=Required)
</ins>
GroupType
!
»
! »
<del class="diff-old">If
true,
indicates
that
the
resource
refers
to
a
specific
group
of
real
individuals.
If
false,
the
group
defines
a
set
of
intended
individuals
</del>
<ins class="diff-chg">If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals
</ins>
actual
:
:
boolean
[1..1]
[1..1]
<ins class="diff-chg">Indicates whether the record for the group is available for use or is merely being retained for historical purposes
</ins>
active
:
boolean
<del class="diff-old">Provides
a
specific
type
of
resource
the
group
includes;
e.g.
"cow",
"syringe",
etc
</del>
<ins class="diff-chg">Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc
</ins>
code
:
:
CodeableConcept
[0..1]
[0..1]
<del class="diff-old">A
label
assigned
to
the
group
for
human
identification
and
communication
</del>
<ins class="diff-chg">A label assigned to the group for human identification and communication
</ins>
name
:
:
string
[0..1]
[0..1]
<del class="diff-old">A
count
of
the
number
of
resource
instances
that
are
part
of
the
group
</del>
<ins class="diff-chg">A count of the number of resource instances that are part of the group
</ins>
quantity
:
:
unsignedInt
[0..1]
[0..1]
Characteristic
<del class="diff-old">A
code
that
identifies
the
kind
of
trait
being
asserted
</del>
<ins class="diff-chg">A code that identifies the kind of trait being asserted
</ins>
code
:
:
CodeableConcept
[1..1]
[1..1]
<del class="diff-old">The
value
of
the
trait
that
holds
(or
does
not
hold
-
see
'exclude')
for
members
of
the
group
</del>
<ins class="diff-chg">The value of the trait that holds (or does not hold - see 'exclude') for members of the group
</ins>
value[x]
:
:
Type
[1..1]
«
[1..1] «
CodeableConcept
|
boolean
|
Quantity
|
Range
»
»
<del class="diff-old">If
true,
indicates
the
characteristic
is
one
that
is
NOT
held
by
members
of
the
group
(this
element
modifies
the
meaning
of
other
elements)
</del>
<ins class="diff-chg">If true, indicates the characteristic is one that is NOT held by members of the group (this element modifies the meaning of other elements)
</ins>
exclude
:
:
boolean
[1..1]
[1..1]
<del class="diff-old">The
period
over
which
the
characteristic
is
tested;
e.g.
the
patient
had
an
operation
during
the
month
of
June
</del>
<ins class="diff-chg">The period over which the characteristic is tested; e.g. the patient had an operation during the month of June
</ins>
period
:
:
Period
[0..1]
[0..1]
Member
<del class="diff-old">A
reference
to
the
entity
that
is
a
member
of
the
group.
Must
be
consistent
with
Group.type
</del>
<ins class="diff-chg">A reference to the entity that is a member of the group. Must be consistent with Group.type
</ins>
entity
:
:
Reference
[1..1]
«
[1..1] «
Patient
|
Practitioner
|
Device
|
Medication
|
Substance
»
»
<del class="diff-old">The
period
that
the
member
was
in
the
group,
if
known
</del>
<ins class="diff-chg">The period that the member was in the group, if known
</ins>
period
:
:
Period
[0..1]
[0..1]
<del class="diff-old">A
flag
to
indicate
that
the
member
is
no
longer
in
the
group,
but
previously
may
have
been
a
member
</del>
<ins class="diff-chg">A flag to indicate that the member is no longer in the group, but previously may have been a member
</ins>
inactive
:
:
boolean
[0..1]
[0..1]
<del class="diff-old">Identifies
the
traits
shared
by
members
of
the
group
</del>
<ins class="diff-chg">Identifies the traits shared by members of the group
</ins>
characteristic
[0..*]
<del class="diff-old">Identifies
the
resource
instances
that
are
members
of
the
group
</del>
<ins class="diff-chg">Identifies the resource instances that are members of the group
</ins>
member
[0..*]
XML
Template
XML Template
<
JSON
Template
JSON Template
{
"resourceType" : "",
{Group
// from Resource : id , meta , implicitRules , and language
// from DomainResource : text , contained , extension , and modifierExtension
"
"
"
"
"
"
"
"
"identifier " : [{ Identifier // Unique id type " : "<code // R! person | animal | practitioner | device | medication | substance actual " : <boolean // C? R! Descriptive or actual active " : <boolean // Whether this group's record is in active use code " : { CodeableConcept // Kind of Group members name " : "<string // Label for Group quantity " : "<unsignedInt // Number of members characteristic " : [{ // Trait of group members code " : { CodeableConcept // R! Kind of characteristic
// value[x]: Value held by characteristic . One of these 4:
" },
">,
" },
" },
"
"
"valueCodeableConcept " : { CodeableConcept valueBoolean " : <boolean valueQuantity " : { Quantity valueRange " : { Range 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 (Patient |Practitioner |Device |Medication |Substance )// R! Reference to the group member period " : { Period // Period member belonged to the group inactive " : <boolean // If member is no longer in group
}]
}
UML
Diagram
UML Diagram
(
Legend
)
Group
(
(
DomainResource
)
<del class="diff-old">A
unique
business
identifier
for
this
group
</del>
<ins class="diff-chg">A unique business identifier for this group
</ins>
identifier
:
:
Identifier
[0..*]
[0..*]
<del class="diff-old">Identifies
the
broad
classification
of
the
kind
of
resources
the
group
includes
</del>
<ins class="diff-chg">Identifies the broad classification of the kind of resources the group includes
</ins>
type
:
:
code
[1..1]
«
[1..1] «
<del class="diff-old">Types
of
resources
that
are
part
of
group
(Strength=Required)
</del>
<ins class="diff-chg">Types of resources that are part of group (Strength=Required)
</ins>
GroupType
!
»
! »
<del class="diff-old">If
true,
indicates
that
the
resource
refers
to
a
specific
group
of
real
individuals.
If
false,
the
group
defines
a
set
of
intended
individuals
</del>
<ins class="diff-chg">If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals
</ins>
actual
:
:
boolean
[1..1]
[1..1]
<ins class="diff-chg">Indicates whether the record for the group is available for use or is merely being retained for historical purposes
</ins>
active
:
boolean
<del class="diff-old">Provides
a
specific
type
of
resource
the
group
includes;
e.g.
"cow",
"syringe",
etc
</del>
<ins class="diff-chg">Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc
</ins>
code
:
:
CodeableConcept
[0..1]
[0..1]
<del class="diff-old">A
label
assigned
to
the
group
for
human
identification
and
communication
</del>
<ins class="diff-chg">A label assigned to the group for human identification and communication
</ins>
name
:
:
string
[0..1]
[0..1]
<del class="diff-old">A
count
of
the
number
of
resource
instances
that
are
part
of
the
group
</del>
<ins class="diff-chg">A count of the number of resource instances that are part of the group
</ins>
quantity
:
:
unsignedInt
[0..1]
[0..1]
Characteristic
<del class="diff-old">A
code
that
identifies
the
kind
of
trait
being
asserted
</del>
<ins class="diff-chg">A code that identifies the kind of trait being asserted
</ins>
code
:
:
CodeableConcept
[1..1]
[1..1]
<del class="diff-old">The
value
of
the
trait
that
holds
(or
does
not
hold
-
see
'exclude')
for
members
of
the
group
</del>
<ins class="diff-chg">The value of the trait that holds (or does not hold - see 'exclude') for members of the group
</ins>
value[x]
:
:
Type
[1..1]
«
[1..1] «
CodeableConcept
|
boolean
|
Quantity
|
Range
»
»
<del class="diff-old">If
true,
indicates
the
characteristic
is
one
that
is
NOT
held
by
members
of
the
group
(this
element
modifies
the
meaning
of
other
elements)
</del>
<ins class="diff-chg">If true, indicates the characteristic is one that is NOT held by members of the group (this element modifies the meaning of other elements)
</ins>
exclude
:
:
boolean
[1..1]
[1..1]
<del class="diff-old">The
period
over
which
the
characteristic
is
tested;
e.g.
the
patient
had
an
operation
during
the
month
of
June
</del>
<ins class="diff-chg">The period over which the characteristic is tested; e.g. the patient had an operation during the month of June
</ins>
period
:
:
Period
[0..1]
[0..1]
Member
<del class="diff-old">A
reference
to
the
entity
that
is
a
member
of
the
group.
Must
be
consistent
with
Group.type
</del>
<ins class="diff-chg">A reference to the entity that is a member of the group. Must be consistent with Group.type
</ins>
entity
:
:
Reference
[1..1]
«
[1..1] «
Patient
|
Practitioner
|
Device
|
Medication
|
Substance
»
»
<del class="diff-old">The
period
that
the
member
was
in
the
group,
if
known
</del>
<ins class="diff-chg">The period that the member was in the group, if known
</ins>
period
:
:
Period
[0..1]
[0..1]
<del class="diff-old">A
flag
to
indicate
that
the
member
is
no
longer
in
the
group,
but
previously
may
have
been
a
member
</del>
<ins class="diff-chg">A flag to indicate that the member is no longer in the group, but previously may have been a member
</ins>
inactive
:
:
boolean
[0..1]
[0..1]
<del class="diff-old">Identifies
the
traits
shared
by
members
of
the
group
</del>
<ins class="diff-chg">Identifies the traits shared by members of the group
</ins>
characteristic
[0..*]
<del class="diff-old">Identifies
the
resource
instances
that
are
members
of
the
group
</del>
<ins class="diff-chg">Identifies the resource instances that are members of the group
</ins>
member
[0..*]
XML
Template
XML Template
<
JSON
Template
JSON Template
{
"resourceType" : "",
{Group
// from Resource : id , meta , implicitRules , and language
// from DomainResource : text , contained , extension , and modifierExtension
"
"
"
"
"
"
"
"
"identifier " : [{ Identifier // Unique id type " : "<code // R! person | animal | practitioner | device | medication | substance actual " : <boolean // C? R! Descriptive or actual active " : <boolean // Whether this group's record is in active use code " : { CodeableConcept // Kind of Group members name " : "<string // Label for Group quantity " : "<unsignedInt // Number of members characteristic " : [{ // Trait of group members code " : { CodeableConcept // R! Kind of characteristic
// value[x]: Value held by characteristic . One of these 4:
" },
">,
" },
" },
"
"
"valueCodeableConcept " : { CodeableConcept valueBoolean " : <boolean valueQuantity " : { Quantity valueRange " : { Range 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 (Patient |Practitioner |Device |Medication |Substance )// R! Reference to the group member period " : { Period // Period member belonged to the group inactive " : <boolean // If member is no longer in group
}]
}
Alternate
definitions:
Alternate definitions: Master Definition (
XML
JSON
),
XML
Schema
/
Schematron
,
Resource
Profile
(
XML
,
(for ) +
JSON
Schema
,
ShEx
Turtle
),
Questionnaire
)
5.17.3.1
Terminology
Bindings
8.14.3.1
Terminology Bindings
Path
Definition
Type
Reference
Group.type
Group.type
Types
of
resources
that
are
part
of
group
Types of resources that are part of group
Required
GroupType
Group.code
Group.code
Kind
of
particular
resource;
e.g.
cow,
syringe,
lake,
etc.
Kind of particular resource; e.g. cow, syringe, lake, etc.
Unknown
No
details
provided
yet
No details provided yet
Group.characteristic.code
Group.characteristic.code
List
of
characteristics
used
to
describe
group
members;
e.g.
gender,
age,
owner,
location,
etc.
List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Unknown
No
details
provided
yet
No details provided yet
Group.characteristic.value[x]
Group.characteristic.value[x]
Value
of
descriptive
member
characteristic;
e.g.
red,
male,
pneumonia,
Caucasian,
etc.
Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
Unknown
No
details
provided
yet
No details provided yet
5.17.3.2
Constraints
8.14.3.2
Constraints
grp-1
:
Can
only
have
members
if
group
is
"actual"
(xpath:
f:actual/@value=true()
or
not(exists(f:member))
: Can only have members if group is "actual" (
expression :
member.empty() or (actual = true)
5.17.4
Search
Parameters
8.14.4
Search Parameters
Search
parameters
for
this
resource.
The
common
parameters
also
apply.
See
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
Name
Type
Description
Paths
actual
token
Descriptive
or
actual
Descriptive or actual
Group.actual
characteristic
token
Kind
of
characteristic
Kind of characteristic
Group.characteristic.code
characteristic-value
composite
A
composite
of
both
characteristic
and
value
A composite of both characteristic and value
code
token
The
kind
of
resources
contained
The kind of resources contained
Group.code
exclude
token
Group
includes
or
excludes
Group includes or excludes
Group.characteristic.exclude
identifier
token
Unique
id
Unique id
Group.identifier
member
reference
Reference
to
the
group
member
Reference to the group member
Group.member.entity
Medication
,
Practitioner
,
Device
,
,
Medication
,
Patient
,
,
Substance
,
Practitioner
)
type
token
The
type
of
resources
the
group
contains
The type of resources the group contains
Group.type
value
token
Value
held
by
characteristic
Value held by characteristic
Group.characteristic.value[x]
©
HL7.org
2011+.
FHIR
DSTU2
(v1.0.2-7202)
generated
on
Sat,
Oct
24,
2015
07:43+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Compare
to
DSTU1
Administration
Group
identifier
type
characteristic
value[x]
entity
<!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
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>
