description: Base StructureDefinition for Group Resource
package_name: hl7.fhir.r2b.core
derivation: specialization
name: Group
type: null
elements:
  name:
    isModifier: false
    short: Label for Group
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Group.name}
    isSummary: true
    index: 5
  type:
    isModifier: false
    short: person | animal | practitioner | device | medication | substance
    index: 1
    comments: Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medicaiton or Substance for the other types.).
    type: code
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Group.type}
    isSummary: true
  member:
    isModifier: false
    short: Who or what is in group
    index: 17
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      entity:
        isModifier: false
        short: Reference to the group member
        index: 18
        type: Reference
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Group.member.entity}
        isSummary: false
      period:
        isModifier: false
        short: Period member belonged to the group
        index: 19
        type: Period
        mustSupport: false
        meaningWhenMissing: The member is in the group at this time
        maxLength: 0
        base: {max: '1', min: 0, path: Group.member.period}
        isSummary: false
      inactive:
        isModifier: false
        short: If member is no longer in group
        index: 20
        type: boolean
        defaultValueBoolean: false
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Group.member.inactive}
        isSummary: false
    maxLength: 0
    base: {max: '*', min: 0, path: Group.member}
    required: [entity]
    isSummary: false
  characteristic:
    isModifier: false
    short: Trait of group members
    index: 7
    comments: All the identified characteristics must be true for an entity to a member of the group.
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      code:
        isModifier: false
        short: Kind of characteristic
        index: 8
        type: CodeableConcept
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Group.characteristic.code}
        isSummary: false
      value:
        isModifier: false
        short: Value held by characteristic
        index: 10
        comments: For Range, it means members of the group have a value that falls somewhere within the specified range.
        mustSupport: false
        choices: [valueCodeableConcept, valueBoolean, valueQuantity, valueRange]
        maxLength: 0
        base: {max: '1', min: 0, path: 'Group.characteristic.value[x]'}
        isSummary: false
      valueCodeableConcept:
        isModifier: false
        short: Value held by characteristic
        index: 11
        comments: For Range, it means members of the group have a value that falls somewhere within the specified range.
        type: CodeableConcept
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: 'Group.characteristic.value[x]'}
        choiceOf: value
        isSummary: false
      valueBoolean:
        isModifier: false
        short: Value held by characteristic
        index: 12
        comments: For Range, it means members of the group have a value that falls somewhere within the specified range.
        type: boolean
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: 'Group.characteristic.value[x]'}
        choiceOf: value
        isSummary: false
      valueQuantity:
        isModifier: false
        short: Value held by characteristic
        index: 13
        comments: For Range, it means members of the group have a value that falls somewhere within the specified range.
        type: Quantity
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: 'Group.characteristic.value[x]'}
        choiceOf: value
        isSummary: false
      valueRange:
        isModifier: false
        short: Value held by characteristic
        index: 14
        comments: For Range, it means members of the group have a value that falls somewhere within the specified range.
        type: Range
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: 'Group.characteristic.value[x]'}
        choiceOf: value
        isSummary: false
      exclude:
        isModifier: true
        short: Group includes or excludes
        index: 15
        comments: This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.
        type: boolean
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Group.characteristic.exclude}
        isSummary: false
      period:
        isModifier: false
        short: Period over which characteristic is tested
        type: Period
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Group.characteristic.period}
        isSummary: false
        index: 16
    maxLength: 0
    base: {max: '*', min: 0, path: Group.characteristic}
    required: [valueRange, value, valueBoolean, exclude, valueCodeableConcept, valueQuantity, code]
    isSummary: false
  active:
    isModifier: false
    short: Whether this group's record is in active use
    index: 3
    type: boolean
    defaultValueBoolean: true
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Group.active}
    isSummary: true
  code:
    isModifier: false
    short: Kind of Group members
    index: 4
    comments: This would generally be omitted for Person resources.
    type: CodeableConcept
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Group.code}
    isSummary: true
  identifier:
    isModifier: false
    short: Unique id
    index: 0
    type: Identifier
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: Group.identifier}
    isSummary: true
  quantity:
    isModifier: false
    short: Number of members
    index: 6
    comments: Note that the quantity may be less than the number of members if some of the members are not active.
    type: unsignedInt
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Group.quantity}
    isSummary: true
  actual:
    isModifier: false
    short: Descriptive or actual
    index: 2
    type: boolean
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Group.actual}
    isSummary: true
package_version: 1.4.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Group
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [type, actual]