This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
v6.0.0-ballot4:
Release
6
Ballot
(1st
Full
Ballot)
(see
Ballot
Notes
)
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
for
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Responsible
Owner:
FHIR
Infrastructure
Work
Group
|
|
Security 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
typically
expected
to
act
NOTE:
Group
may
be
used
to
define
families
or
households,
which
in
some
circumstances
may
act
collectively
or
have
a
For
example,
it
is
possible
for
a
'family'
Group
to
be
a
performer
of
an
|
||||||||
| Short Display | Group of multiple entities | ||||||||
| Cardinality | 0..* | ||||||||
| Type | CanonicalResource | ||||||||
|
|
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. |
||||||||
|
|
|
||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
| ||||||||
| Short Display |
Canonical
identifier
for
this
| ||||||||
| Cardinality | 0..1 | ||||||||
| Type | uri | ||||||||
| Requirements | Allows the Group to be referenced by a single globally unique identifier. |
||||||||
|
| 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. | ||||||||
| Constraints |
| ||||||||
| 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
| ||||||||
| Group.version | |||||||||
| Element Id | Group.version | ||||||||
| Definition |
The
identifier
that
is
used
to
identify
this
version
of
the
Group
when
it
is
referenced
|
||||||||
| 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 . | ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
Indicates
| ||||||||
| 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
| ||||||||
| Requirements |
Enables
tracking
the
life-cycle
of
the
content
and
filtering
of
Groups
that
are
appropriate
for
use
| ||||||||
| 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
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
|
||||||||
| Short Display | For testing only - never for real usage | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | boolean | ||||||||
| Meaning if Missing |
| ||||||||
| Requirements |
Enables
experimental
content
to
be
| ||||||||
| Summary | true | ||||||||
| Comments | Allows filtering of Groups that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.). Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element. | ||||||||
| 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
| ||||||||
| Short Display | Date last changed | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Alternate Names | Revision Date | ||||||||
| Summary | true | ||||||||
| Comments |
The
date
is
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
| ||||||||
| 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 |
| ||||||||
| Group.contact | |||||||||
| Element Id | Group.contact | ||||||||
| Definition |
Contact
details
to
| ||||||||
| 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
| ||||||||
| 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
| ||||||||
| 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
| ||||||||
| 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 notices of intellectual property ownership and can include restrictions on the use and publishing of the Group. | ||||||||
| Short Display | Notice about intellectual property ownership, can include restrictions on use | ||||||||
| 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 without the copyright prefix (i.e., do not include '(c)' or the symbol). | ||||||||
| Group.copyrightLabel | |||||||||
| Element Id | Group.copyrightLabel | ||||||||
| Definition |
A
short
string
(<50
characters),
suitable
for
inclusion
in
a
| ||||||||
| 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 | ||||||||
|
| The copyright symbol and the '(c)' textual representation 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 | medication | medicinalproductdefinition | substance | substancedefinition | biologicallyDerivedProduct | nutritionProduct | ||||||||
| Cardinality |
|
||||||||
| Terminology Binding |
|
||||||||
| 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,
|
||||||||
| Constraints |
| ||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
| ||||||||
| Short Display | definitional | conceptual | enumerated | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Group Membership Basis ( Required ) | ||||||||
| Type |
|
||||||||
| 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
|
||||||||
| Summary | true | ||||||||
|
|
|
||||||||
| Group.code | |||||||||
| Element Id | Group.code | ||||||||
| Definition |
|
||||||||
| Short Display | Use of the Group (and by implication, kind of members) | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding |
|
||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Comments |
|
||||||||
|
|
|||||||||
| 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.) | ||||||||
| Meaning if Missing | If absent, this element is treated as though it had been set to 'all-of' | ||||||||
| 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. |
||||||||
|
| true | ||||||||
| Comments |
|
||||||||
| 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 |
|
||||||||
| 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. |
||||||||
|
|
|
||||||||
|
|
|
||||||||
| Type | CodeableConcept | boolean | Quantity | Range | Reference | uri | Expression | ||||||||
| [x] Note |
See
Choice
of
|
||||||||
| Requirements |
The value of the characteristic is what determines group membership. |
||||||||
|
| 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. |
||||||||
|
|
true | ||||||||
| Comments |
This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
||||||||
|
|
|||||||||
| Element Id |
|
||||||||
| Definition |
|
||||||||
| 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 | ||||||||
|
|
|||||||||
| Element Id | Group.characteristic.method | ||||||||
|
| 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.formula | |||||||||
| Element Id | Group.characteristic.formula | ||||||||
| Definition |
|
||||||||
| Short Display | Formal algorithm to derive the value | ||||||||
| Cardinality | 0..1 | ||||||||
|
| Expression | ||||||||
|
|
false | ||||||||
| Group.characteristic.determiner | |||||||||
| Element Id | Group.characteristic.determiner | ||||||||
| Definition |
| ||||||||
| Short Display | Who determines the value | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference ( Practitioner | PractitionerRole | Organization | Device | DeviceDefinition ) | ||||||||
| Summary | false | ||||||||
| Comments |
The
expectation
is
|
||||||||
| Group.characteristic.offset | |||||||||
|
| 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 | unsignedInt | Range | ||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
| Summary | false | ||||||||
| Constraints |
|
||||||||
| 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
|
| ||||||||
| 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 | ||||||||
| Comments | See Relationships inside the group for more detailed family relationships. | ||||||||
| 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 | ||||||||