Release 4 5 Draft Ballot
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
FHIR Infrastructure Work Group   Maturity Level : 1 0 Trial Use Use Context : Any

The official URL for this profile is:

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

Enforces an actual group, rather than a definitional group

This profile was published on [no date] Thu, Jan 1, 1970 00:00+0000 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 Group .

Name Flags Card. Type Description & Constraints doco
. . Group 1..1 Group Group of multiple entities
. . . actual 1..1 boolean Descriptive or actual
Fixed Value: true
. . . characteristic 0 .. 0

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Group I 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 I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension I 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . identifier Σ I 0..* Identifier Unique id
. . . active Σ I 0..1 boolean Whether this group's record is in active use
. . . type Σ I 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType ( required ) ): Types of resources that are part of group.

. . . actual Σ I 1..1 boolean Descriptive or actual
Fixed Value: true
. . . 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
. . . 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
. . . member I 0..* BackboneElement Who or what is in group
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . entity I 1..1 Reference ( Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group ) Reference to the group member
. . . . period I 0..1 Period Period member belonged to the group
. . . . inactive I 0..1 boolean If member is no longer in group

doco Documentation for this format
<!-- Actual Group -->doco
<Group xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

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

 <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..0 BackboneElement  <!-- ?? 0..0 Include / Exclude group members by Trait -->

 </characteristic>
 <

 <member> ?? 0..* BackboneElement  <!-- ?? 0..* Who or what is in group -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <entity><!-- ?? 1..1 Reference(Patient) Reference to the group member --></entity>
  <period><!-- ?? 0..1 Period Period member belonged to the group --></period>
  <inactive value="[boolean]"/><!-- ?? 0..1 If member is no longer in group -->
 </member>
</Group>
{ // Actual Group
  // 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" : true, // 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
    "

    "member" : [{ BackboneElement }] // C?Who 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 Group .

Name Flags Card. Type Description & Constraints doco
. . Group 1..1 Group Group of multiple entities
. . . actual 1..1 boolean Descriptive or actual
Fixed Value: true
. . . characteristic 0 .. 0

doco Documentation for this format

Snapshot View

Name Flags Card. Type Description & Constraints doco
. . Group I 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 I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension I 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . identifier Σ I 0..* Identifier Unique id
. . . active Σ I 0..1 boolean Whether this group's record is in active use
. . . type Σ I 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType ( required ) ): Types of resources that are part of group.

. . . actual Σ I 1..1 boolean Descriptive or actual
Fixed Value: true
. . . 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
. . . 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
. . . member I 0..* BackboneElement Who or what is in group
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . entity I 1..1 Reference ( Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group ) Reference to the group member
. . . . period I 0..1 Period Period member belonged to the group
. . . . inactive I 0..1 boolean If member is no longer in group

doco Documentation for this format

XML Template

<!-- Actual Group -->doco
<Group xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

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

 <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..0 BackboneElement  <!-- ?? 0..0 Include / Exclude group members by Trait -->

 </characteristic>
 <

 <member> ?? 0..* BackboneElement  <!-- ?? 0..* Who or what is in group -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <entity><!-- ?? 1..1 Reference(Patient) Reference to the group member --></entity>
  <period><!-- ?? 0..1 Period Period member belonged to the group --></period>
  <inactive value="[boolean]"/><!-- ?? 0..1 If member is no longer in group -->
 </member>
</Group>

JSON Template

{ // Actual Group
  // 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" : true, // 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
    "

    "member" : [{ BackboneElement }] // C?Who or what is in group

  }

 

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

Path Name Conformance ValueSet
Group.language Common Languages preferred Common Languages
Group.type GroupType required GroupType
Group.code ?ext example
Group.characteristic.code ?ext example
Group.characteristic.value[x] ?ext example
.