http://hl7.org/fhir/StructureDefinition/RequestOrchestration|5.0.0

description: A set of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".
derivation: specialization
name: RequestOrchestration
type: RequestOrchestration
elements:
  instantiatesCanonical: {isModifier: false, short: Instantiates FHIR protocol or definition, mustSupport: false, array: true, isSummary: true, index: 1}
  instantiatesUri: {isModifier: false, short: Instantiates external protocol or definition, mustSupport: false, array: true, isSummary: true, index: 2}
  encounter: {isModifier: false, short: Created as part of, mustSupport: false, isSummary: false, index: 11}
  goal: {isModifier: false, short: What goals, mustSupport: false, array: true, isSummary: false, index: 15}
  authoredOn: {isModifier: false, short: When the request orchestration was authored, mustSupport: false, isSummary: false, index: 12}
  note: {isModifier: false, short: Additional notes about the response, mustSupport: false, array: true, isSummary: false, index: 16}
  author: {isModifier: false, short: Device or practitioner that authored the request orchestration, mustSupport: false, isSummary: false, index: 13}
  reason:
    isModifier: false
    short: Why the request orchestration is needed
    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
    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'}
    isSummary: true
    index: 8
  status:
    isModifier: true
    short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-status|5.0.0'}
    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: {isModifier: false, short: Composite request this is part of, mustSupport: false, isSummary: true, index: 5}
  code:
    isModifier: false
    short: What's being requested/ordered
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/action-code'}
    isSummary: true
    index: 9
  identifier: {isModifier: false, short: Business 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
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-intent|5.0.0'}
    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:
    constraint:
      rqg-1: {human: Must have resource or action but not both, source: 'http://hl7.org/fhir/StructureDefinition/RequestOrchestration', severity: error, expression: resource.exists() != action.exists()}
    isModifier: false
    short: Proposed actions, if any
    mustSupport: false
    array: true
    isSummary: false
    index: 17
    elements:
      description: {isModifier: false, short: Short description of the action, mustSupport: false, isSummary: true, index: 21}
      definition:
        isModifier: false
        short: Description of the activity to be performed
        mustSupport: false
        choices: []
        isSummary: false
        index: 63
      linkId: {isModifier: false, short: Pointer to specific item from the PlanDefinition, mustSupport: false, isSummary: false, index: 18}
      transform: {isModifier: false, short: Transform to apply the template, mustSupport: false, isSummary: false, index: 64}
      textEquivalent: {isModifier: false, short: 'Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system', mustSupport: false, isSummary: true, index: 22}
      relatedAction:
        isModifier: false
        short: Relationship to another action
        mustSupport: false
        array: true
        isSummary: false
        index: 38
        elements:
          targetId: {isModifier: false, short: What action this is related to, mustSupport: false, isSummary: false, index: 39}
          relationship:
            isModifier: false
            short: before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0'}
            isSummary: false
            index: 40
          endRelationship:
            isModifier: false
            short: before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0'}
            isSummary: false
            index: 41
          offset:
            isModifier: false
            short: Time offset for the relationship
            mustSupport: false
            choices: []
            isSummary: false
            index: 43
        required: [targetId, relationship]
      goal: {isModifier: false, short: What goals, mustSupport: false, array: true, isSummary: false, index: 26}
      type:
        isModifier: false
        short: create | update | remove | fire-event
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/action-type'}
        isSummary: false
        index: 55
      participant:
        isModifier: false
        short: Who should perform the action
        mustSupport: false
        array: true
        isSummary: false
        index: 47
        elements:
          type:
            isModifier: false
            short: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0'}
            isSummary: false
            index: 48
          typeCanonical: {isModifier: false, short: Who or what can participate, mustSupport: false, isSummary: false, index: 49}
          typeReference: {isModifier: false, short: Who or what can participate, mustSupport: false, isSummary: false, index: 50}
          role:
            isModifier: false
            short: E.g. Nurse, Surgeon, Parent, etc
            mustSupport: false
            binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/action-participant-role'}
            isSummary: false
            index: 51
          function:
            isModifier: false
            short: E.g. Author, Reviewer, Witness, etc
            mustSupport: false
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/action-participant-function'}
            isSummary: false
            index: 52
          actor:
            isModifier: false
            short: Who/what is participating?
            mustSupport: false
            choices: []
            isSummary: false
            index: 54
      output:
        constraint:
          pld-1: {human: 'Output data element must have a requirement or a relatedData, but not both', source: 'http://hl7.org/fhir/StructureDefinition/RequestOrchestration', severity: error, expression: requirement.exists() xor relatedData.exists()}
        isModifier: false
        short: Output data definition
        mustSupport: false
        array: true
        isSummary: false
        index: 34
        elements:
          title: {isModifier: false, short: User-visible title, mustSupport: false, isSummary: false, index: 35}
          requirement: {isModifier: false, short: What data is provided, mustSupport: false, isSummary: false, index: 36}
          relatedData: {isModifier: false, short: What data is provided, mustSupport: false, isSummary: false, index: 37}
      title: {isModifier: false, short: User-visible title, mustSupport: false, isSummary: false, index: 20}
      documentation: {isModifier: false, short: Supporting documentation for the intended performer of the action, mustSupport: false, array: true, isSummary: false, index: 25}
      prefix: {isModifier: false, short: User-visible prefix for the action (e.g. 1. or A.), mustSupport: false, isSummary: false, index: 19}
      selectionBehavior:
        isModifier: false
        short: any | all | all-or-none | exactly-one | at-most-one | one-or-more
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0'}
        isSummary: false
        index: 57
      priority:
        isModifier: false
        short: routine | urgent | asap | stat
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/request-priority|5.0.0'}
        isSummary: false
        index: 23
      requiredBehavior:
        isModifier: false
        short: must | could | must-unless-documented
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0'}
        isSummary: false
        index: 58
      condition:
        isModifier: false
        short: Whether or not the action is applicable
        mustSupport: false
        array: true
        isSummary: false
        index: 27
        elements:
          kind:
            isModifier: false
            short: applicability | start | stop
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0'}
            isSummary: false
            index: 28
          expression: {isModifier: false, short: Boolean-valued expression, mustSupport: false, isSummary: false, index: 29}
        required: [kind]
      resource: {isModifier: false, short: The target of the action, mustSupport: false, isSummary: false, index: 61}
      timing:
        isModifier: false
        short: When the action should take place
        mustSupport: false
        choices: []
        isSummary: false
        index: 45
      groupingBehavior:
        isModifier: false
        short: visual-group | logical-group | sentence-group
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0'}
        isSummary: false
        index: 56
      dynamicValue:
        isModifier: false
        short: Dynamic aspects of the definition
        mustSupport: false
        array: true
        isSummary: false
        index: 65
        elements:
          path: {isModifier: false, short: The path to the element to be set dynamically, mustSupport: false, isSummary: false, index: 66}
          expression: {isModifier: false, short: An expression that provides the dynamic value for the customization, mustSupport: false, isSummary: false, index: 67}
      code:
        isModifier: false
        short: Code representing the meaning of the action or sub-actions
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/action-code'}
        isSummary: false
        index: 24
      action:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/RequestOrchestration', elements, action]
        isModifier: false
        short: Sub action
        mustSupport: false
        array: true
        isSummary: false
        index: 68
      precheckBehavior:
        isModifier: false
        short: yes | no
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0'}
        isSummary: false
        index: 59
      input:
        constraint:
          pld-0: {human: 'Input data elements must have a requirement or a relatedData, but not both', source: 'http://hl7.org/fhir/StructureDefinition/RequestOrchestration', severity: error, expression: requirement.exists() xor relatedData.exists()}
        isModifier: false
        short: Input data requirements
        mustSupport: false
        array: true
        isSummary: false
        index: 30
        elements:
          title: {isModifier: false, short: User-visible title, mustSupport: false, isSummary: false, index: 31}
          requirement: {isModifier: false, short: What data is provided, mustSupport: false, isSummary: false, index: 32}
          relatedData: {isModifier: false, short: What data is provided, mustSupport: false, isSummary: false, index: 33}
      location: {isModifier: false, short: Where it should happen, mustSupport: false, isSummary: false, index: 46}
      cardinalityBehavior:
        isModifier: false
        short: single | multiple
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0'}
        isSummary: false
        index: 60
  replaces: {isModifier: false, short: Request(s) replaced by this request, mustSupport: false, array: true, isSummary: false, index: 4}
  basedOn: {isModifier: false, short: 'Fulfills plan, proposal, or order', mustSupport: false, array: true, isSummary: false, index: 3}
  subject: {isModifier: false, short: Who the request orchestration is about, mustSupport: false, isSummary: false, index: 10}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/RequestOrchestration
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [status, intent]