Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). 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.12.6 StructureDefinition: Group Definition

FHIR Infrastructure Work Group Maturity Level: 0Trial 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 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: 1 element
Fixed Value: 1 element
Prohibited: 1 element

This structure is derived from Group.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 1..1GroupGroup of multiple entities
... actual 1..1booleanDescriptive or actual
Fixed Value: false
... member 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I1..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..*IdentifierUnique id
... active Σ0..1booleanWhether this group's record is in active use
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.

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

... name Σ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1idUnique 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

doco Documentation for this format
<!-- Group Definition -->doco

<Group xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <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><!-- 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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 1..1GroupGroup of multiple entities
... actual 1..1booleanDescriptive or actual
Fixed Value: false
... member 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I1..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..*IdentifierUnique id
... active Σ0..1booleanWhether this group's record is in active use
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.

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

... name Σ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity Σ0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1idUnique 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

doco Documentation for this format

XML Template

<!-- Group Definition -->doco

<Group xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <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><!-- 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.12.6.2 Terminology Bindings

PathNameConformanceValueSet
Group.languageCommon LanguagespreferredCommon Languages
Group.typeGroupTyperequiredGroupType
Group.code?extexample
Group.characteristic.code?extexample
Group.characteristic.value[x]?extexample
.