Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version in it's permanent home (it will always be available at this URL). 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

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

The official canonical URL for this profile is:

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

Enforces an actual enumerated group, rather than a definitional group

This profile was published on [no date] Thu, Jan 1, 1970 00:00+1000 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: 1 element
Fixed Value: 1 element Prohibited: 1 element

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

Name Flags Card. Type Description & Constraints doco
. . Group 1..1 Group Group of multiple entities
. . . actual membership 1..1 boolean code definitional | enumerated
Fixed Value: true characteristic 0 .. 0 enumerated

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.

I I I I I I I I
Name Flags Card. Type Description & Constraints doco
. . Group 1..1 Group Group of multiple entities
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . 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 ?! I Σ 0..* Extension Extensions that cannot be ignored
. . . identifier Σ I 0..* Identifier Unique id Business Identifier for this Group
. . . active Σ ?! I Σ 0..1 boolean Whether this group's record is in active use
. . . type Σ I 1..1 code person | animal | practitioner | device | medication careteam | substance healthcareservice | location | organization | relatedperson | specimen
Binding: GroupType Group Type ( required ) ): Types of resources that are part of group.

. . . actual membership Σ I 1..1 boolean code Descriptive or actual definitional | enumerated
Binding: Group Membership Basis ( required ): The basis for membership in a group


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

. . . name Σ I 0..1 string Label for Group
. . . description 0..1 markdown Natural language description of the group
... quantity Σ I 0..1 unsignedInt Number of members
. . . managingEntity Σ I 0..1 Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole ) Entity that is the custodian of the Group's definition
. . . characteristic Σ 0..* 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: (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: (unbound) ( example ): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConcept CodeableConcept
. . . . . valueBoolean boolean
..... valueQuantity Quantity
. . . . . valueRange I Range
..... valueReference Reference (Any)
.... exclude Σ 1..1 boolean Group includes or excludes
.... period 0..1 Period Period over which characteristic is tested
... 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 ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . entity 1..1 Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | Device | Medication | Substance RelatedPerson | Group Specimen ) Reference to the group member
. . . . 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
<!-- Actual Group -->

<!-- ActualGroup -->doco


<Group xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>
 <</meta>
 <
 <
 <</text>
 <</contained>
 <<a href="actualgroup-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 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.

 <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>
 <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>
 <</identifier>
 <
 <
 <
 <</code>
 <
 <
 <

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><!-- 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 0..* BackboneElement  <!-- I 0..* 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>
 <
  <<a href="actualgroup-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 manageable, 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.

 <member> I 0..* BackboneElement  <!-- I 0..* Who or what is in group -->
  <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>
  <</entity>
  <</period>
  <

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><!-- 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>
{ // 

{ // ActualGroup

  // from Element: extension
    "
    "
    "
    "
    "
    "<a href="actualgroup-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 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.

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

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
    "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" : "enumerated", // 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 }], // IInclude / Exclude group members by Trait
    "member" : [{ BackboneElement }] // IWho or what is in group

  }

This structure is derived from Group .

Summary

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

Differential View

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

Name Flags Card. Type Description & Constraints doco
. . Group 1..1 Group Group of multiple entities
. . . actual membership 1..1 boolean code definitional | enumerated
Fixed Value: true characteristic 0 .. 0 enumerated

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.

I I I I I I I I
Name Flags Card. Type Description & Constraints doco
. . Group 1..1 Group Group of multiple entities
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . 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 ?! I Σ 0..* Extension Extensions that cannot be ignored
. . . identifier Σ I 0..* Identifier Unique id Business Identifier for this Group
. . . active Σ ?! I Σ 0..1 boolean Whether this group's record is in active use
. . . type Σ I 1..1 code person | animal | practitioner | device | medication careteam | substance healthcareservice | location | organization | relatedperson | specimen
Binding: GroupType Group Type ( required ) ): Types of resources that are part of group.

. . . actual membership Σ I 1..1 boolean code Descriptive or actual definitional | enumerated
Binding: Group Membership Basis ( required ): The basis for membership in a group


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

. . . name Σ I 0..1 string Label for Group
. . . description 0..1 markdown Natural language description of the group
... quantity Σ I 0..1 unsignedInt Number of members
. . . managingEntity Σ I 0..1 Reference ( Organization | RelatedPerson | Practitioner | PractitionerRole ) Entity that is the custodian of the Group's definition
. . . characteristic Σ 0..* 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: (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: (unbound) ( example ): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConcept CodeableConcept
. . . . . valueBoolean boolean
..... valueQuantity Quantity
. . . . . valueRange I Range
..... valueReference Reference (Any)
.... exclude Σ 1..1 boolean Group includes or excludes
.... period 0..1 Period Period over which characteristic is tested
... 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 ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . entity 1..1 Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | Device | Medication | Substance RelatedPerson | Group Specimen ) Reference to the group member
. . . . 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

<!-- Actual Group -->

<!-- ActualGroup -->doco


<Group xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>
 <</meta>
 <
 <
 <</text>
 <</contained>
 <<a href="actualgroup-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 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.

 <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>
 <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>
 <</identifier>
 <
 <
 <
 <</code>
 <
 <
 <

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><!-- 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 0..* BackboneElement  <!-- I 0..* 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>
 <
  <<a href="actualgroup-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 manageable, 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.

 <member> I 0..* BackboneElement  <!-- I 0..* Who or what is in group -->
  <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>
  <</entity>
  <</period>
  <

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><!-- 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

{ // 

{ // ActualGroup

  // from Element: extension
    "
    "
    "
    "
    "
    "<a href="actualgroup-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 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.

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

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
    "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" : "enumerated", // 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 }], // IInclude / 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 Common All Languages preferred required Common All Languages
Group.type GroupType Group Type required GroupType Group Type
Group.membership Group Membership Basis required Group Membership Basis
Group.code ?ext example
Group.characteristic.code ?ext example
Group.characteristic.value[x] ?ext example
. .