description: A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".
package_name: hl7.fhir.r5.examples
derivation: specialization
name: RequestGroup
type: RequestGroup
elements:
  instantiatesCanonical: {isModifier: false, short: Instantiates FHIR protocol or definition, type: canonical, mustSupport: false, array: true, isSummary: true, index: 1}
  instantiatesUri: {isModifier: false, short: Instantiates external protocol or definition, type: uri, mustSupport: false, array: true, isSummary: true, index: 2}
  encounter:
    isModifier: false
    short: Created as part of
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 11
  goal:
    isModifier: false
    short: What goals
    refers: ['http://hl7.org/fhir/StructureDefinition/Goal']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 15
  authoredOn: {isModifier: false, short: When the request group was authored, type: dateTime, mustSupport: false, isSummary: false, index: 12}
  note: {isModifier: false, short: Additional notes about the response, type: Annotation, mustSupport: false, array: true, isSummary: false, index: 16}
  author:
    isModifier: false
    short: Device or practitioner that authored the request group
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 13
  reason:
    isModifier: false
    short: Why the request group is needed
    type: CodeableReference
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/action-reason-code'}
    isSummary: false
    index: 14
  priority:
    isModifier: false
    short: routine | urgent | asap | stat
    type: code
    mustSupport: false
    meaningWhenMissing: If missing, this request should be performed with normal priority
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-priority|5.0.0-cibuild'}
    isSummary: true
    index: 8
  status:
    isModifier: true
    short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    index: 6
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-status|5.0.0-cibuild'}
    isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    isSummary: true
  groupIdentifier: {isModifier: false, short: Composite request this is part of, type: Identifier, mustSupport: false, isSummary: true, index: 5}
  code:
    isModifier: false
    short: What's being requested/ordered
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/action-code'}
    isSummary: true
    index: 9
  identifier: {isModifier: false, short: Business identifier, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 0}
  intent:
    isModifier: true
    short: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    index: 7
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-intent|5.0.0-cibuild'}
    isModifierReason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
    isSummary: true
  action:
    constraint:
      rqg-1: {human: Must have resource or action but not both, source: 'http://hl7.org/fhir/StructureDefinition/RequestGroup', severity: error, expression: resource.exists() != action.exists()}
    isModifier: false
    short: Proposed actions, if any
    index: 17
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      timingRange: {isModifier: false, short: When the action should take place, type: Range, mustSupport: false, choiceOf: timing, isSummary: false, index: 43}
      description: {isModifier: false, short: Short description of the action, type: string, mustSupport: false, isSummary: true, index: 21}
      linkId: {isModifier: false, short: Pointer to specific item from the PlanDefinition, type: string, mustSupport: false, isSummary: false, index: 18}
      textEquivalent: {isModifier: false, short: 'Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system', type: string, mustSupport: false, isSummary: true, index: 22}
      timingPeriod: {isModifier: false, short: When the action should take place, type: Period, mustSupport: false, choiceOf: timing, isSummary: false, index: 41}
      relatedAction:
        isModifier: false
        short: Relationship to another action
        index: 30
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          targetId: {isModifier: false, short: What action this is related to, type: id, mustSupport: false, isSummary: false, index: 31}
          relationship:
            isModifier: false
            short: before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
            type: code
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0-cibuild'}
            isSummary: false
            index: 32
          offset:
            isModifier: false
            short: Time offset for the relationship
            mustSupport: false
            choices: [offsetDuration, offsetRange]
            isSummary: false
            index: 34
          offsetDuration: {isModifier: false, short: Time offset for the relationship, type: Duration, mustSupport: false, choiceOf: offset, isSummary: false, index: 35}
          offsetRange: {isModifier: false, short: Time offset for the relationship, type: Range, mustSupport: false, choiceOf: offset, isSummary: false, index: 36}
        required: [targetId, relationship]
        isSummary: false
      goal:
        isModifier: false
        short: What goals
        refers: ['http://hl7.org/fhir/StructureDefinition/Goal']
        type: Reference
        mustSupport: false
        array: true
        isSummary: false
        index: 26
      type:
        isModifier: false
        short: create | update | remove | fire-event
        type: CodeableConcept
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/action-type'}
        isSummary: false
        index: 52
      participant:
        isModifier: false
        short: Who should perform the action
        type: BackboneElement
        mustSupport: false
        array: true
        isSummary: false
        index: 46
        elements:
          type:
            isModifier: false
            short: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
            type: code
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0'}
            isSummary: false
            index: 47
          typeReference:
            isModifier: false
            short: Who or what can participate
            refers: ['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/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']
            type: Reference
            mustSupport: false
            isSummary: false
            index: 48
          role:
            isModifier: false
            short: E.g. Nurse, Surgeon, Parent, etc.
            type: CodeableConcept
            mustSupport: false
            binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/action-participant-role'}
            isSummary: false
            index: 49
          function:
            isModifier: false
            short: E.g. Author, Reviewer, Witness, etc.
            type: CodeableConcept
            mustSupport: false
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/action-participant-function'}
            isSummary: false
            index: 50
          actor:
            isModifier: false
            short: Who/what is participating?
            refers: ['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/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']
            type: Reference
            mustSupport: false
            isSummary: false
            index: 51
      title: {isModifier: false, short: User-visible title, type: string, mustSupport: false, isSummary: false, index: 20}
      documentation: {isModifier: false, short: Supporting documentation for the intended performer of the action, type: RelatedArtifact, mustSupport: false, array: true, isSummary: false, index: 25}
      prefix: {isModifier: false, short: User-visible prefix for the action (e.g. 1. or A.), type: string, mustSupport: false, isSummary: false, index: 19}
      selectionBehavior:
        isModifier: false
        short: any | all | all-or-none | exactly-one | at-most-one | one-or-more
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0-cibuild'}
        isSummary: false
        index: 54
      timingDateTime: {isModifier: false, short: When the action should take place, type: dateTime, mustSupport: false, choiceOf: timing, isSummary: false, index: 39}
      timingTiming: {isModifier: false, short: When the action should take place, type: Timing, mustSupport: false, choiceOf: timing, isSummary: false, index: 44}
      timingDuration: {isModifier: false, short: When the action should take place, type: Duration, mustSupport: false, choiceOf: timing, isSummary: false, index: 42}
      priority:
        isModifier: false
        short: routine | urgent | asap | stat
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-priority|5.0.0-cibuild'}
        isSummary: false
        index: 23
      requiredBehavior:
        isModifier: false
        short: must | could | must-unless-documented
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0-cibuild'}
        isSummary: false
        index: 55
      condition:
        isModifier: false
        short: Whether or not the action is applicable
        index: 27
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          kind:
            isModifier: false
            short: applicability | start | stop
            type: code
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0-cibuild'}
            isSummary: false
            index: 28
          expression: {isModifier: false, short: Boolean-valued expression, type: Expression, mustSupport: false, isSummary: false, index: 29}
        required: [kind]
        isSummary: false
      resource:
        isModifier: false
        short: The target of the action
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 58
      timing:
        isModifier: false
        short: When the action should take place
        mustSupport: false
        choices: [timingDateTime, timingAge, timingPeriod, timingDuration, timingRange, timingTiming]
        isSummary: false
        index: 38
      groupingBehavior:
        isModifier: false
        short: visual-group | logical-group | sentence-group
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0-cibuild'}
        isSummary: false
        index: 53
      code:
        isModifier: false
        short: Code representing the meaning of the action or sub-actions
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/action-code'}
        isSummary: false
        index: 24
      timingAge: {isModifier: false, short: When the action should take place, type: Age, mustSupport: false, choiceOf: timing, isSummary: false, index: 40}
      action:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/RequestGroup', elements, action]
        isModifier: false
        short: Sub action
        mustSupport: false
        array: true
        isSummary: false
        index: 59
      precheckBehavior:
        isModifier: false
        short: yes | no
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0-cibuild'}
        isSummary: false
        index: 56
      location: {isModifier: false, short: Where it should happen, type: CodeableReference, mustSupport: false, isSummary: false, index: 45}
      cardinalityBehavior:
        isModifier: false
        short: single | multiple
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0-cibuild'}
        isSummary: false
        index: 57
    isSummary: false
  replaces:
    isModifier: false
    short: Request(s) replaced by this request
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 4
  basedOn:
    isModifier: false
    short: Fulfills plan, proposal, or order
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 3
  subject:
    isModifier: false
    short: Who the request group is about
    refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 10
package_version: 5.0.0-ballot
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/RequestGroup
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0-cibuild
required: [status, intent]