Release 5 R6 Ballot (2nd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot2: Release 6 Ballot (2nd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

FHIR Infrastructure icon Work Group   Maturity Level : 0 Trial 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 00:00+0800 as a draft by HL7.

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.

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Group 1..1 Group Group of multiple entities
. . . membership 1..1 code definitional | conceptual | enumerated
Fixed Value: definitional
. . . characteristic 1..* BackboneElement Include / 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.

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Group C icon 1..1 Group Group of multiple entities
cnl-2: Group.type SHALL be defined if Group.membership is either 'definitional' or 'enumerated'
. . . id Σ 0..1 id Logical id of this artifact
. . . meta Σ 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
. . . language 0..1 code Language of the resource content
Binding: All Languages ( required ): IETF language tag for a human language

Additional Bindings Purpose
Common Languages Starter Set
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
. . identifier . url Σ C icon 0..* 0..1 uri Canonical identifier for this Group, represented as an absolute URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Business Identifier for this Group
. . . version Σ 0..1 string Business version of the Group
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( extensible )
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name Σ 0..1 string Label for Group
. . . active title Σ 0..1 string Name for this Group (human friendly)
... status ?! Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact.

. . . experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
. . . publisher Whether Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the group
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this group's record Group is in active use defined
. . . copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... type Σ 1..1 0..1 code person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: Group Type ( required ): Types of resources that are part of group.

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


Fixed Value: definitional
. . . code Σ 0..1 CodeableConcept Kind Use of the Group members (and by implication, kind of members)
Binding: (unbound) Group Code ( example extensible ): Kind A code that describes the kind of particular resource; e.g. cow, syringe, lake, etc. group, which usually dictates what kind if entities can be in the group.

. . . name quantity Σ 0..1 string unsignedInt Label for Group Number of members
. . description . managingEntity Σ 0..1 markdown Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole ) Natural language description Entity that is the custodian of the group Group's definition
. . . quantity combinationMethod ?! Σ 0..1 unsignedInt code Number of members all-of | any-of | at-least | at-most | except-subset
Binding: Group Characteristic Combination ( required )
. . managingEntity . combinationThreshold Σ 0..1 Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole positiveInt ) Entity that is Provides the custodian value of the Group's definition "n" when "at-least" or "at-most" codes are used
. . . characteristic Σ 1..* BackboneElement Include / Exclude group members by Trait
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . code Σ 1..1 CodeableConcept Kind of characteristic
Binding: Binding Description (No ValueSet): (unbound) ( example ): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

. . . . value[x] Σ 1..1 Value held by characteristic
Binding: Binding Description (No ValueSet): (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)
. . . . . valueUri uri
..... valueExpression Expression
. . . . exclude Σ 1..1 boolean Group includes or excludes
. . . . description 0..1 markdown Natural language description of the characteristic
.... method 0..* CodeableConcept Method for how the characteristic value was determined
Binding: Definition Method ( example )
. . . . determinedBy[x] 0..1 Defines the characteristic
..... determinedByReference Reference ( Device | DeviceDefinition | DeviceMetric )
... . . period determinedByExpression Expression
. . . . offset ?! Σ 0..1 CodeableConcept Reference point for comparison
Binding: Characteristic Offset ( example )
.... instances[x] 0..1 Number of occurrences meeting the characteristic
. . . . . instancesQuantity Quantity
..... instancesRange Range
.... duration[x] 0..1 Length of time in which the characteristic is met
..... durationDuration Duration
..... durationRange Range
.... period 0..1 Period Period over which characteristic is tested
. . . . member timing 0..* RelativeTime Timing in which the characteristic is determined
... member 0..* BackboneElement Who or what is in group
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . entity 1..1 Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen ) Reference to the group member
. . . . involvement 0..* CodeableConcept Code that describes how user is part of the group
Binding: Group Involvement ( example ): A code that describes how a user is involved in the group


. . . . period 0..1 Period Period member belonged to the group
. . . . inactive 0..1 boolean If 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>
 <<a href="groupdefinition-definitions.html#Group.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 0..1 Canonical identifier for this Group, represented as an absolute URI (globally unique) -->

 <identifier><!-- I 0..* Identifier Business Identifier for this Group --></identifier>
 <
 <
 <<a href="groupdefinition-definitions.html#Group.membership" title="Basis for membership in the Group:

* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.
* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member." class="dict">
 <</code>

 <version value="[string]"/><!-- I 0..1 Business version of the Group -->
 <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions   --></versionAlgorithm[x]>

 <name value="[string]"/><!-- I 0..1 Label for Group -->
 <title value="[string]"/><!-- I 0..1 Name for this Group (human friendly) -->
 <status value="[code]"/><!-- I 0..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact>

 <description value="[markdown]"/><!-- I 0..1 Natural language description of the group -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <purpose value="[markdown]"/><!-- I 0..1 Why this Group is defined -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) -->
 <type value="[code]"/><!-- I 0..1 person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen   -->
 <membership value="[code]"/><!-- I 1..1 definitional | conceptual | enumerated   -->
 <code><!-- I 0..1 CodeableConcept Use of the Group (and by implication, kind of members)   --></code>

 <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>
 <combinationMethod value="[code]"/><!-- I 0..1 all-of | any-of | at-least | at-most | except-subset   -->
 <combinationThreshold value="[positiveInt]"/><!-- I 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used -->

 <characteristic> I 1..* BackboneElement  <!-- I 1..* Include / Exclude group members by Trait -->
  <<a href="groupdefinition-definitions.html#Group.characteristic.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

  <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|
    </value[x]>

    Range|Reference|uri|Expression Value held by characteristic --></value[x]>
  <exclude value="[boolean]"/><!-- I 1..1 Group includes or excludes -->
  <description value="[markdown]"/><!-- I 0..1 Natural language description of the characteristic -->
  <method><!-- I 0..* CodeableConcept Method for how the characteristic value was determined   --></method>
  <determinedBy[x]><!-- I 0..1 Reference(Device)|Expression 
      Defines the characteristic --></determinedBy[x]>
  <offset><!-- I 0..1 CodeableConcept Reference point for comparison   --></offset>
  <instances[x]><!-- I 0..1 Quantity|Range 
      Number of occurrences meeting the characteristic --></instances[x]>
  <duration[x]><!-- I 0..1 Duration|Range 
      Length of time in which the characteristic is met --></duration[x]>

  <period><!-- I 0..1 Period 
      Period over which characteristic is tested --></period>
  <timing><!-- I 0..* RelativeTime 
      Timing in which the characteristic is determined --></timing>

 </characteristic>
 <member> I 0..* BackboneElement  <!-- I 0..* Who or what is in group -->
  <<a href="groupdefinition-definitions.html#Group.member.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

  <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>
  <involvement><!-- I 0..* CodeableConcept Code that describes how user is part of the group   --></involvement>

  <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
    "<a href="groupdefinition-definitions.html#Group.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">

    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // ICanonical identifier for this Group, represented as an absolute URI (globally unique)

    "identifier" : [{ Identifier }], // IBusiness Identifier for this Group
    "
    "
    "<a href="groupdefinition-definitions.html#Group.membership" title="Basis for membership in the Group:

* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.
* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member" class="dict"> 
    "

    "version" : "<string>", // IBusiness version of the Group
  // value[x]: How to compare versions. One of these 2:

    "versionAlgorithmString" : "<string>", // IHow to compare versions
    "versionAlgorithmCoding" : { Coding }, // IHow to compare versions

    "name" : "<string>", // ILabel for Group
    "title" : "<string>", // IName for this Group (human friendly)
    "status" : "<code>", // Idraft | active | retired | unknown
    "experimental" : <boolean>, // IFor testing purposes, not real usage
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher

    "description" : "<markdown>", // INatural language description of the group
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "purpose" : "<markdown>", // IWhy this Group is defined
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "copyrightLabel" : "<string>", // ICopyright holder and year(s)
    "type" : "<code>", // Iperson | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
    "membership" : "definitional", // I R! 
    "code" : { CodeableConcept }, // IUse of the Group (and by implication, kind of members)

    "quantity" : "<unsignedInt>", // INumber of members
    "managingEntity" : { Reference(Organization) }, // IEntity that is the custodian of the Group's definition
    "combinationMethod" : "<code>", // Iall-of | any-of | at-least | at-most | except-subset
    "combinationThreshold" : "<positiveInt>", // IProvides the value of "n" when "at-least" or "at-most" codes are used

    "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.

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Group 1..1 Group Group of multiple entities
. . . membership 1..1 code definitional | conceptual | enumerated
Fixed Value: definitional
. . . characteristic 1..* BackboneElement Include / 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.

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Group C icon 1..1 Group Group of multiple entities
cnl-2: Group.type SHALL be defined if Group.membership is either 'definitional' or 'enumerated'
. . . id Σ 0..1 id Logical id of this artifact
. . . meta Σ 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
. . . language 0..1 code Language of the resource content
Binding: All Languages ( required ): IETF language tag for a human language

Additional Bindings Purpose
Common Languages Starter Set
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
. . identifier . url Σ C icon 0..* 0..1 uri Canonical identifier for this Group, represented as an absolute URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Business Identifier for this Group
. . . version Σ 0..1 string Business version of the Group
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( extensible )
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name Σ 0..1 string Label for Group
. . . active title Σ 0..1 string Name for this Group (human friendly)
... status ?! Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact.

. . . experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Whether Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the group
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this group's record Group is in active use defined
. . . copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... type Σ 1..1 0..1 code person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: Group Type ( required ): Types of resources that are part of group.

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


Fixed Value: definitional
. . . code Σ 0..1 CodeableConcept Kind Use of the Group members (and by implication, kind of members)
Binding: (unbound) Group Code ( example extensible ): Kind A code that describes the kind of particular resource; e.g. cow, syringe, lake, etc. group, which usually dictates what kind if entities can be in the group.

. . . name quantity Σ 0..1 string unsignedInt Label for Group Number of members
. . description . managingEntity Σ 0..1 markdown Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole ) Natural language description Entity that is the custodian of the group Group's definition
. . . quantity combinationMethod ?! Σ 0..1 unsignedInt code Number of members all-of | any-of | at-least | at-most | except-subset
Binding: Group Characteristic Combination ( required )
. . managingEntity . combinationThreshold Σ 0..1 Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole positiveInt ) Entity that is Provides the custodian value of the Group's definition "n" when "at-least" or "at-most" codes are used
. . . characteristic Σ 1..* BackboneElement Include / Exclude group members by Trait
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . code Σ 1..1 CodeableConcept Kind of characteristic
Binding: Binding Description (No ValueSet): (unbound) ( example ): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

. . . . value[x] Σ 1..1 Value held by characteristic
Binding: Binding Description (No ValueSet): (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)
. . . . . valueUri uri
..... valueExpression Expression
. . . . exclude Σ 1..1 boolean Group includes or excludes
. . . . description 0..1 markdown Natural language description of the characteristic
.... method 0..* CodeableConcept Method for how the characteristic value was determined
Binding: Definition Method ( example )
. . . . determinedBy[x] 0..1 Defines the characteristic
..... determinedByReference Reference ( Device | DeviceDefinition | DeviceMetric )
... . . period determinedByExpression Expression
. . . . offset ?! Σ 0..1 CodeableConcept Reference point for comparison
Binding: Characteristic Offset ( example )
.... instances[x] 0..1 Number of occurrences meeting the characteristic
..... instancesQuantity Quantity
..... instancesRange Range
.... duration[x] 0..1 Length of time in which the characteristic is met
..... durationDuration Duration
..... durationRange Range
.... period 0..1 Period Period over which characteristic is tested
. . . . member timing 0..* RelativeTime Timing in which the characteristic is determined
... member 0..* BackboneElement Who or what is in group
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . entity 1..1 Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen ) Reference to the group member
. . . . involvement 0..* CodeableConcept Code that describes how user is part of the group
Binding: Group Involvement ( example ): A code that describes how a user is involved in the group


. . . . period 0..1 Period Period member belonged to the group
. . . . inactive 0..1 boolean If 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>
 <<a href="groupdefinition-definitions.html#Group.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 0..1 Canonical identifier for this Group, represented as an absolute URI (globally unique) -->

 <identifier><!-- I 0..* Identifier Business Identifier for this Group --></identifier>
 <
 <
 <<a href="groupdefinition-definitions.html#Group.membership" title="Basis for membership in the Group:

* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.
* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member." class="dict">
 <</code>

 <version value="[string]"/><!-- I 0..1 Business version of the Group -->
 <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions   --></versionAlgorithm[x]>

 <name value="[string]"/><!-- I 0..1 Label for Group -->
 <title value="[string]"/><!-- I 0..1 Name for this Group (human friendly) -->
 <status value="[code]"/><!-- I 0..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact>

 <description value="[markdown]"/><!-- I 0..1 Natural language description of the group -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <purpose value="[markdown]"/><!-- I 0..1 Why this Group is defined -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) -->
 <type value="[code]"/><!-- I 0..1 person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen   -->
 <membership value="[code]"/><!-- I 1..1 definitional | conceptual | enumerated   -->
 <code><!-- I 0..1 CodeableConcept Use of the Group (and by implication, kind of members)   --></code>

 <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>
 <combinationMethod value="[code]"/><!-- I 0..1 all-of | any-of | at-least | at-most | except-subset   -->
 <combinationThreshold value="[positiveInt]"/><!-- I 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used -->

 <characteristic> I 1..* BackboneElement  <!-- I 1..* Include / Exclude group members by Trait -->
  <<a href="groupdefinition-definitions.html#Group.characteristic.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

  <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|
    </value[x]>

    Range|Reference|uri|Expression Value held by characteristic --></value[x]>
  <exclude value="[boolean]"/><!-- I 1..1 Group includes or excludes -->
  <description value="[markdown]"/><!-- I 0..1 Natural language description of the characteristic -->
  <method><!-- I 0..* CodeableConcept Method for how the characteristic value was determined   --></method>
  <determinedBy[x]><!-- I 0..1 Reference(Device)|Expression 
      Defines the characteristic --></determinedBy[x]>
  <offset><!-- I 0..1 CodeableConcept Reference point for comparison   --></offset>
  <instances[x]><!-- I 0..1 Quantity|Range 
      Number of occurrences meeting the characteristic --></instances[x]>
  <duration[x]><!-- I 0..1 Duration|Range 
      Length of time in which the characteristic is met --></duration[x]>

  <period><!-- I 0..1 Period 
      Period over which characteristic is tested --></period>
  <timing><!-- I 0..* RelativeTime 
      Timing in which the characteristic is determined --></timing>

 </characteristic>
 <member> I 0..* BackboneElement  <!-- I 0..* Who or what is in group -->
  <<a href="groupdefinition-definitions.html#Group.member.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>

  <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>
  <involvement><!-- I 0..* CodeableConcept Code that describes how user is part of the group   --></involvement>

  <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
    "<a href="groupdefinition-definitions.html#Group.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">

    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // ICanonical identifier for this Group, represented as an absolute URI (globally unique)

    "identifier" : [{ Identifier }], // IBusiness Identifier for this Group
    "
    "
    "<a href="groupdefinition-definitions.html#Group.membership" title="Basis for membership in the Group:

* 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.
* 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member" class="dict"> 
    "

    "version" : "<string>", // IBusiness version of the Group
  // value[x]: How to compare versions. One of these 2:

    "versionAlgorithmString" : "<string>", // IHow to compare versions
    "versionAlgorithmCoding" : { Coding }, // IHow to compare versions

    "name" : "<string>", // ILabel for Group
    "title" : "<string>", // IName for this Group (human friendly)
    "status" : "<code>", // Idraft | active | retired | unknown
    "experimental" : <boolean>, // IFor testing purposes, not real usage
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher

    "description" : "<markdown>", // INatural language description of the group
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "purpose" : "<markdown>", // IWhy this Group is defined
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "copyrightLabel" : "<string>", // ICopyright holder and year(s)
    "type" : "<code>", // Iperson | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
    "membership" : "definitional", // I R! 
    "code" : { CodeableConcept }, // IUse of the Group (and by implication, kind of members)

    "quantity" : "<unsignedInt>", // INumber of members
    "managingEntity" : { Reference(Organization) }, // IEntity that is the custodian of the Group's definition
    "combinationMethod" : "<code>", // Iall-of | any-of | at-least | at-most | except-subset
    "combinationThreshold" : "<positiveInt>", // IProvides the value of "n" when "at-least" or "at-most" codes are used

    "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

Path Name Conformance ValueSet
Group.language All Languages required All Languages
Group.type Group.versionAlgorithm[x] Version Algorithm extensible Group Type Version Algorithm
Group.status PublicationStatus required PublicationStatus
Group.type Group Type required Group Type
Group.membership Group Membership Basis required Group Membership Basis
Group.code ?ext Group Code extensible example Group Code
Group.combinationMethod Group Characteristic Combination required Group Characteristic Combination
Group.characteristic.code ?ext example
Group.characteristic.value[x] ?ext example
Group.characteristic.method Definition Method example Definition Method
Group.characteristic.offset Characteristic Offset example Characteristic Offset
Group.member.involvement Group Involvement example Group Involvement
. .