PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.core@3.2.0
    http://hl7.org/fhir/StructureDefinition/RequestGroup
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.core
derivation: specialization
name: RequestGroup
type: RequestGroup
elements:
  definition:
    short: Instantiates protocol or definition
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    array: true
    index: 1
  reasonCode: {type: CodeableConcept, short: Why the request group is needed, array: true, index: 13}
  authoredOn: {type: dateTime, short: When the request group was authored, index: 11}
  note: {type: Annotation, short: Additional notes about the response, array: true, index: 15}
  author:
    short: Device or practitioner that authored the request group
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Practitioner']
    type: Reference
    index: 12
  priority: {short: routine | urgent | asap | stat, type: code, meaningWhenMissing: 'If missing, this request should be performed with normal priority', isSummary: true, index: 7}
  status: {isModifier: true, short: draft | active | suspended | cancelled | completed | entered-in-error | unknown, type: code, isSummary: true, index: 5}
  groupIdentifier: {short: Composite request this is part of, type: Identifier, isSummary: true, index: 4}
  code: {short: What's being requested/ordered, type: CodeableConcept, isSummary: true, index: 8}
  identifier: {short: Business identifier, type: Identifier, array: true, isSummary: true, index: 0}
  context:
    short: Encounter or Episode for the request group
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter', 'http://hl7.org/fhir/StructureDefinition/EpisodeOfCare']
    type: Reference
    index: 10
  intent: {isModifier: true, short: proposal | plan | order, type: code, isSummary: true, index: 6}
  action:
    type: BackboneElement
    short: Proposed actions, if any
    constraint:
      rqg-1: {human: Must have resource or action but not both, severity: error, expression: resource.exists() != action.exists()}
    array: true
    index: 16
    elements:
      timingRange: {short: When the action should take place, type: Range, choiceOf: timing, index: 41}
      description: {type: string, short: Short description of the action, isSummary: true, index: 19}
      textEquivalent: {type: string, short: 'Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system', isSummary: true, index: 20}
      timingPeriod: {short: When the action should take place, type: Period, choiceOf: timing, index: 39}
      relatedAction:
        type: BackboneElement
        short: Relationship to another action
        array: true
        index: 28
        elements:
          actionId: {type: id, short: What action this is related to, index: 29}
          relationship: {type: code, short: before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end, index: 30}
          offset:
            short: Time offset for the relationship
            choices: [offsetDuration, offsetRange]
            index: 32
          offsetDuration: {type: Duration, short: Time offset for the relationship, choiceOf: offset, index: 33}
          offsetRange: {type: Range, short: Time offset for the relationship, choiceOf: offset, index: 34}
        required: [relationship, actionId]
      type: {type: Coding, short: create | update | remove | fire-event, index: 44}
      participant:
        short: Who should perform the action
        refers: ['http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Person', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
        type: Reference
        array: true
        index: 43
      title: {type: string, short: User-visible title, index: 18}
      documentation: {type: RelatedArtifact, short: Supporting documentation for the intended performer of the action, array: true, index: 22}
      prefix: {type: string, short: User-visible prefix for the action (e.g. 1. or A.), index: 17}
      selectionBehavior: {type: code, short: any | all | all-or-none | exactly-one | at-most-one | one-or-more, index: 46}
      timingDateTime: {short: When the action should take place, type: dateTime, choiceOf: timing, index: 37}
      timingTiming: {short: When the action should take place, type: Timing, choiceOf: timing, index: 42}
      timingDuration: {short: When the action should take place, type: Duration, choiceOf: timing, index: 40}
      requiredBehavior: {type: code, short: must | could | must-unless-documented, index: 47}
      condition:
        type: BackboneElement
        short: Whether or not the action is applicable
        array: true
        index: 23
        elements:
          kind: {short: applicability | start | stop, type: code, index: 24}
          description: {type: string, short: Natural language description of the condition, index: 25}
          language: {type: string, short: Language of the expression, index: 26}
          expression: {type: string, short: Boolean-valued expression, index: 27}
        required: [kind]
      resource:
        short: The target of the action
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        index: 50
      timing:
        short: When the action should take place
        choices: [timingDateTime, timingAge, timingPeriod, timingDuration, timingRange, timingTiming]
        index: 36
      groupingBehavior: {type: code, short: visual-group | logical-group | sentence-group, index: 45}
      code: {type: CodeableConcept, short: Code representing the meaning of the action or sub-actions, array: true, index: 21}
      timingAge: {short: When the action should take place, type: Age, choiceOf: timing, index: 38}
      action:
        short: Sub action
        elementReference: ['http://hl7.org/fhir/StructureDefinition/RequestGroup', elements, action]
        array: true
        index: 51
      precheckBehavior: {type: code, short: yes | no, index: 48}
      cardinalityBehavior: {type: code, short: single | multiple, index: 49}
  replaces:
    short: Request(s) replaced by this request
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    array: true
    index: 3
  basedOn:
    short: Fulfills plan, proposal, or order
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    array: true
    index: 2
  subject:
    short: Who the request group is about
    refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    index: 9
  reasonReference:
    short: Why the request group is needed
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    array: true
    index: 14
package_version: 3.2.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/RequestGroup
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [status, intent]