PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r4.examples@4.0.1
    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.r4.examples
derivation: specialization
name: RequestGroup
type: RequestGroup
elements:
  instantiatesCanonical: {short: Instantiates FHIR protocol or definition, type: canonical, array: true, isSummary: true, index: 1}
  instantiatesUri: {short: Instantiates external protocol or definition, type: uri, array: true, isSummary: true, index: 2}
  encounter:
    short: Created as part of
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    index: 11
  reasonCode: {type: CodeableConcept, short: Why the request group is needed, array: true, index: 14}
  authoredOn: {type: dateTime, short: When the request group was authored, index: 12}
  note: {type: Annotation, short: Additional notes about the response, array: true, index: 16}
  author:
    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
    index: 13
  priority:
    short: routine | urgent | asap | stat
    type: code
    meaningWhenMissing: If missing, this request should be performed with normal priority
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-priority|4.0.1'}
    isSummary: true
    index: 8
  status:
    isModifier: true
    short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-status|4.0.1'}
    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
    index: 6
  groupIdentifier: {short: Composite request this is part of, type: Identifier, isSummary: true, index: 5}
  code: {short: What's being requested/ordered, type: CodeableConcept, isSummary: true, index: 9}
  identifier: {short: Business identifier, type: Identifier, array: true, isSummary: true, index: 0}
  intent:
    isModifier: true
    short: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-intent|4.0.1'}
    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
    index: 7
  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: 17
    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: 20}
      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: 21}
      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
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1'}
            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: CodeableConcept
        short: create | update | remove | fire-event
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/action-type'}
        index: 44
      participant:
        short: Who should perform the action
        refers: ['http://hl7.org/fhir/StructureDefinition/Device', '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
        array: true
        index: 43
      title: {type: string, short: User-visible title, index: 19}
      documentation: {type: RelatedArtifact, short: Supporting documentation for the intended performer of the action, array: true, index: 24}
      prefix: {type: string, short: User-visible prefix for the action (e.g. 1. or A.), index: 18}
      selectionBehavior:
        type: code
        short: any | all | all-or-none | exactly-one | at-most-one | one-or-more
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1'}
        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}
      priority:
        short: routine | urgent | asap | stat
        type: code
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-priority|4.0.1'}
        index: 22
      requiredBehavior:
        type: code
        short: must | could | must-unless-documented
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1'}
        index: 47
      condition:
        type: BackboneElement
        short: Whether or not the action is applicable
        array: true
        index: 25
        elements:
          kind:
            short: applicability | start | stop
            type: code
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1'}
            index: 26
          expression: {type: Expression, 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
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1'}
        index: 45
      code: {type: CodeableConcept, short: Code representing the meaning of the action or sub-actions, array: true, index: 23}
      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
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1'}
        index: 48
      cardinalityBehavior:
        type: code
        short: single | multiple
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1'}
        index: 49
  replaces:
    short: Request(s) replaced by this request
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    array: true
    index: 4
  basedOn:
    short: Fulfills plan, proposal, or order
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    array: true
    index: 3
  subject:
    short: Who the request group is about
    refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    index: 10
  reasonReference:
    short: Why the request group is needed
    refers: ['http://hl7.org/fhir/StructureDefinition/Condition', 'http://hl7.org/fhir/StructureDefinition/DiagnosticReport', 'http://hl7.org/fhir/StructureDefinition/DocumentReference', 'http://hl7.org/fhir/StructureDefinition/Observation']
    type: Reference
    array: true
    index: 15
package_version: 4.0.1
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/RequestGroup
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.0.1
required: [status, intent]