This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Responsible
Owner:
FHIR
Infrastructure
Work
Group
|
Normative
|
|
Compartments : Device , Patient , Practitioner |
Represents
a
defined
collection
of
entities
that
may
be
discussed
or
acted
upon
collectively
but
which
are
not
typically
expected
to
act
collectively
and
collectively.
These
collections
are
also
not
typically
formally
or
legally
recognized;
i.e.
recognized.
NOTE:
Group
may
be
used
to
define
families
or
households,
which
in
some
circumstances
may
act
collectively
or
have
a
collection
degree
of
legal
or
formal
recognition.
This
should
be
considered
an
exception.
When
Group
is
used
for
types
of
entities
other
than
Patient
or
RelatedPerson,
the
expectation
remains
that
isn't
the
Group
will
not
act
collectively
or
have
formal
recognition
-
use
Organization
if
these
behaviors
are
needed.
For
example,
it
is
possible
for
a
'family'
Group
to
be
a
performer
of
an
Organization.
Observation
or
owner
of
a
Task.
However,
this
is
not
permitted
for
a
Group
made
up
of
Practitioners,
PractitionerRoles
or
Organizations.
Organization
or
CareTeam
would
need
to
be
used
instead.
A
Group
of
Practitioners
could,
however,
be
a
subject
of
an
Observation.
The Group resource is used in one of two ways:
Examples of the former could include a family, a household, or 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.
NOTE: While Specimen does not quite fit with this definition, it is being retained as part of Group to avoid making a breaking change to the Observation resource.
The Group definition, specifying the criteria for membership in the Group, may be expressed with one or more Group.characteristic elements. Here we describe how the Group StructureDefinition is used to express inclusion and exclusion criteria for group membership.
Group.membership requires one of three codes:
Group.combinationMethod is used when there are two or more Group.characteristic instances to define how the characteristics are combined.
Provides the value of "n" when "at-least" or "at-most" codes are used for Group.combinationMethod (see above)
Each characteristic must have a code value (CodeableConcept datatype) to specify the attribute. For instance:
"code": { "coding": [ { "system": "http://snomed.info/sct", "code": "397669002", "display": "Age" } ] }
"code": { "coding": [ { "system": "http://loinc.org", "code": "39156-5", "display": "Body mass index (BMI) [Ratio]" } ] }
Each characteristic must have a value[x] value to specify the value of the attribute that holds for members of the group. There is no [x] in the JSON or XML expression as it is replaced with the data type (CodeableConcept, boolean, Quantity, Range, Reference, uri, or Expression)
For instance:
"valueQuantity": { "comparator": ">=", "value": 18, "unit": "years",
"system": "http://unitsofmeasure.org", "code": "a" }
"valueQuantity": { "comparator": ">=", "value": 30, "unit": "kg/m2",
"system": "http://unitsofmeasure.org", "code": "kg/m2" }
Sometimes group membership is determined by characteristics not possessed. When this is the case, the Group.characteristic.exclude element has a value of true ("exclude": true). For characteristics that are not exclusion criteria, the Group.characteristic.exclude element has a value of false ("exclude": false). The exclude element is required.
For example, an exclusion criterion of HbA1c ≥ 14.0% is expressed as:
{ "description": "HbA1c ≥ 14.0%", "code": {; "coding": [ { "system": "http://loinc.org", "code": "59261-8", "display": "Hemoglobin A1c/Hemoglobin.total in Blood" } ] }, "valueQuantity": { "value": 14, "comparator": ">=", "unit": "%", "system": "http://unitsofmeasure.org", "code": "%" }, "exclude": true }
A short, natural language description of the characteristic (using the markdown datatype) that could be used to communicate the criteria to an end-user. The description element is for convenience so that end users can understand the characteristic and is neither a required part of the characteristic nor part of the structured representation of the characteristic.
The method modifies the Group.characteristic.code and indicates how the value is to be determined, using the CodeableConcept datatype. For example, HbA1C values can be determined by High-Performance Liquid Chromatography or by Capillary electrophoresis.
The method may be expressed as multiple concepts, eg. standing barefoot for Height measurements could be expressed as two separate concepts (standing, barefoot) that express the method.
The formula modifies the Group.characteristic.code and indicates how the value is to be determined, using an Expression datatype.
The determiner modifies the Group.characteristic.code and indicates who or what determines the value, using a Reference datatype. The determiner value may reference a person ( Practitioner or PractitionerRole Resource) or group ( Organization Resource) or device. The reference to a device can be either to a specific device using the Device Resource, or the DeviceMetric Resource if a specific set of device parameters is needed, or a type of device using the DeviceDefinition Resource.
Defines the reference point for comparison when other than 0. As an example, to express a characteristic of a calcium level greater than the normal limit or a hemoglobin level less than 1 g/dL below the reference range, the offset concept would represent "normal limit" or "reference range".
This is a modifier element because it modifies the meaning of the characteristic.value[x].
Number of occurrences meeting the characteristic.
There should be a constraint on the Quantity.value and Range.low.value and Range.high.value that it can only be non-negative whole numbers.
Length of time in which the characteristic is met.
The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.
The relative time in which the characteristic is tested, eg. within a month following patient discharge.
Note: RelativeTime is a recent addition to the Group Resource. RelativeTime is used to express a point in time or an interval of time relative to an event defined in data types other than dateTime.
Example: Example of Group for HbA1c at 12 months
Example includes timing and offset "At 12 months form inclusion in a clinical trial. Inclusion is defined as enrollment via the SNOMED code.
"timing": [ { "contextCode": { "coding": [ { "system": "http://snomed.info/sct", "code": "709491003", "display": "Enrollment in clinical trial" } ] }, "offsetDuration": { "value": 12, "unit": "months", "system": "http://unitsofmeasure.org", "code": "mo" }, "text": "at 12 months" }
There
are
five
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
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Group
of
multiple
entities
+ Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension Interfaces Implemented: CanonicalResource |
|
|
Σ C | 0..1 | uri |
Canonical
identifier
for
this
Group,
represented
as
an
absolute
URI
(globally
unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic |
|
Σ | 0..* | Identifier |
Business
Identifier
for
this
Group
|
|
Σ | 0..1 | string |
Business
version
of
the
Group
|
![]() ![]() | Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) | |
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() | Coding | |||
![]() ![]() | Σ | 0..1 | string |
Label
for
Group
|
![]() ![]() | Σ | 0..1 | string |
Name
for
this
Group
(human
friendly)
|
![]() ![]() | ?! Σ | 0..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( Required ) |
![]() ![]() | Σ | 0..1 | boolean |
For
testing
only
-
never
for
real
usage
|
![]() ![]() |
| 0..1 | dateTime |
Date
last
changed
|
![]() ![]() | Σ | 0..1 | string |
Name
of
the
publisher/steward
(organization
or
individual)
|
![]() ![]() | Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
![]() ![]() | 0..1 | markdown |
Natural
language
description
of
the
group
| |
![]() ![]() | Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
![]() ![]() | 0..1 | markdown |
Why
this
| |
![]() ![]() | 0..1 | markdown |
Notice
about
intellectual
property
ownership,
can
include
restrictions
on
use
|
|
|
T
|
0..1 | string |
Copyright
holder
and
year(s)
|
| Σ C | 0..1 | code |
person
|
animal
|
practitioner
|
device
|
careteam
|
healthcareservice
|
location
|
organization
|
relatedperson
|
specimen
|
medication
|
medicinalproductdefinition
|
substance
|
substancedefinition
|
biologicallyDerivedProduct
|
nutritionProduct
|
|
Σ
|
1..1 |
|
definitional
|
conceptual
|
enumerated
Binding: Group Membership Basis ( Required ) |
|
Σ | 0..1 | CodeableConcept |
Use
of
the
Group
Binding: Group Code ( Extensible ) |
|
Σ | 0..1 |
unsignedInt
|
Number
of
members
|
![]() ![]() |
Σ | 0..1 | Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole ) |
Entity
that
is
the
custodian
of
the
Group's
definition
|
|
?! Σ | 0..1 |
code
|
all-of
|
any-of
|
at-least
|
at-most
|
except-subset
Binding: Group Characteristic Combination ( Required ) |
| 0..1 | positiveInt |
Provides
the
value
of
|
|
|
Σ | 0..* | BackboneElement |
Include
/
Exclude
group
members
by
Trait
|
|
Σ | 1..1 | CodeableConcept |
Kind
of
characteristic
Binding: Example Characterist ic Codes ( Example ) |
|
Σ | 1..1 |
Value
held
by
characteristic
|
|
|
CodeableConcept | |||
|
boolean | |||
|
Quantity | |||
|
Range | |||
| Reference () | |||
| uri | |||
|
|
Expression | ||
![]() ![]() ![]() | Σ | 1..1 | boolean |
Group
includes
or
excludes
|
| 0..1 | markdown |
Natural
language
description
of
the
characteristic
| |
![]() ![]()
|
0..* | CodeableConcept |
Method
for
how
the
characteristic
value
was
determined
Binding: Definition Method ( Example ) | |
![]() ![]() ![]() | 0..1 | Expression |
Formal
algorithm
to
derive
the
value
| |
![]() ![]() ![]() | 0..1 | Reference ( Practitioner | PractitionerRole | Organization | Device | DeviceDefinition ) |
Who
determines
the
value
| |
![]() ![]() ![]() | ?! Σ | 0..1 | CodeableConcept |
Reference
point
for
comparison
Binding: Characteristic Offset ( Example ) |
![]() ![]() ![]() | C | 0..1 |
Number
of
occurrences
meeting
the
characteristic
+ Rule: Ranges have to be positive | |
![]() ![]() ![]() ![]() | unsignedInt | |||
![]() ![]() ![]() ![]() | Range | |||
![]() ![]() ![]() | 0..1 |
Length
of
time
in
which
the
characteristic
is
met
| ||
![]() ![]() ![]() ![]() | Duration | |||
![]() ![]() ![]() ![]() | Range | |||
![]() ![]() ![]() | 0..1 | Period |
Period
over
which
characteristic
is
tested
|
|
|
0..* |
|
Timing
in
which
the
characteristic
is
determined
|
|
|
0..* | BackboneElement |
Who
or
what
is
in
group
|
|
|
1..1 |
Reference
(
CareTeam
|
Device
|
Group
|
HealthcareService
|
Location
|
Organization
|
Patient
|
Practitioner
|
|
Reference
to
the
group
member
|
|
|
0..* | CodeableConcept |
Code
that
describes
how
user
is
part
of
the
group
Binding: Group Involvement ( Example ) |
|
| 0..1 | Period |
Period
member
belonged
to
the
group
|
|
|
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> < < < <</code> < < < <</code> <</value[x]> <<url value="[uri]"/><!-- 0..1 Canonical identifier for this Group, represented as an absolute URI (globally unique) --> <identifier><!-- 0..* Identifier Business Identifier for this Group --></identifier> <version value="[string]"/><!-- 0..1 Business version of the Group --> <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- 0..1 Label for Group --> <title value="[string]"/><!-- 0..1 Name for this Group (human friendly) --> <status value="[code]"/><!-- 0..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the group --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <purpose value="[markdown]"/><!-- 0..1 Why this Group is defined --> <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <type value="[code]"/><!-- I 0..1 person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen | medication | medicinalproductdefinition | substance | substancedefinition | biologicallyDerivedProduct | nutritionProduct --> <membership value="[code]"/><!-- I 1..1 definitional | conceptual | enumerated --> <code><!-- 0..1 CodeableConcept Use of the Group (and by implication, kind of members) --></code> <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> <combinationMethod value="[code]"/><!-- 0..1 all-of | any-of | at-least | at-most | except-subset --> <combinationThreshold value="[positiveInt]"/><!-- 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used --> <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|uri| Expression Value held by characteristic --></value[x]> <exclude value="[boolean]"/><!-- 1..1 Group includes or excludes --> <description value="[markdown]"/><!-- 0..1 Natural language description of the characteristic --> <method><!-- 0..* CodeableConcept Method for how the characteristic value was determined --></method> <formula><!-- 0..1 Expression Formal algorithm to derive the value --></formula> <determiner><!-- 0..1 Reference(Device|DeviceDefinition|Organization| Practitioner|PractitionerRole) Who determines the value --></determiner> <offset><!-- 0..1 CodeableConcept Reference point for comparison --></offset> <instances[x]><!-- 0..1 unsignedInt|Range Number of occurrences meeting the characteristic --></instances[x]> <duration[x]><!-- 0..1 Duration|Range Length of time in which the characteristic is met --></duration[x]> <period><!-- 0..1 Period Period over which characteristic is tested --></period> <timing><!-- 0..* RelativeTime Timing in which the characteristic is determined --></timing> </characteristic>< <</entity><member> <!-- 0..* Who or what is in group --> <entity><!-- 1..1 Reference(BiologicallyDerivedProduct|CareTeam|Device|Group| HealthcareService|Location|Medication|MedicinalProductDefinition| NutritionProduct|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson|Specimen|Substance|SubstanceDefinition) Reference to the group member --></entity> <involvement><!-- 0..* CodeableConcept Code that describes how user is part of the group --></involvement> <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" : "",
"resourceType" : "Group",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
" },
">,
" },
" },
"
"
"url" : "<uri>", // Canonical identifier for this Group, represented as an absolute URI (globally unique)
"identifier" : [{ Identifier }], // Business Identifier for this Group
"version" : "<string>", // Business version of the Group
// versionAlgorithm[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>",
"versionAlgorithmCoding" : { Coding },
"name" : "<string>", // Label for Group
"title" : "<string>", // Name for this Group (human friendly)
"status" : "<code>", // draft | active | retired | unknown
"experimental" : <boolean>, // For testing only - never for real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the group
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"purpose" : "<markdown>", // Why this Group is defined
"copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"type" : "<code>", // I person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen | medication | medicinalproductdefinition | substance | substancedefinition | biologicallyDerivedProduct | nutritionProduct
"membership" : "<code>", // I R! definitional | conceptual | enumerated
"code" : { CodeableConcept }, // Use of the Group (and by implication, kind of members)
"quantity" : "<unsignedInt>", // Number of members
"managingEntity" : { Reference(Organization|Practitioner|PractitionerRole|
RelatedPerson) }, // Entity that is the custodian of the Group's definition
"combinationMethod" : "<code>", // all-of | any-of | at-least | at-most | except-subset
"combinationThreshold" : "<positiveInt>", // Provides the value of "n" when "at-least" or "at-most" codes are used
"characteristic" : [{ // Include / Exclude group members by Trait
"code" : { CodeableConcept }, // R! Kind of characteristic
// value[x]: Value held by characteristic. One of these 7:
"valueCodeableConcept" : { CodeableConcept },
"valueBoolean" : <boolean>,
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueReference" : { Reference },
"valueUri" : "<uri>",
"valueExpression" : { Expression },
"exclude" : <boolean>, // R! Group includes or excludes
"description" : "<markdown>", // Natural language description of the characteristic
"method" : [{ CodeableConcept }], // Method for how the characteristic value was determined
"formula" : { Expression }, // Formal algorithm to derive the value
"determiner" : { Reference(Device|DeviceDefinition|Organization|
Practitioner|PractitionerRole) }, // Who determines the value
"offset" : { CodeableConcept }, // Reference point for comparison
// instances[x]: Number of occurrences meeting the characteristic. One of these 2:
"instancesUnsignedInt" : "<unsignedInt>",
"instancesRange" : { Range },
// duration[x]: Length of time in which the characteristic is met. One of these 2:
"durationDuration" : { Duration },
"durationRange" : { Range },
"period" : { Period }, // Period over which characteristic is tested
"timing" : [{ RelativeTime }] // Timing in which the characteristic is determined
}],
"
"
"
"
"member" : [{ // Who or what is in group
"entity" : { Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|
HealthcareService|Location|Medication|MedicinalProductDefinition|
NutritionProduct|Organization|Patient|Practitioner|PractitionerRole|
RelatedPerson|Specimen|Substance|SubstanceDefinition) }, // R! Reference to the group member
"involvement" : [{ CodeableConcept }], // Code that describes how user is part of the group
"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:;[ a fhir:Group; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir: ] fhir: ] fhir: fhir: ], ...; fhir: fhir: fhir: fhir: ], ...;# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:url [ uri ] ; # 0..1 Canonical identifier for this Group, represented as an absolute URI (globally unique) fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business Identifier for this Group fhir:version [ string ] ; # 0..1 Business version of the Group # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2 fhir:versionAlgorithm [ a fhir:String ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 Label for Group fhir:title [ string ] ; # 0..1 Name for this Group (human friendly) fhir:status [ code ] ; # 0..1 draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher fhir:description [ markdown ] ; # 0..1 Natural language description of the group fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support fhir:purpose [ markdown ] ; # 0..1 Why this Group is defined fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:type [ code ] ; # 0..1 I person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen | medication | medicinalproductdefinition | substance | substancedefinition | biologicallyDerivedProduct | nutritionProduct fhir:membership [ code ] ; # 1..1 I definitional | conceptual | enumerated fhir:code [ CodeableConcept ] ; # 0..1 Use of the Group (and by implication, kind of members) fhir:quantity [ unsignedInt ] ; # 0..1 Number of members fhir:managingEntity [ Reference(Organization|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Entity that is the custodian of the Group's definition fhir:combinationMethod [ code ] ; # 0..1 all-of | any-of | at-least | at-most | except-subset fhir:combinationThreshold [ positiveInt ] ; # 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used fhir:characteristic ( [ # 0..* Include / Exclude group members by Trait fhir:code [ CodeableConcept ] ; # 1..1 Kind of characteristic # value[x] : 1..1 Value held by characteristic. One of these 7 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Boolean ; boolean ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Reference ; Reference ] fhir:value [ a fhir:Uri ; uri ] fhir:value [ a fhir:Expression ; Expression ] fhir:exclude [ boolean ] ; # 1..1 Group includes or excludes fhir:description [ markdown ] ; # 0..1 Natural language description of the characteristic fhir:method ( [ CodeableConcept ] ... ) ; # 0..* Method for how the characteristic value was determined fhir:formula [ Expression ] ; # 0..1 Formal algorithm to derive the value fhir:determiner [ Reference(Device|DeviceDefinition|Organization|Practitioner|PractitionerRole) ] ; # 0..1 Who determines the value fhir:offset [ CodeableConcept ] ; # 0..1 Reference point for comparison # instances[x] : 0..1 Number of occurrences meeting the characteristic. One of these 2 fhir:instances [ a fhir:UnsignedInt ; unsignedInt ] fhir:instances [ a fhir:Range ; Range ] # duration[x] : 0..1 Length of time in which the characteristic is met. One of these 2 fhir:duration [ a fhir:Duration ; Duration ] fhir:duration [ a fhir:Range ; Range ] fhir:period [ Period ] ; # 0..1 Period over which characteristic is tested fhir:timing ( [ RelativeTime ] ... ) ; # 0..* Timing in which the characteristic is determined ] ... ) ; fhir:member ( [ # 0..* Who or what is in group fhir:entity [ Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|HealthcareService|Location| Medication|MedicinalProductDefinition|NutritionProduct|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson|Specimen|Substance| SubstanceDefinition) ] ; # 1..1 Reference to the group member fhir:involvement ( [ CodeableConcept ] ... ) ; # 0..* Code that describes how user is part of the group fhir:period [ Period ] ; # 0..1 Period member belonged to the group fhir:inactive [ boolean ] ; # 0..1 If member is no longer in group ] ... ) ; ]
Changes
since
DSTU2
from
both
R4
and
R4B
| Group | |
|
|
|
| Group.version |
|
| Group.versionAlgorithm[x] |
|
| Group.title |
|
| Group.status |
|
| Group.experimental |
|
| Group.date |
|
| Group.publisher |
|
| Group.contact |
|
| Group.description |
|
| Group.useContext |
|
| Group.purpose |
|
| Group.copyright |
|
| Group.copyrightLabel |
|
| Group.type |
|
| Group.membership |
|
| Group.code |
|
| Group.combinationMethod |
|
| Group.combinationThreshold |
|
| Group.characteristic.value[x] |
|
| Group.characteristic.description |
|
| Group.characteristic.method |
|
| Group.characteristic.formula |
|
| Group.characteristic.determiner |
|
| Group.characteristic.offset |
|
| Group.characteristic.instances[x] |
|
| Group.characteristic.duration[x] |
|
| Group.characteristic.timing |
|
| Group.member.entity |
|
| Group.member.involvement |
|
| Group.active |
|
| Group.actual |
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R2
<-->
R3
Conversion
Maps
(status
=
2
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
all
r3
resources
are
valid.).
for
R4B
as
XML
or
JSON
.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
|
DomainResource |
Group
of
multiple
entities
+ Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension Interfaces Implemented: CanonicalResource |
|
|
Σ C | 0..1 | uri |
Canonical
identifier
for
this
Group,
represented
as
an
absolute
URI
(globally
unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic |
|
Σ | 0..* | Identifier |
Business
Identifier
for
this
Group
|
|
Σ | 0..1 | string |
Business
version
of
the
Group
|
![]() ![]() | Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) | |
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() | Coding | |||
![]() ![]() | Σ | 0..1 | string |
Label
for
Group
|
![]() ![]() | Σ | 0..1 | string |
Name
for
this
Group
(human
friendly)
|
![]() ![]() | ?! Σ | 0..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( Required ) |
![]() ![]() | Σ | 0..1 | boolean |
For
testing
only
-
never
for
real
usage
|
| Σ | 0..1 | dateTime |
Date
last
changed
|
![]() ![]() | Σ | 0..1 | string |
Name
of
the
publisher/steward
(organization
or
individual)
|
![]() ![]() | Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
![]() ![]() | 0..1 | markdown |
Natural
language
description
of
the
group
| |
![]() ![]() | Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
![]() ![]() | 0..1 | markdown |
Why
this
| |
![]() ![]() | 0..1 | markdown |
Notice
about
intellectual
property
ownership,
can
include
restrictions
on
use
|
|
|
T
|
0..1 | string |
Copyright
holder
and
year(s)
|
| Σ C | 0..1 | code |
person
|
animal
|
practitioner
|
device
|
careteam
|
healthcareservice
|
location
|
organization
|
relatedperson
|
specimen
|
medication
|
medicinalproductdefinition
|
substance
|
substancedefinition
|
biologicallyDerivedProduct
|
nutritionProduct
|
|
Σ
|
1..1 |
|
definitional
|
conceptual
|
enumerated
Binding: Group Membership Basis ( Required ) |
|
Σ | 0..1 | CodeableConcept |
Use
of
the
Group
Binding: Group Code ( Extensible ) |
|
Σ | 0..1 |
unsignedInt
|
Number
of
members
|
![]() ![]() |
Σ | 0..1 | Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole ) |
Entity
that
is
the
custodian
of
the
Group's
definition
|
|
?! Σ | 0..1 |
code
|
all-of
|
any-of
|
at-least
|
at-most
|
except-subset
Binding: Group Characteristic Combination ( Required ) |
![]() ![]() |
|
0..1 | positiveInt |
Provides
the
value
of
|
|
Σ | 0..* | BackboneElement |
Include
/
Exclude
group
members
by
Trait
|
|
Σ | 1..1 | CodeableConcept |
Kind
of
characteristic
Binding: Example Characterist ic Codes ( Example ) |
|
Σ | 1..1 |
Value
held
by
characteristic
|
|
|
CodeableConcept | |||
|
boolean | |||
|
Quantity | |||
|
Range | |||
| Reference () | |||
| uri | |||
|
|
Expression | ||
![]() ![]() ![]() | Σ | 1..1 | boolean |
Group
includes
or
excludes
|
| 0..1 | markdown |
Natural
language
description
of
the
characteristic
| |
![]() ![]()
|
0..* | CodeableConcept |
Method
for
how
the
characteristic
value
was
determined
Binding: Definition Method ( Example ) | |
![]() ![]() ![]() | 0..1 | Expression |
Formal
algorithm
to
derive
the
value
| |
![]() ![]() ![]() | 0..1 | Reference ( Practitioner | PractitionerRole | Organization | Device | DeviceDefinition ) |
Who
determines
the
value
| |
![]() ![]() ![]() | ?! Σ | 0..1 | CodeableConcept |
Reference
point
for
comparison
Binding: Characteristic Offset ( Example ) |
![]() ![]() ![]() | C | 0..1 |
Number
of
occurrences
meeting
the
characteristic
+ Rule: Ranges have to be positive | |
![]() ![]() ![]() ![]() | unsignedInt | |||
![]() ![]() ![]() ![]() | Range | |||
![]() ![]() ![]() | 0..1 |
Length
of
time
in
which
the
characteristic
is
met
| ||
![]() ![]() ![]() ![]() | Duration | |||
![]() ![]() ![]() ![]() | Range | |||
![]() ![]() ![]() | 0..1 | Period |
Period
over
which
characteristic
is
tested
|
|
|
0..* |
|
Timing
in
which
the
characteristic
is
determined
|
|
|
0..* | BackboneElement |
Who
or
what
is
in
group
|
|
|
1..1 |
Reference
(
CareTeam
|
Device
|
Group
|
HealthcareService
|
Location
|
Organization
|
Patient
|
Practitioner
|
|
Reference
to
the
group
member
|
|
|
0..* | CodeableConcept |
Code
that
describes
how
user
is
part
of
the
group
Binding: Group Involvement ( Example ) |
|
| 0..1 | Period |
Period
member
belonged
to
the
group
|
|
|
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"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> < < < <</code> < < < <</code> <</value[x]> <<url value="[uri]"/><!-- 0..1 Canonical identifier for this Group, represented as an absolute URI (globally unique) --> <identifier><!-- 0..* Identifier Business Identifier for this Group --></identifier> <version value="[string]"/><!-- 0..1 Business version of the Group --> <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- 0..1 Label for Group --> <title value="[string]"/><!-- 0..1 Name for this Group (human friendly) --> <status value="[code]"/><!-- 0..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the group --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <purpose value="[markdown]"/><!-- 0..1 Why this Group is defined --> <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <type value="[code]"/><!-- I 0..1 person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen | medication | medicinalproductdefinition | substance | substancedefinition | biologicallyDerivedProduct | nutritionProduct --> <membership value="[code]"/><!-- I 1..1 definitional | conceptual | enumerated --> <code><!-- 0..1 CodeableConcept Use of the Group (and by implication, kind of members) --></code> <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> <combinationMethod value="[code]"/><!-- 0..1 all-of | any-of | at-least | at-most | except-subset --> <combinationThreshold value="[positiveInt]"/><!-- 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used --> <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|uri| Expression Value held by characteristic --></value[x]> <exclude value="[boolean]"/><!-- 1..1 Group includes or excludes --> <description value="[markdown]"/><!-- 0..1 Natural language description of the characteristic --> <method><!-- 0..* CodeableConcept Method for how the characteristic value was determined --></method> <formula><!-- 0..1 Expression Formal algorithm to derive the value --></formula> <determiner><!-- 0..1 Reference(Device|DeviceDefinition|Organization| Practitioner|PractitionerRole) Who determines the value --></determiner> <offset><!-- 0..1 CodeableConcept Reference point for comparison --></offset> <instances[x]><!-- 0..1 unsignedInt|Range Number of occurrences meeting the characteristic --></instances[x]> <duration[x]><!-- 0..1 Duration|Range Length of time in which the characteristic is met --></duration[x]> <period><!-- 0..1 Period Period over which characteristic is tested --></period> <timing><!-- 0..* RelativeTime Timing in which the characteristic is determined --></timing> </characteristic>< <</entity><member> <!-- 0..* Who or what is in group --> <entity><!-- 1..1 Reference(BiologicallyDerivedProduct|CareTeam|Device|Group| HealthcareService|Location|Medication|MedicinalProductDefinition| NutritionProduct|Organization|Patient|Practitioner|PractitionerRole| RelatedPerson|Specimen|Substance|SubstanceDefinition) Reference to the group member --></entity> <involvement><!-- 0..* CodeableConcept Code that describes how user is part of the group --></involvement> <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" : "",
"resourceType" : "Group",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
"
"
"
" },
">,
" },
" },
"
"
"url" : "<uri>", // Canonical identifier for this Group, represented as an absolute URI (globally unique)
"identifier" : [{ Identifier }], // Business Identifier for this Group
"version" : "<string>", // Business version of the Group
// versionAlgorithm[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>",
"versionAlgorithmCoding" : { Coding },
"name" : "<string>", // Label for Group
"title" : "<string>", // Name for this Group (human friendly)
"status" : "<code>", // draft | active | retired | unknown
"experimental" : <boolean>, // For testing only - never for real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the group
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"purpose" : "<markdown>", // Why this Group is defined
"copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"type" : "<code>", // I person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen | medication | medicinalproductdefinition | substance | substancedefinition | biologicallyDerivedProduct | nutritionProduct
"membership" : "<code>", // I R! definitional | conceptual | enumerated
"code" : { CodeableConcept }, // Use of the Group (and by implication, kind of members)
"quantity" : "<unsignedInt>", // Number of members
"managingEntity" : { Reference(Organization|Practitioner|PractitionerRole|
RelatedPerson) }, // Entity that is the custodian of the Group's definition
"combinationMethod" : "<code>", // all-of | any-of | at-least | at-most | except-subset
"combinationThreshold" : "<positiveInt>", // Provides the value of "n" when "at-least" or "at-most" codes are used
"characteristic" : [{ // Include / Exclude group members by Trait
"code" : { CodeableConcept }, // R! Kind of characteristic
// value[x]: Value held by characteristic. One of these 7:
"valueCodeableConcept" : { CodeableConcept },
"valueBoolean" : <boolean>,
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueReference" : { Reference },
"valueUri" : "<uri>",
"valueExpression" : { Expression },
"exclude" : <boolean>, // R! Group includes or excludes
"description" : "<markdown>", // Natural language description of the characteristic
"method" : [{ CodeableConcept }], // Method for how the characteristic value was determined
"formula" : { Expression }, // Formal algorithm to derive the value
"determiner" : { Reference(Device|DeviceDefinition|Organization|
Practitioner|PractitionerRole) }, // Who determines the value
"offset" : { CodeableConcept }, // Reference point for comparison
// instances[x]: Number of occurrences meeting the characteristic. One of these 2:
"instancesUnsignedInt" : "<unsignedInt>",
"instancesRange" : { Range },
// duration[x]: Length of time in which the characteristic is met. One of these 2:
"durationDuration" : { Duration },
"durationRange" : { Range },
"period" : { Period }, // Period over which characteristic is tested
"timing" : [{ RelativeTime }] // Timing in which the characteristic is determined
}],
"
"
"
"
"member" : [{ // Who or what is in group
"entity" : { Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|
HealthcareService|Location|Medication|MedicinalProductDefinition|
NutritionProduct|Organization|Patient|Practitioner|PractitionerRole|
RelatedPerson|Specimen|Substance|SubstanceDefinition) }, // R! Reference to the group member
"involvement" : [{ CodeableConcept }], // Code that describes how user is part of the group
"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:;[ a fhir:Group; fhir:nodeRole fhir:treeRoot; # if this is the parser root# from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir: ] fhir: ] fhir: fhir: ], ...; fhir: fhir: fhir: fhir: ], ...;# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:url [ uri ] ; # 0..1 Canonical identifier for this Group, represented as an absolute URI (globally unique) fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business Identifier for this Group fhir:version [ string ] ; # 0..1 Business version of the Group # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2 fhir:versionAlgorithm [ a fhir:String ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 Label for Group fhir:title [ string ] ; # 0..1 Name for this Group (human friendly) fhir:status [ code ] ; # 0..1 draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher fhir:description [ markdown ] ; # 0..1 Natural language description of the group fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support fhir:purpose [ markdown ] ; # 0..1 Why this Group is defined fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:type [ code ] ; # 0..1 I person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen | medication | medicinalproductdefinition | substance | substancedefinition | biologicallyDerivedProduct | nutritionProduct fhir:membership [ code ] ; # 1..1 I definitional | conceptual | enumerated fhir:code [ CodeableConcept ] ; # 0..1 Use of the Group (and by implication, kind of members) fhir:quantity [ unsignedInt ] ; # 0..1 Number of members fhir:managingEntity [ Reference(Organization|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Entity that is the custodian of the Group's definition fhir:combinationMethod [ code ] ; # 0..1 all-of | any-of | at-least | at-most | except-subset fhir:combinationThreshold [ positiveInt ] ; # 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used fhir:characteristic ( [ # 0..* Include / Exclude group members by Trait fhir:code [ CodeableConcept ] ; # 1..1 Kind of characteristic # value[x] : 1..1 Value held by characteristic. One of these 7 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Boolean ; boolean ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Reference ; Reference ] fhir:value [ a fhir:Uri ; uri ] fhir:value [ a fhir:Expression ; Expression ] fhir:exclude [ boolean ] ; # 1..1 Group includes or excludes fhir:description [ markdown ] ; # 0..1 Natural language description of the characteristic fhir:method ( [ CodeableConcept ] ... ) ; # 0..* Method for how the characteristic value was determined fhir:formula [ Expression ] ; # 0..1 Formal algorithm to derive the value fhir:determiner [ Reference(Device|DeviceDefinition|Organization|Practitioner|PractitionerRole) ] ; # 0..1 Who determines the value fhir:offset [ CodeableConcept ] ; # 0..1 Reference point for comparison # instances[x] : 0..1 Number of occurrences meeting the characteristic. One of these 2 fhir:instances [ a fhir:UnsignedInt ; unsignedInt ] fhir:instances [ a fhir:Range ; Range ] # duration[x] : 0..1 Length of time in which the characteristic is met. One of these 2 fhir:duration [ a fhir:Duration ; Duration ] fhir:duration [ a fhir:Range ; Range ] fhir:period [ Period ] ; # 0..1 Period over which characteristic is tested fhir:timing ( [ RelativeTime ] ... ) ; # 0..* Timing in which the characteristic is determined ] ... ) ; fhir:member ( [ # 0..* Who or what is in group fhir:entity [ Reference(BiologicallyDerivedProduct|CareTeam|Device|Group|HealthcareService|Location| Medication|MedicinalProductDefinition|NutritionProduct|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson|Specimen|Substance| SubstanceDefinition) ] ; # 1..1 Reference to the group member fhir:involvement ( [ CodeableConcept ] ... ) ; # 0..* Code that describes how user is part of the group fhir:period [ Period ] ; # 0..1 Period member belonged to the group fhir:inactive [ boolean ] ; # 0..1 If member is no longer in group ] ... ) ; ]
Changes
since
DSTU2
from
both
R4
and
R4B
| Group | |
|
|
|
| Group.version |
|
| Group.versionAlgorithm[x] |
|
| Group.title |
|
| Group.status |
|
| Group.experimental |
|
| Group.date |
|
| Group.publisher |
|
| Group.contact |
|
| Group.description |
|
| Group.useContext |
|
| Group.purpose |
|
| Group.copyright |
|
| Group.copyrightLabel |
|
| Group.type |
|
| Group.membership |
|
| Group.code |
|
| Group.combinationMethod |
|
| Group.combinationThreshold |
|
| Group.characteristic.value[x] |
|
| Group.characteristic.description |
|
| Group.characteristic.method |
|
| Group.characteristic.formula |
|
| Group.characteristic.determiner |
|
| Group.characteristic.offset |
|
| Group.characteristic.instances[x] |
|
| Group.characteristic.duration[x] |
|
| Group.characteristic.timing |
|
| Group.member.entity |
|
| Group.member.involvement |
|
| Group.active |
|
| Group.actual |
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
See
R2
<-->
R3
Conversion
Maps
(status
=
2
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
all
r3
resources
are
valid.).
for
R4B
as
XML
or
JSON
.
Alternate
Additional
definitions:
Master
Definition
(
XML
,
+
JSON
),
,
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| Group.versionAlgorithm[x] | VersionAlgorithm | Extensible | Indicates the mechanism used to compare versions to determine which is more current. |
| Group.status | PublicationStatus | Required | The lifecycle status of an artifact. |
| Group.type | GroupType | Required |
Types
of
resources
that
are
part
of
|
| Group.membership | GroupMembershipBasis | Required |
Basis for membership in a group |
| Group.code | GroupCode (a valid code from Group Type ) | Extensible |
A
code
that
describes
the
use
of
|
| Group.combinationMethod |
|
Required |
Logical grouping of characteristics for the Group Resource. |
| Group.characteristic.code | ExampleCharacteristicCodes | Example |
This
value
set
contains
an
example
set
of
|
| Group.characteristic.method | DefinitionMethod | Example |
The method used to define, describe, or determine a characteristic value. |
| Group.characteristic.offset | CharacteristicOffset | Example |
Reference point for characteristic.valueQuantity. |
| Group.member.involvement | GroupInvolvement | Example |
A code that describes how a member of the group participates in the group. |
| UniqueKey | Level | Location | Description | Expression |
cnl-1
| Warning | Group.url | URL should not contain | or # - these characters make processing canonical references problematic | exists() implies matches('^[^|# ]+$') |
grp-1
| Rule | Group.characteristic.instances[x] |
Ranges
have
| ($this is Range) implies ((low.empty() or ((low.code.exists() or low.value.empty()) and (low.system.empty() or low.system = %ucum) and (low.code.empty() or low.code = '1') and (low.value.empty() or low.value.hasValue().not() or low.value.toString().contains('.').not()) and (low.value.empty() or low.value.hasValue().not() or low.value >= 0))) and (high.empty() or ((high.code.exists() or high.value.empty()) and (high.system.empty() or high.system = %ucum) and (high.code.empty() or high.code = '1') and (high.value.empty() or high.value.hasValue().not() or high.value.toString().contains('.').not()) and (high.value.empty() or high.value.hasValue().not() or high.value >= 0)))) |
grp-2
| Rule | (base) |
Group.type
SHALL
be
defined
if
|
|
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
,
and
Group.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, via CapabilityStatement.rest.resource.documentation in markdown. Servers MAY impose additional membership constraints (e.g. based on modifier extensions).
Some systems may track detailed family relationship codes (e.g. child, mother, grandfather) within a group rather than merely saying "family member". There are a few options to support conveying such information:
Group.member.involvement
element.
These
SHOULD
also
be
accompanied
by
the
'family-member'
code
to
support
systems
that
might
not
understand
more
detailed
codes.
If
this
is
done,
then
the
relationship
codes
are
interpreted
as
being
with
respect
to
whichever
group
member
is
designated
as
"head
of
household"/"primary
contact".
If
there
is
no
such
group
member
explicitly
designated,
then
the
nature
of
the
more
detailed
personal
relationship
codes
cannot
reliably
be
interpreted.
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to 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 |
|
|
|
| characteristic-quantity | composite | A composite of both characteristic and quantity values |
On
Group.characteristic:
characteristic: code quantity: (value.ofType(Quantity)) | (value.ofType(Range)) |
|
| characteristic-reference | composite |
|
characteristic: code reference: value.ofType(Reference)) |
|
| characteristic-value | composite | A composite of both characteristic and value |
characteristic: code value: (value.ofType(CodeableConcept)) | (value.ofType(boolean)) |
|
| code | token | The kind of resources contained | Group.code | |
| exclude | token | Group includes or excludes | Group.characteristic.exclude | |
| experimental | token | Whether the Group is experimental | Group.experimental | |
| identifier | token | Unique id | Group.identifier | 30 Resources |
| 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
( |
|
| membership |
token
|
Definitional or enumerated group | Group.membership | |
| name | string | A portion of the Group's name | Group.name | 24 Resources |
| quantity | quantity | Quantity Value held by characteristic | (Group.characteristic.value.ofType(Quantity)) | (Group.characteristic.value.ofType(Range)) | |
| status | token | The current status of the Group | Group.status | 30 Resources |
| type | token | The type of resources the group contains | Group.type | |
| url | uri | The uri that identifies the Group | Group.url | 30 Resources |
| value | token | Value held by characteristic |
|