StructureDefinition: Group Definition

Release 4 5 Snapshot #1

This page is part of the FHIR Specification ~~(v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL).~~ (v5.0.0-snapshot1: R5 Snapshot #1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

8.3.11.2 8.3.12.6 StructureDefinition: GroupDefinition Group Definition

FHIR Infrastructure

Work Group

Maturity Level : 1 0

Trial Use

Use Context : Any

The official URL for this profile is:

http://hl7.org/fhir/StructureDefinition/groupdefinition

Enforces a descriptive group that can be used in definitional resources

This profile was published on ~~[no date]~~ Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

8.3.11.2.1 8.3.12.6.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .

Text Summary
Differential Table
Snapshot Table
XML Template
JSON Template
All

This structure is derived from Group .

Summary

Mandatory: 1 element
Fixed Value: 1 element
Prohibited: 1 element

This structure is derived from Group .

Name	Card.	Type	Description & Constraints
Group	1..1	Group	Group of multiple entities
actual	1..1	boolean	Descriptive or actual Fixed Value: false
member	0 .. 0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Group	I	1..1	Group	Group of multiple entities
id	Σ	0..1	~~string~~ id	Logical id of this artifact
meta	Σ I	0..1	Meta	Metadata about the resource
implicitRules	?! Σ I	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: Common Languages ( preferred ) Max Binding: All Languages : IETF language tag
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?! I	0..*	Extension	Extensions that cannot be ignored
identifier	Σ I	0..*	Identifier	Unique id
active	Σ I	0..1	boolean	Whether this group's record is in active use
type	Σ I	1..1	code	person \| animal \| practitioner \| device \| medication \| substance Binding: GroupType ( required ) ): Types of resources that are part of group.
actual	Σ I	1..1	boolean	Descriptive or actual Fixed Value: false
code	Σ I	0..1	CodeableConcept	Kind of Group members Binding: (unbound) ( example ) ): Kind of particular resource; e.g. cow, syringe, lake, etc.
name	Σ I	0..1	string	Label for Group
quantity	Σ I	0..1	unsignedInt	Number of members
managingEntity	Σ I	0..1	Reference ( Organization \| RelatedPerson \| Practitioner \| PractitionerRole )	Entity that is the custodian of the Group's definition
characteristic	I	0..*	BackboneElement	Include / Exclude group members by Trait
id		0..1	~~string~~ id	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?! Σ I	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	I	1..1	CodeableConcept	Kind of characteristic Binding: (unbound) ( example ) ): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
value[x]	I	1..1		Value held by characteristic Binding: (unbound) ( example ) ): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
valueCodeableConcept			CodeableConcept
valueBoolean			boolean
valueQuantity			Quantity
valueRange			Range
valueReference			Reference () (Any)
exclude	I	1..1	boolean	Group includes or excludes
period	I	0..1	Period	Period over which characteristic is tested
Documentation for this format

<!-- Group Definition -->

<Group xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

 <meta><!--  0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!--  0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!--  0..1 Language of the resource content   -->
 <text><!--  0..1 Narrative Text summary of the resource, for human interpretation --></text>
 <</contained>

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>

 <modifierExtension><!--  0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!--  0..* Identifier Unique id --></identifier>
 <active value="[boolean]"/><!--  0..1 Whether this group's record is in active use -->
 <type value="[code]"/><!--  1..1 person | animal | practitioner | device | medication | substance   -->
 <actual value="[boolean]"/><!--  1..1 Descriptive or actual -->
 <code><!--  0..1 CodeableConcept Kind of Group members --></code>
 <name value="[string]"/><!--  0..1 Label for Group -->
 <quantity value="[unsignedInt]"/><!--  0..1 Number of members -->
 <managingEntity><!--  0..1 Reference(Organization) 
     Entity that is the custodian of the Group's definition --></managingEntity>
 <

 <characteristic>  0..* BackboneElement  <!--  0..* Include / Exclude group members by Trait -->

  <modifierExtension><!--  0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!--  1..1 CodeableConcept 
      Kind of characteristic --></code>
  <value[x]><!--  1..1 CodeableConcept|boolean|Quantity|
    Range|Reference Value held by characteristic --></value[x]>
  <exclude value="[boolean]"/><!--  1..1 Group includes or excludes -->
  <period><!--  0..1 Period 
      Period over which characteristic is tested --></period>
 </characteristic>
 <

 <member>  0..0 BackboneElement  <!--  0..0 Who or what is in group -->

 </member>
</Group>

{ // Group Definition
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "

    "contained" : [{ Resource }], //Contained, inline Resources

    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "identifier" : [{ Identifier }], // C?Unique id
    "active" : <boolean>, // C?Whether this group's record is in active use
    "type" : "<code>", // C? R! person | animal | practitioner | device | medication | substance
    "actual" : false, // C? R! 
    "code" : { CodeableConcept }, // C?Kind of Group members
    "name" : "<string>", // C?Label for Group
    "quantity" : "<unsignedInt>", // C?Number of members
    "managingEntity" : { Reference(Organization) }, // C?Entity that is the custodian of the Group's definition
    "

    "characteristic" : [{ BackboneElement }] // C?Include / Exclude group members by Trait

  }

This structure is derived from Group .

Summary

Mandatory: 1 element
Fixed Value: 1 element
Prohibited: 1 element

Differential View

This structure is derived from Group .

Name	Card.	Type	Description & Constraints
Group	1..1	Group	Group of multiple entities
actual	1..1	boolean	Descriptive or actual Fixed Value: false
member	0 .. 0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Group	I	1..1	Group	Group of multiple entities
id	Σ	0..1	~~string~~ id	Logical id of this artifact
meta	Σ I	0..1	Meta	Metadata about the resource
implicitRules	?! Σ I	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: Common Languages ( preferred ) Max Binding: All Languages : IETF language tag
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?! I	0..*	Extension	Extensions that cannot be ignored
identifier	Σ I	0..*	Identifier	Unique id
active	Σ I	0..1	boolean	Whether this group's record is in active use
type	Σ I	1..1	code	person \| animal \| practitioner \| device \| medication \| substance Binding: GroupType ( required ) ): Types of resources that are part of group.
actual	Σ I	1..1	boolean	Descriptive or actual Fixed Value: false
code	Σ I	0..1	CodeableConcept	Kind of Group members Binding: (unbound) ( example ) ): Kind of particular resource; e.g. cow, syringe, lake, etc.
name	Σ I	0..1	string	Label for Group
quantity	Σ I	0..1	unsignedInt	Number of members
managingEntity	Σ I	0..1	Reference ( Organization \| RelatedPerson \| Practitioner \| PractitionerRole )	Entity that is the custodian of the Group's definition
characteristic	I	0..*	BackboneElement	Include / Exclude group members by Trait
id		0..1	~~string~~ id	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?! Σ I	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	I	1..1	CodeableConcept	Kind of characteristic Binding: (unbound) ( example ) ): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
value[x]	I	1..1		Value held by characteristic Binding: (unbound) ( example ) ): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
valueCodeableConcept			CodeableConcept
valueBoolean			boolean
valueQuantity			Quantity
valueRange			Range
valueReference			Reference () (Any)
exclude	I	1..1	boolean	Group includes or excludes
period	I	0..1	Period	Period over which characteristic is tested
Documentation for this format

XML Template

<!-- Group Definition -->

<Group xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

 <meta><!--  0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!--  0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!--  0..1 Language of the resource content   -->
 <text><!--  0..1 Narrative Text summary of the resource, for human interpretation --></text>
 <</contained>

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>

 <modifierExtension><!--  0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!--  0..* Identifier Unique id --></identifier>
 <active value="[boolean]"/><!--  0..1 Whether this group's record is in active use -->
 <type value="[code]"/><!--  1..1 person | animal | practitioner | device | medication | substance   -->
 <actual value="[boolean]"/><!--  1..1 Descriptive or actual -->
 <code><!--  0..1 CodeableConcept Kind of Group members --></code>
 <name value="[string]"/><!--  0..1 Label for Group -->
 <quantity value="[unsignedInt]"/><!--  0..1 Number of members -->
 <managingEntity><!--  0..1 Reference(Organization) 
     Entity that is the custodian of the Group's definition --></managingEntity>
 <

 <characteristic>  0..* BackboneElement  <!--  0..* Include / Exclude group members by Trait -->

  <modifierExtension><!--  0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!--  1..1 CodeableConcept 
      Kind of characteristic --></code>
  <value[x]><!--  1..1 CodeableConcept|boolean|Quantity|
    Range|Reference Value held by characteristic --></value[x]>
  <exclude value="[boolean]"/><!--  1..1 Group includes or excludes -->
  <period><!--  0..1 Period 
      Period over which characteristic is tested --></period>
 </characteristic>
 <

 <member>  0..0 BackboneElement  <!--  0..0 Who or what is in group -->

 </member>
</Group>

JSON Template

{ // Group Definition
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "

    "contained" : [{ Resource }], //Contained, inline Resources

    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "identifier" : [{ Identifier }], // C?Unique id
    "active" : <boolean>, // C?Whether this group's record is in active use
    "type" : "<code>", // C? R! person | animal | practitioner | device | medication | substance
    "actual" : false, // C? R! 
    "code" : { CodeableConcept }, // C?Kind of Group members
    "name" : "<string>", // C?Label for Group
    "quantity" : "<unsignedInt>", // C?Number of members
    "managingEntity" : { Reference(Organization) }, // C?Entity that is the custodian of the Group's definition
    "

    "characteristic" : [{ BackboneElement }] // C?Include / Exclude group members by Trait

  }

Alternate definitions: Master Definition ( XML , JSON ), Schematron

8.3.11.2.2 8.3.12.6.2 Terminology Bindings

Path	Name	Conformance	ValueSet
Group.language	Common Languages	preferred	Common Languages
Group.type	GroupType	required	GroupType
Group.code	?ext	example
Group.characteristic.code	?ext	example
Group.characteristic.value[x]	?ext	example

.

FHIR ®© HL7.org 2011+. FHIR ~~Release 4 (Technical Correction #1) (v4.0.1)~~ R5 Draft Ballot hl7.fhir.core#5.0.0-snapshot1 generated on ~~Fri, Nov 1, 2019 09:35+1100. QA Page~~ Sun, Dec 19, 2021 08:19+1100.
Links: Search | Version History | Table of Contents | ~~Credits~~ QA Page | Compare to R3 R4 | | Propose a change