PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r6.examples@6.0.0-ballot3
    http://hl7.org/fhir/StructureDefinition/Group
description: 'Represents a defined collection of entities that may be discussed or acted upon collectively but which are not typically expected to act collectively.  These collections are also not typically formally or legally recognized.\n\nNOTE: Group may be used to define families or households, which in some circumstances may act collectively or have a degree of legal or formal recognition.  This should be considered an exception.  When Group is used for types of entities other than Patient or RelatedPerson, the expectation remains that the Group will not act collectively or have formal recognition - use Organization if these behaviors are needed.\n\nFor example, it is possible for a ''family'' Group to be a performer of an Observation or owner of a Task.  However, this is not permitted for a Group made up of Practitioners, PractitionerRoles or Organizations.  Organization or CareTeam would need to be used instead.  A Group of Practitioners could, however, be a subject of an Observation.'
package_name: hl7.fhir.r6.examples
derivation: specialization
name: Group
type: Group
elements:
  description: {isModifier: false, short: Natural language description of the group, type: markdown, mustSupport: false, isSummary: false, index: 14}
  date: {isModifier: false, short: Date last changed, type: dateTime, mustSupport: false, isSummary: true, index: 11}
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), type: string, mustSupport: false, isSummary: true, index: 12}
  purpose: {isModifier: false, short: Why this Group is defined, type: markdown, mustSupport: false, isSummary: false, index: 16}
  name: {isModifier: false, short: Label for Group, type: string, mustSupport: false, isSummary: true, index: 7}
  copyrightLabel: {isModifier: false, short: Copyright holder and year(s), type: string, mustSupport: false, isSummary: false, index: 18}
  useContext: {isModifier: false, short: The context that the content is intended to support, type: UsageContext, mustSupport: false, array: true, isSummary: true, index: 15}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, type: markdown, mustSupport: false, isSummary: false, index: 17}
  versionAlgorithm:
    isModifier: false
    short: How to compare versions
    mustSupport: false
    choices: [versionAlgorithmString, versionAlgorithmCoding]
    isSummary: true
    index: 4
  type:
    isModifier: false
    short: person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen | medication | substance | biologicallyDerivedProduct | nutritionProduct
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/group-type|6.0.0-ballot3'}
    isSummary: true
    index: 19
  experimental: {isModifier: false, short: For testing only - never for real usage, type: boolean, mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 10}
  membership:
    isModifier: false
    short: definitional | conceptual | enumerated
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/group-membership-basis|6.0.0-ballot3'}
    isSummary: true
    index: 20
  title: {isModifier: false, short: Name for this Group (human friendly), type: string, mustSupport: false, isSummary: true, index: 8}
  versionAlgorithmCoding: {isModifier: false, short: How to compare versions, type: Coding, mustSupport: false, choiceOf: versionAlgorithm, isSummary: true, index: 6}
  member:
    isModifier: false
    short: Who or what is in group
    index: 55
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      entity:
        isModifier: false
        short: Reference to the group member
        refers: ['http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct', 'http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Location', 'http://hl7.org/fhir/StructureDefinition/Medication', 'http://hl7.org/fhir/StructureDefinition/NutritionProduct', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson', 'http://hl7.org/fhir/StructureDefinition/Specimen', 'http://hl7.org/fhir/StructureDefinition/Substance']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 56
      involvement:
        isModifier: false
        short: Code that describes how user is part of the group
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/group-involvement-set'}
        isSummary: false
        index: 57
      period: {isModifier: false, short: Period member belonged to the group, type: Period, mustSupport: false, meaningWhenMissing: The member is in the group at this time, isSummary: false, index: 58}
      inactive: {isModifier: false, short: If member is no longer in group, type: boolean, mustSupport: false, meaningWhenMissing: Members are considered active unless explicitly specified otherwise, isSummary: false, index: 59}
    required: [entity]
    isSummary: false
  characteristic:
    isModifier: false
    short: Include / Exclude group members by Trait
    index: 26
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      description: {isModifier: false, short: Natural language description of the characteristic, type: markdown, mustSupport: false, isSummary: false, index: 38}
      exclude: {isModifier: false, short: Group includes or excludes, type: boolean, mustSupport: false, isSummary: true, index: 37}
      valueReference: {isModifier: false, short: Value held by characteristic, type: Reference, mustSupport: false, choiceOf: value, isSummary: true, index: 34}
      offset:
        isModifier: true
        short: Reference point for comparison
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/characteristic-offset'}
        isModifierReason: If offset is present it must be included to interpret the characteristic value.
        isSummary: true
        index: 44
      valueUri: {isModifier: false, short: Value held by characteristic, type: uri, mustSupport: false, choiceOf: value, isSummary: true, index: 35}
      method:
        isModifier: false
        short: Method for how the characteristic value was determined
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/definition-method'}
        isSummary: false
        index: 39
      valueQuantity: {isModifier: false, short: Value held by characteristic, type: Quantity, mustSupport: false, choiceOf: value, isSummary: true, index: 32}
      determinedByReference:
        isModifier: false
        short: Defines the characteristic
        refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/DeviceDefinition', 'http://hl7.org/fhir/StructureDefinition/DeviceMetric']
        type: Reference
        mustSupport: false
        choiceOf: determinedBy
        isSummary: false
        index: 42
      value:
        isModifier: false
        short: Value held by characteristic
        mustSupport: false
        choices: [valueCodeableConcept, valueBoolean, valueQuantity, valueRange, valueReference, valueUri, valueExpression]
        isSummary: true
        index: 29
      valueBoolean: {isModifier: false, short: Value held by characteristic, type: boolean, mustSupport: false, choiceOf: value, isSummary: true, index: 31}
      duration:
        isModifier: false
        short: Length of time in which the characteristic is met
        mustSupport: false
        choices: [durationDuration, durationRange]
        isSummary: false
        index: 50
      durationDuration: {isModifier: false, short: Length of time in which the characteristic is met, type: Duration, mustSupport: false, choiceOf: duration, isSummary: false, index: 51}
      determinedByExpression: {isModifier: false, short: Defines the characteristic, type: Expression, mustSupport: false, choiceOf: determinedBy, isSummary: false, index: 43}
      instancesUnsignedInt:
        constraint:
          grp-1: {human: Ranges have to be positive, source: 'http://hl7.org/fhir/StructureDefinition/Group', severity: error, expression: ($this is Range) implies ((low.empty() or ((low.code.exists() or low.value.empty()) and (low.system.empty() or low.system = %ucum) and (low.code.empty() or low.code = '1') and (low.value.empty() or low.value.hasValue().not() or low.value.toString().contains('.').not()) and (low.value.empty() or low.value.hasValue().not() or low.value >= 0))) and (high.empty() or ((high.code.exists() or high.value.empty()) and (high.system.empty() or high.system = %ucum) and (high.code.empty() or high.code = '1') and (high.value.empty() or high.value.hasValue().not() or high.value.toString().contains('.').not()) and (high.value.empty() or high.value.hasValue().not() or high.value >= 0))))}
        isModifier: false
        short: Number of occurrences meeting the characteristic
        type: unsignedInt
        mustSupport: false
        choiceOf: instances
        isSummary: false
        index: 47
      valueExpression: {isModifier: false, short: Value held by characteristic, type: Expression, mustSupport: false, choiceOf: value, isSummary: true, index: 36}
      durationRange: {isModifier: false, short: Length of time in which the characteristic is met, type: Range, mustSupport: false, choiceOf: duration, isSummary: false, index: 52}
      instances:
        constraint:
          grp-1: {human: Ranges have to be positive, source: 'http://hl7.org/fhir/StructureDefinition/Group', severity: error, expression: ($this is Range) implies ((low.empty() or ((low.code.exists() or low.value.empty()) and (low.system.empty() or low.system = %ucum) and (low.code.empty() or low.code = '1') and (low.value.empty() or low.value.hasValue().not() or low.value.toString().contains('.').not()) and (low.value.empty() or low.value.hasValue().not() or low.value >= 0))) and (high.empty() or ((high.code.exists() or high.value.empty()) and (high.system.empty() or high.system = %ucum) and (high.code.empty() or high.code = '1') and (high.value.empty() or high.value.hasValue().not() or high.value.toString().contains('.').not()) and (high.value.empty() or high.value.hasValue().not() or high.value >= 0))))}
        isModifier: false
        short: Number of occurrences meeting the characteristic
        mustSupport: false
        choices: [instancesUnsignedInt, instancesRange]
        isSummary: false
        index: 46
      timing: {isModifier: false, short: Timing in which the characteristic is determined, type: RelativeTime, mustSupport: false, array: true, isSummary: false, index: 54}
      code:
        isModifier: false
        short: Kind of characteristic
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/example-characteristic-codes'}
        isSummary: true
        index: 27
      valueCodeableConcept: {isModifier: false, short: Value held by characteristic, type: CodeableConcept, mustSupport: false, choiceOf: value, isSummary: true, index: 30}
      period: {isModifier: false, short: Period over which characteristic is tested, type: Period, mustSupport: false, isSummary: false, index: 53}
      valueRange: {isModifier: false, short: Value held by characteristic, type: Range, mustSupport: false, choiceOf: value, isSummary: true, index: 33}
      instancesRange:
        constraint:
          grp-1: {human: Ranges have to be positive, source: 'http://hl7.org/fhir/StructureDefinition/Group', severity: error, expression: ($this is Range) implies ((low.empty() or ((low.code.exists() or low.value.empty()) and (low.system.empty() or low.system = %ucum) and (low.code.empty() or low.code = '1') and (low.value.empty() or low.value.hasValue().not() or low.value.toString().contains('.').not()) and (low.value.empty() or low.value.hasValue().not() or low.value >= 0))) and (high.empty() or ((high.code.exists() or high.value.empty()) and (high.system.empty() or high.system = %ucum) and (high.code.empty() or high.code = '1') and (high.value.empty() or high.value.hasValue().not() or high.value.toString().contains('.').not()) and (high.value.empty() or high.value.hasValue().not() or high.value >= 0))))}
        isModifier: false
        short: Number of occurrences meeting the characteristic
        type: Range
        mustSupport: false
        choiceOf: instances
        isSummary: false
        index: 48
      determinedBy:
        isModifier: false
        short: Defines the characteristic
        mustSupport: false
        choices: [determinedByReference, determinedByExpression]
        isSummary: false
        index: 41
    required: [valueUri, valueReference, valueRange, valueExpression, value, valueBoolean, exclude, valueCodeableConcept, valueQuantity, code]
    isSummary: true
  combinationThreshold: {isModifier: false, short: Provides the value of "n" when "at-least" or "at-most" codes are used, type: positiveInt, mustSupport: false, isSummary: false, index: 25}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot3'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired Group without due consideration
    isSummary: true
    index: 9
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/Group', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'}
    isModifier: false
    short: Canonical identifier for this Group, represented as an absolute URI (globally unique)
    type: uri
    mustSupport: false
    isSummary: true
    index: 0
  code:
    isModifier: false
    short: Use of the Group (and by implication, kind of members)
    type: CodeableConcept
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/group-code'}
    isSummary: true
    index: 21
  identifier: {isModifier: false, short: Business Identifier for this Group, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 1}
  versionAlgorithmString: {isModifier: false, short: How to compare versions, type: string, mustSupport: false, choiceOf: versionAlgorithm, isSummary: true, index: 5}
  combinationMethod:
    isModifier: true
    short: all-of | any-of | at-least | at-most | except-subset
    index: 24
    type: code
    mustSupport: false
    meaningWhenMissing: If absent, this element is treated as though it had been set to 'all-of'
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/group-characteristic-combination|6.0.0-ballot3'}
    isModifierReason: Changing the combinationMethod from all-of to any other value changes the interpretation of multiple characteristics.
    isSummary: true
  quantity: {isModifier: false, short: Number of members, type: unsignedInt, mustSupport: false, isSummary: true, index: 22}
  managingEntity:
    isModifier: false
    short: Entity that is the custodian of the Group's definition
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 23
  version: {isModifier: false, short: Business version of the Group, type: string, mustSupport: false, isSummary: true, index: 2}
  contact: {isModifier: false, short: Contact details for the publisher, type: ContactDetail, mustSupport: false, array: true, isSummary: true, index: 13}
package_version: 6.0.0-ballot3
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Group
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 6.0.0-ballot3
required: [membership]