This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). 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 R3 R2
StructureDefinition for group
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Group"/> <meta> <lastUpdated value="2015-04-03T14:24:32.000+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/StructureDefinition/Group"/> <name value="Group"/> <publisher value="HL7 FHIR Project (FHIR Management Group)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fhirmg/index.cfm"/> </telecom> </contact> <description value="Base StructureDefinition for Group Resource"/> <status value="draft"/> <date value="2015-04-03T14:24:32+11:00"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <type value="resource"/> <abstract value="true"/> <snapshot> <element> <path value="Group"/> <short value="Group of multiple entities"/> <definition value="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."/> <min value="1"/> <max value="1"/> <type> <code value="DomainResource"/> </type> <constraint> <key value="grp-4"/> <name value="No more members than quantity"/> <severity value="error"/> <human value="Can't have more members associated with the group than the value specified for "quantity""/> <xpath value="not(f:quantity) or not(f:member) or not(f:quantity>count(f:member))"/> </constraint> <constraint> <key value="grp-1"/> <name value="No members for non-actual"/> <severity value="error"/> <human value="Can only have members if group is "actual""/> <xpath value="f:actual/@value='true' or not(exists(f:member))"/> </constraint> <mapping> <identity value="rim"/> <map value="Entity[determinerCode="GRP" or determinerCode="GRP_KIND"]"/> </mapping> </element> <element> <path value="Group.id"/> <short value="Logical id of this artefact"/> <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="Group.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <type> <code value="Meta"/> </type> </element> <element> <path value="Group.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="true"/> </element> <element> <path value="Group.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="Language"/> <strength value="required"/> <description value="A human language"/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="Group.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="Group.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comments value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Group.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, 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."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Group.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Group.identifier"/> <short value="Unique id"/> <definition value="A unique business identifier for this group."/> <requirements value="Allows the group to be referenced."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="unique(./id[displayable="true" and scope="OBJ"])"/> </mapping> </element> <element> <path value="Group.type"/> <short value="person | animal | practitioner | device | medication | substance"/> <definition value="Identifies the broad classification of the kind of resources the group includes."/> <requirements value="Identifies what type of resources the group is made up of."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <name value="GroupType"/> <strength value="required"/> <description value="Types of resources that are part of group"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/group-type"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="person: ./classCode="PSN" animal: ./classCode="ANM" device: ./classCode=" DEV" medication: ./classCode="MMAT" and ./playedRole[isNormalRole() and classCode="THER"] food: ./classCode="FOOD""/> </mapping> </element> <element> <path value="Group.actual"/> <short value="Descriptive or actual"/> <definition value="If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals."/> <requirements value="There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <condition value="grp-1"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="true: ./determinerCode="GRP" false: ./determinerCode="GRP_KIND""/> </mapping> </element> <element> <path value="Group.code"/> <short value="Kind of Group members"/> <definition value="Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc."/> <comments value="This would generally be omitted for Person resources."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="GroupKind"/> <strength value="required"/> <description value="Kind of particular resource. E.g. cow, syringe, lake, etc."/> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> </element> <element> <path value="Group.name"/> <short value="Label for Group"/> <definition value="A label assigned to the group for human identification and communication."/> <requirements value="Used to identify the group in human communication."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./name[type="ST"]"/> </mapping> </element> <element> <path value="Group.quantity"/> <short value="Number of members"/> <definition value="A count of the number of resource instances that are part of the group."/> <requirements value="Group size is a common defining characteristic."/> <min value="0"/> <max value="1"/> <type> <code value="unsignedInt"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./quantity"/> </mapping> </element> <element> <path value="Group.characteristic"/> <short value="Trait of group members"/> <definition value="Identifies the traits shared by members of the group."/> <requirements value="Needs to be a generic mechanism for identifying what individuals can be part of a group."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value="./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode="SBJ"]/act [isNormalAct and classCode="OBS" and moodCode="EVN"]"/> </mapping> </element> <element> <path value="Group.characteristic.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Group.characteristic.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Group.characteristic.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Group.characteristic.code"/> <short value="Kind of characteristic"/> <definition value="A code that identifies the kind of trait being asserted."/> <requirements value="Need a formal way of identifying the characteristic being described."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="GroupCharacteristicKind"/> <strength value="required"/> <description value="List of characteristics used to describe group members. E.g. gender, age, owner, location, etc."/> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> </element> <element> <path value="Group.characteristic.value[x]"/> <short value="Value held by characteristic"/> <definition value="The value of the trait that holds (or does not hold - see 'exclude') for members of the group."/> <comments value="For Range, it means members of the group have a value that falls somewhere within the specified range."/> <requirements value="The value of the characteristic is what determines group membership."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <type> <code value="boolean"/> </type> <type> <code value="Quantity"/> </type> <type> <code value="Range"/> </type> <binding> <name value="GroupCharacteristicValue"/> <strength value="required"/> <description value="Value of descriptive member characteristic. E.g. red, male, pneumonia, caucasian, etc."/> </binding> <mapping> <identity value="rim"/> <map value="./value"/> </mapping> </element> <element> <path value="Group.characteristic.exclude"/> <short value="Group includes or excludes"/> <definition value="If true, indicates the characteristic is one that is NOT held by members of the group."/> <comments value="This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa."/> <requirements value="Sometimes group membership is determined by characteristics not possessed."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="./valueNegationInd"/> </mapping> </element> <element> <path value="Group.member"/> <short value="Who or what is in group"/> <definition value="Identifies the resource instances that are members of the group."/> <requirements value="Often the only thing of interest about a group is "who's in it"."/> <min value="0"/> <max value="*"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Medication"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Substance"/> </type> <condition value="grp-1"/> <constraint> <key value="grp-3"/> <name value="Group member type agreement"/> <severity value="error"/> <human value="Member resource types SHALL agree with group type"/> <xpath value="lower-case(f:type/@value)=parent::f:Group/f:type/@value or (f:type/@value='Patient' and parent::f:Group/f:type/@value=('animal','person'))"/> </constraint> <mapping> <identity value="rim"/> <map value="./scopedRole[isNormalRole() and classCode="MBR"]/player"/> </mapping> </element> </snapshot> <differential> <element> <path value="Group"/> <short value="Group of multiple entities"/> <definition value="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."/> <min value="1"/> <max value="1"/> <type> <code value="DomainResource"/> </type> <constraint> <key value="grp-4"/> <name value="No more members than quantity"/> <severity value="error"/> <human value="Can't have more members associated with the group than the value specified for "quantity""/> <xpath value="not(f:quantity) or not(f:member) or not(f:quantity>count(f:member))"/> </constraint> <constraint> <key value="grp-1"/> <name value="No members for non-actual"/> <severity value="error"/> <human value="Can only have members if group is "actual""/> <xpath value="f:actual/@value='true' or not(exists(f:member))"/> </constraint> <mapping> <identity value="rim"/> <map value="Entity[determinerCode="GRP" or determinerCode="GRP_KIND"]"/> </mapping> </element> <element> <path value="Group.identifier"/> <short value="Unique id"/> <definition value="A unique business identifier for this group."/> <requirements value="Allows the group to be referenced."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="unique(./id[displayable="true" and scope="OBJ"])"/> </mapping> </element> <element> <path value="Group.type"/> <short value="person | animal | practitioner | device | medication | substance"/> <definition value="Identifies the broad classification of the kind of resources the group includes."/> <requirements value="Identifies what type of resources the group is made up of."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <name value="GroupType"/> <strength value="required"/> <description value="Types of resources that are part of group"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/group-type"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="person: ./classCode="PSN" animal: ./classCode="ANM" device: ./classCode=" DEV" medication: ./classCode="MMAT" and ./playedRole[isNormalRole() and classCode="THER"] food: ./classCode="FOOD""/> </mapping> </element> <element> <path value="Group.actual"/> <short value="Descriptive or actual"/> <definition value="If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals."/> <requirements value="There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <condition value="grp-1"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="true: ./determinerCode="GRP" false: ./determinerCode="GRP_KIND""/> </mapping> </element> <element> <path value="Group.code"/> <short value="Kind of Group members"/> <definition value="Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc."/> <comments value="This would generally be omitted for Person resources."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="GroupKind"/> <strength value="required"/> <description value="Kind of particular resource. E.g. cow, syringe, lake, etc."/> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> </element> <element> <path value="Group.name"/> <short value="Label for Group"/> <definition value="A label assigned to the group for human identification and communication."/> <requirements value="Used to identify the group in human communication."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./name[type="ST"]"/> </mapping> </element> <element> <path value="Group.quantity"/> <short value="Number of members"/> <definition value="A count of the number of resource instances that are part of the group."/> <requirements value="Group size is a common defining characteristic."/> <min value="0"/> <max value="1"/> <type> <code value="unsignedInt"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./quantity"/> </mapping> </element> <element> <path value="Group.characteristic"/> <short value="Trait of group members"/> <definition value="Identifies the traits shared by members of the group."/> <requirements value="Needs to be a generic mechanism for identifying what individuals can be part of a group."/> <min value="0"/> <max value="*"/> <mapping> <identity value="rim"/> <map value="./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode="SBJ"]/act [isNormalAct and classCode="OBS" and moodCode="EVN"]"/> </mapping> </element> <element> <path value="Group.characteristic.code"/> <short value="Kind of characteristic"/> <definition value="A code that identifies the kind of trait being asserted."/> <requirements value="Need a formal way of identifying the characteristic being described."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="GroupCharacteristicKind"/> <strength value="required"/> <description value="List of characteristics used to describe group members. E.g. gender, age, owner, location, etc."/> </binding> <mapping> <identity value="rim"/> <map value="./code"/> </mapping> </element> <element> <path value="Group.characteristic.value[x]"/> <short value="Value held by characteristic"/> <definition value="The value of the trait that holds (or does not hold - see 'exclude') for members of the group."/> <comments value="For Range, it means members of the group have a value that falls somewhere within the specified range."/> <requirements value="The value of the characteristic is what determines group membership."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <type> <code value="boolean"/> </type> <type> <code value="Quantity"/> </type> <type> <code value="Range"/> </type> <binding> <name value="GroupCharacteristicValue"/> <strength value="required"/> <description value="Value of descriptive member characteristic. E.g. red, male, pneumonia, caucasian, etc."/> </binding> <mapping> <identity value="rim"/> <map value="./value"/> </mapping> </element> <element> <path value="Group.characteristic.exclude"/> <short value="Group includes or excludes"/> <definition value="If true, indicates the characteristic is one that is NOT held by members of the group."/> <comments value="This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa."/> <requirements value="Sometimes group membership is determined by characteristics not possessed."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="./valueNegationInd"/> </mapping> </element> <element> <path value="Group.member"/> <short value="Who or what is in group"/> <definition value="Identifies the resource instances that are members of the group."/> <requirements value="Often the only thing of interest about a group is "who's in it"."/> <min value="0"/> <max value="*"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Medication"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Substance"/> </type> <condition value="grp-1"/> <constraint> <key value="grp-3"/> <name value="Group member type agreement"/> <severity value="error"/> <human value="Member resource types SHALL agree with group type"/> <xpath value="lower-case(f:type/@value)=parent::f:Group/f:type/@value or (f:type/@value='Patient' and parent::f:Group/f:type/@value=('animal','person'))"/> </constraint> <mapping> <identity value="rim"/> <map value="./scopedRole[isNormalRole() and classCode="MBR"]/player"/> </mapping> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.