Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

8.3.12.6 StructureDefinition: GroupDefinition

FHIR Infrastructure icon Work Group Maturity Level: 0Trial Use Use Context: Any

The canonical 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 Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

8.3.12.6.1 Formal Views of Profile Content

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

This structure is derived from Group.

Summary

Mandatory: 2 elements
Fixed Value: 1 element

This indicates the differences between this profile and the base Group structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 1..1GroupGroup of multiple entities
... membership 1..1codedefinitional | enumerated
Fixed Value: definitional
... characteristic 1..*BackboneElementInclude / Exclude group members by Trait

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Group structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 1..1GroupGroup of multiple entities
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for this Group
... active ?!Σ0..1booleanWhether this group's record is in active use
... type Σ1..1codeperson | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: Group Type (required): Types of resources that are part of group.

... membership Σ1..1codedefinitional | enumerated
Binding: Group Membership Basis (required): The basis for membership in a group


Fixed Value: definitional
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name Σ0..1stringLabel for Group
... description 0..1markdownNatural language description of the group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... characteristic Σ1..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

.... value[x] Σ1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude Σ1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member 0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity 1..1Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen)Reference to the group member
.... period 0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco Documentation for this format icon
<!-- GroupDefinition -->doco

<Group xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier Business Identifier for this Group --></identifier>
 <active value="[boolean]"/><!-- I 0..1 Whether this group's record is in active use -->
 <type value="[code]"/><!-- I 1..1 person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen   -->
 <membership value="[code]"/><!-- I 1..1 definitional | enumerated   -->
 <code><!-- I 0..1 CodeableConcept Kind of Group members --></code>
 <name value="[string]"/><!-- I 0..1 Label for Group -->
 <description value="[markdown]"/><!-- I 0..1 Natural language description of the group -->
 <quantity value="[unsignedInt]"/><!-- I 0..1 Number of members -->
 <managingEntity><!-- I 0..1 Reference(Organization) 
     Entity that is the custodian of the Group's definition --></managingEntity>
 <characteristic> I 1..* BackboneElement  <!-- I 1..* Include / Exclude group members by Trait -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 1..1 CodeableConcept 
      Kind of characteristic --></code>
  <value[x]><!-- I 1..1 CodeableConcept|boolean|Quantity|
    Range|Reference Value held by characteristic --></value[x]>
  <exclude value="[boolean]"/><!-- I 1..1 Group includes or excludes -->
  <period><!-- I 0..1 Period 
      Period over which characteristic is tested --></period>
 </characteristic>
 <member> I 0..* BackboneElement  <!-- I 0..* Who or what is in group -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <entity><!-- I 1..1 Reference(CareTeam) Reference to the group member --></entity>
  <period><!-- I 0..1 Period Period member belonged to the group --></period>
  <inactive value="[boolean]"/><!-- I 0..1 If member is no longer in group -->
 </member>
</Group>

{ // GroupDefinition
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : [{ Identifier }], // IBusiness Identifier for this Group
    "active" : <boolean>, // IWhether this group's record is in active use
    "type" : "<code>", // I R! person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
    "membership" : "definitional", // I R! 
    "code" : { CodeableConcept }, // IKind of Group members
    "name" : "<string>", // ILabel for Group
    "description" : "<markdown>", // INatural language description of the group
    "quantity" : "<unsignedInt>", // INumber of members
    "managingEntity" : { Reference(Organization) }, // IEntity that is the custodian of the Group's definition
    "characteristic" : [{ BackboneElement }], // I R! Include / Exclude group members by Trait
    "member" : [{ BackboneElement }] // IWho or what is in group
  }

This structure is derived from Group.

Summary

Mandatory: 2 elements
Fixed Value: 1 element

Differential View

This indicates the differences between this profile and the base Group structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 1..1GroupGroup of multiple entities
... membership 1..1codedefinitional | enumerated
Fixed Value: definitional
... characteristic 1..*BackboneElementInclude / Exclude group members by Trait

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Group structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 1..1GroupGroup of multiple entities
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for this Group
... active ?!Σ0..1booleanWhether this group's record is in active use
... type Σ1..1codeperson | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: Group Type (required): Types of resources that are part of group.

... membership Σ1..1codedefinitional | enumerated
Binding: Group Membership Basis (required): The basis for membership in a group


Fixed Value: definitional
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name Σ0..1stringLabel for Group
... description 0..1markdownNatural language description of the group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... characteristic Σ1..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

.... value[x] Σ1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude Σ1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member 0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity 1..1Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen)Reference to the group member
.... period 0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco Documentation for this format icon

XML Template

<!-- GroupDefinition -->doco

<Group xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier Business Identifier for this Group --></identifier>
 <active value="[boolean]"/><!-- I 0..1 Whether this group's record is in active use -->
 <type value="[code]"/><!-- I 1..1 person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen   -->
 <membership value="[code]"/><!-- I 1..1 definitional | enumerated   -->
 <code><!-- I 0..1 CodeableConcept Kind of Group members --></code>
 <name value="[string]"/><!-- I 0..1 Label for Group -->
 <description value="[markdown]"/><!-- I 0..1 Natural language description of the group -->
 <quantity value="[unsignedInt]"/><!-- I 0..1 Number of members -->
 <managingEntity><!-- I 0..1 Reference(Organization) 
     Entity that is the custodian of the Group's definition --></managingEntity>
 <characteristic> I 1..* BackboneElement  <!-- I 1..* Include / Exclude group members by Trait -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 1..1 CodeableConcept 
      Kind of characteristic --></code>
  <value[x]><!-- I 1..1 CodeableConcept|boolean|Quantity|
    Range|Reference Value held by characteristic --></value[x]>
  <exclude value="[boolean]"/><!-- I 1..1 Group includes or excludes -->
  <period><!-- I 0..1 Period 
      Period over which characteristic is tested --></period>
 </characteristic>
 <member> I 0..* BackboneElement  <!-- I 0..* Who or what is in group -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <entity><!-- I 1..1 Reference(CareTeam) Reference to the group member --></entity>
  <period><!-- I 0..1 Period Period member belonged to the group --></period>
  <inactive value="[boolean]"/><!-- I 0..1 If member is no longer in group -->
 </member>
</Group>

JSON Template

{ // GroupDefinition
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : [{ Identifier }], // IBusiness Identifier for this Group
    "active" : <boolean>, // IWhether this group's record is in active use
    "type" : "<code>", // I R! person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
    "membership" : "definitional", // I R! 
    "code" : { CodeableConcept }, // IKind of Group members
    "name" : "<string>", // ILabel for Group
    "description" : "<markdown>", // INatural language description of the group
    "quantity" : "<unsignedInt>", // INumber of members
    "managingEntity" : { Reference(Organization) }, // IEntity that is the custodian of the Group's definition
    "characteristic" : [{ BackboneElement }], // I R! Include / Exclude group members by Trait
    "member" : [{ BackboneElement }] // IWho or what is in group
  }

 

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

8.3.12.6.2 Terminology Bindings

PathNameConformanceValueSet
Group.languageAll LanguagesrequiredAll Languages
Group.typeGroup TyperequiredGroup Type
Group.membershipGroup Membership BasisrequiredGroup Membership Basis
Group.code?extexample
Group.characteristic.code?extexample
Group.characteristic.value[x]?extexample
. .