Group

ResourceBase · IndividualsTrial useMaturity 1

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

9 of 10 parameters tested

Structure

Show inherited elements (14)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Unique id
activeΣ	0..1	boolean	Whether this group's record is in active use
typeRequiredΣ	1..1	code	person | animal | practitioner | device | medication | substanceBinding (required): group-type
actualRequiredΣ	1..1	boolean	Descriptive or actual
codeΣ	0..1	CodeableConcept	Kind of Group members
nameΣ	0..1	string	Label for Group
quantityΣ	0..1	unsignedInt	Number of members
managingEntityΣ	0..1	Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)	Entity that is the custodian of the Group's definition
characteristic	0..*	BackboneElement	Include / Exclude group members by Trait
codeRequired	1..1	CodeableConcept	Kind of characteristic
value[x]Required	1..1	CodeableConcept | boolean | Quantity | Range | Reference	Value held by characteristic
excludeRequired	1..1	boolean	Group includes or excludes
period	0..1	Period	Period over which characteristic is tested
member	0..*	BackboneElement	Who or what is in group
entityRequired	1..1	Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)	Reference to the group member
period	0..1	Period	Period member belonged to the group
inactive	0..1	boolean	If member is no longer in group

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Group?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
actual	token	Descriptive or actual Group.actual
characteristic	token	Kind of characteristic Group.characteristic.code
characteristic-value	composite	A composite of both characteristic and value Group.characteristic
code	token	The kind of resources contained Group.code
exclude	token	Group includes or excludes Group.characteristic.exclude
identifier	token	Unique id Group.identifier
managing-entity	reference	Entity that is the custodian of the Group's definition Group.managingEntity
member	reference	Reference to the group member Group.member.entity
type	token	The type of resources the group contains Group.type
value	token	Value held by characteristic (Group.characteristic.value.ofType(CodeableConcept)) | (Group.characteristic.value.ofType(boolean))

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition