This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.17 Resource RequestOrchestration - Content

Clinical Decision Support icon

Work Group

Maturity Level: 2

Trial Use

Security Category: Business

Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

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".

14.17.1 Scope and Usage

This resource is a request resource from a FHIR workflow perspective - see Workflow, specifically Request.

The RequestOrchestration resource is used to represent a set of optional and related activities that may be performed for a specific patient or context. This resource is often, but not always, the result of applying a specific PlanDefinition to a particular patient. Other than differences that tie the RequestOrchestration to a particular subject and setting, the actionDefinition element of PlanDefinition is identical to the action element of the RequestOrchestration, allowing the same features and functionality to be used in both places to describe optionality of and relationships between activities in a workflow.

RequestOrchestrations can contain hierarchical groups of actions, where each specific action references the action to be performed (in terms of a Request resource), and each group describes additional behavior, relationships, and applicable conditions between the actions in the overall group.

14.17.2 References to this Resource

Implements: Request
Resource References: CarePlan, DocumentReference and GuidanceResponse

Structure

Name	Flags	Card.	Type	Description & Constraints
RequestOrchestration	TU		DomainResource	A set of related requests Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	Business identifier
instantiatesCanonical	Σ	0..*	canonical()	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn		0..*	Reference(Any)	Fulfills plan, proposal, or order
replaces		0..*	Reference(Any)	Request(s) replaced by this request
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown RequestStatus (Required)
intent	?!Σ	1..1	code	proposal \| plan \| directive \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option RequestIntent (Required)
priority	Σ	0..1	code	routine \| urgent \| asap \| stat RequestPriority (Required)
code	Σ	0..1	CodeableConcept	What's being requested/ordered ActionCode (Example)
subject		0..1	Reference(Patient \| Group)	Who the request orchestration is about
encounter		0..1	Reference(Encounter)	Created as part of
authoredOn		0..1	dateTime	When the request orchestration was authored
author		0..1	Reference(Device \| Practitioner \| PractitionerRole)	Device or practitioner that authored the request orchestration
reason		0..*	CodeableReference(Condition \| Observation \| DiagnosticReport \| DocumentReference)	Why the request orchestration is needed ActionReasonCode (Example)
goal		0..*	Reference(Goal)	What goals
note		0..*	Annotation	Additional notes about the response
action	C	0..*	BackboneElement	Proposed actions, if any + Rule: Must have resource or action but not both
linkId		0..1	string	Pointer to specific item from the PlanDefinition
prefix		0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title		0..1	string	User-visible title
description	Σ	0..1	string	Short description of the action
textEquivalent	Σ	0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority		0..1	code	routine \| urgent \| asap \| stat RequestPriority (Required)
code		0..*	CodeableConcept	Code representing the meaning of the action or sub-actions ActionCode (Example)
documentation		0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
goal		0..*	Reference(Goal)	What goals
condition		0..*	BackboneElement	Whether or not the action is applicable
kind		1..1	code	applicability \| start \| stop ActionConditionKind (Required)
expression		0..1	Expression	Boolean-valued expression
input	C	0..*	BackboneElement	Input data requirements + Rule: Input data elements must have a requirement or a relatedData, but not both
title		0..1	string	User-visible title
requirement		0..1	DataRequirement	What data is provided
relatedData		0..1	id	What data is provided
output	C	0..*	BackboneElement	Output data definition + Rule: Output data element must have a requirement or a relatedData, but not both
title		0..1	string	User-visible title
requirement		0..1	DataRequirement	What data is provided
relatedData		0..1	string	What data is provided
relatedAction		0..*	BackboneElement	Relationship to another action
targetId		1..1	id	What action this is related to
relationship		1..1	code	before-start \| before \| before-end \| concurrent-with-start \| concurrent \| concurrent-with-end \| after-start \| after \| after-end ActionRelationshipType (Required)
offset[x]		0..1		Time offset for the relationship
offsetDuration			Duration
offsetRange			Range
timing[x]		0..1		When the action should take place
timingDateTime			dateTime
timingAge			Age
timingPeriod			Period
timingDuration			Duration
timingRange			Range
timingTiming			Timing
location		0..1	CodeableReference(Location)	Where it should happen
participant		0..*	BackboneElement	Who should perform the action
type		0..1	code	careteam \| device \| group \| healthcareservice \| location \| organization \| patient \| practitioner \| practitionerrole \| relatedperson ActionParticipantType (Required)
typeCanonical		0..1	canonical(CapabilityStatement)	Who or what can participate
typeReference		0..1	Reference(CareTeam \| Device \| DeviceDefinition \| Endpoint \| Group \| HealthcareService \| Location \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson)	Who or what can participate
role		0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent, etc. ActionParticipantRole (Example)
function		0..1	CodeableConcept	E.g. Author, Reviewer, Witness, etc. ActionParticipantFunction (Example)
actor[x]		0..1		Who/what is participating?
actorCanonical			canonical(CapabilityStatement)
actorReference			Reference(CareTeam \| Device \| DeviceDefinition \| Endpoint \| Group \| HealthcareService \| Location \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson)
type		0..1	CodeableConcept	create \| update \| remove \| fire-event ActionType (Extensible)
groupingBehavior		0..1	code	visual-group \| logical-group \| sentence-group ActionGroupingBehavior (Required)
selectionBehavior		0..1	code	any \| all \| all-or-none \| exactly-one \| at-most-one \| one-or-more ActionSelectionBehavior (Required)
requiredBehavior		0..1	code	must \| could \| must-unless-documented ActionRequiredBehavior (Required)
precheckBehavior		0..1	code	yes \| no ActionPrecheckBehavior (Required)
cardinalityBehavior		0..1	code	single \| multiple ActionCardinalityBehavior (Required)
resource	C	0..1	Reference(Any)	The target of the action
definition[x]		0..1		Description of the activity to be performed
definitionCanonical			canonical(ActivityDefinition \| ObservationDefinition \| PlanDefinition \| Questionnaire \| SpecimenDefinition)
definitionUri			uri
transform		0..1	canonical(StructureMap)	Transform to apply the template
dynamicValue		0..*	BackboneElement	Dynamic aspects of the definition
path		0..1	string	The path to the element to be set dynamically
expression		0..1	Expression	An expression that provides the dynamic value for the customization
action	C	0..*	see action	Sub action
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<RequestOrchestration xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier --></identifier>
 <instantiatesCanonical value="[canonical]"/><!-- 0..* Instantiates FHIR protocol or definition -->
 <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition -->
 <basedOn><!-- 0..* Reference(Any) Fulfills plan, proposal, or order --></basedOn>
 <replaces><!-- 0..* Reference(Any) Request(s) replaced by this request --></replaces>
 <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier>
 <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown -->
 <intent value="[code]"/><!-- 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <code><!-- 0..1 CodeableConcept What's being requested/ordered --></code>
 <subject><!-- 0..1 Reference(Group|Patient) Who the request orchestration is about --></subject>
 <encounter><!-- 0..1 Reference(Encounter) Created as part of --></encounter>
 <authoredOn value="[dateTime]"/><!-- 0..1 When the request orchestration was authored -->
 <author><!-- 0..1 Reference(Device|Practitioner|PractitionerRole) Device or practitioner that authored the request orchestration --></author>
 <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) Why the request orchestration is needed --></reason>
 <goal><!-- 0..* Reference(Goal) What goals --></goal>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <action>  <!-- 0..* Proposed actions, if any -->
  <linkId value="[string]"/><!-- 0..1 Pointer to specific item from the PlanDefinition -->
  <prefix value="[string]"/><!-- 0..1 User-visible prefix for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[string]"/><!-- 0..1 Short description of the action -->
  <textEquivalent value="[string]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
  <code><!-- 0..* CodeableConcept Code representing the meaning of the action or sub-actions --></code>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
  <goal><!-- 0..* Reference(Goal) What goals --></goal>
  <condition>  <!-- 0..* Whether or not the action is applicable -->
   <kind value="[code]"/><!-- 1..1 applicability | start | stop -->
   <expression><!-- 0..1 Expression Boolean-valued expression --></expression>
  </condition>
  <input>  <!-- 0..* Input data requirements -->
   <title value="[string]"/><!-- 0..1 User-visible title -->
   <requirement><!-- 0..1 DataRequirement What data is provided --></requirement>
   <relatedData value="[id]"/><!-- 0..1 What data is provided -->
  </input>
  <output>  <!-- 0..* Output data definition -->
   <title value="[string]"/><!-- 0..1 User-visible title -->
   <requirement><!-- 0..1 DataRequirement What data is provided --></requirement>
   <relatedData value="[string]"/><!-- 0..1 What data is provided -->
  </output>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <targetId value="[id]"/><!-- 1..1 What action this is related to -->
   <relationship value="[code]"/><!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- 0..1 dateTime|Age|Period|Duration|Range|Timing When the action should take place --></timing[x]>
  <location><!-- 0..1 CodeableReference(Location) Where it should happen --></location>
  <participant>  <!-- 0..* Who should perform the action -->
   <type value="[code]"/><!-- 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson -->
   <typeCanonical><!-- 0..1 canonical(CapabilityStatement) Who or what can participate --></typeCanonical>
   <typeReference><!-- 0..1 Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) Who or what can participate --></typeReference>
   <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.  --></role>
   <function><!-- 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc. --></function>
   <actor[x]><!-- 0..1 canonical(CapabilityStatement)|Reference(CareTeam|Device|
     DeviceDefinition|Endpoint|Group|HealthcareService|Location|Organization|
     Patient|Practitioner|PractitionerRole|RelatedPerson) Who/what is participating? --></actor[x]>
  </participant>
  <type><!-- 0..1 CodeableConcept create | update | remove | fire-event --></type>
  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->
  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <resource><!-- I 0..1 Reference(Any) The target of the action --></resource>
  <definition[x]><!-- 0..1 canonical(ActivityDefinition|ObservationDefinition|
    PlanDefinition|Questionnaire|SpecimenDefinition)|uri Description of the activity to be performed --></definition[x]>
  <transform><!-- 0..1 canonical(StructureMap) Transform to apply the template --></transform>
  <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
   <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
   <expression><!-- 0..1 Expression An expression that provides the dynamic value for the customization --></expression>
  </dynamicValue>
  <action><!-- I 0..* Content as for RequestOrchestration.action Sub action --></action>
 </action>
</RequestOrchestration>

JSON Template

{
  "resourceType" : "RequestOrchestration",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "instantiatesCanonical" : ["<canonical>"], // Instantiates FHIR protocol or definition
  "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
  "basedOn" : [{ Reference(Any) }], // Fulfills plan, proposal, or order
  "replaces" : [{ Reference(Any) }], // Request(s) replaced by this request
  "groupIdentifier" : { Identifier }, // Composite request this is part of
  "status" : "<code>", // R!  draft | active | on-hold | revoked | completed | entered-in-error | unknown
  "intent" : "<code>", // R!  proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | urgent | asap | stat
  "code" : { CodeableConcept }, // What's being requested/ordered
  "subject" : { Reference(Group|Patient) }, // Who the request orchestration is about
  "encounter" : { Reference(Encounter) }, // Created as part of
  "authoredOn" : "<dateTime>", // When the request orchestration was authored
  "author" : { Reference(Device|Practitioner|PractitionerRole) }, // Device or practitioner that authored the request orchestration
  "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) }], // Why the request orchestration is needed
  "goal" : [{ Reference(Goal) }], // What goals
  "note" : [{ Annotation }], // Additional notes about the response
  "action" : [{ // Proposed actions, if any
    "linkId" : "<string>", // Pointer to specific item from the PlanDefinition
    "prefix" : "<string>", // User-visible prefix for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<string>", // Short description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : [{ CodeableConcept }], // Code representing the meaning of the action or sub-actions
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "goal" : [{ Reference(Goal) }], // What goals
    "condition" : [{ // Whether or not the action is applicable
      "kind" : "<code>", // R!  applicability | start | stop
      "expression" : { Expression } // Boolean-valued expression
    }],
    "input" : [{ // Input data requirements
      "title" : "<string>", // User-visible title
      "requirement" : { DataRequirement }, // What data is provided
      "relatedData" : "<id>" // What data is provided
    }],
    "output" : [{ // Output data definition
      "title" : "<string>", // User-visible title
      "requirement" : { DataRequirement }, // What data is provided
      "relatedData" : "<string>" // What data is provided
    }],
    "relatedAction" : [{ // Relationship to another action
      "targetId" : "<id>", // R!  What action this is related to
      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration },
      "offsetRange" : { Range }
    }],
    // timing[x]: When the action should take place. One of these 6:
    "timingDateTime" : "<dateTime>",
    "timingAge" : { Age },
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "location" : { CodeableReference(Location) }, // Where it should happen
    "participant" : [{ // Who should perform the action
      "type" : "<code>", // careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      "typeCanonical" : "<canonical(CapabilityStatement)>", // Who or what can participate
      "typeReference" : { Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) }, // Who or what can participate
      "role" : { CodeableConcept }, // E.g. Nurse, Surgeon, Parent, etc. 
      "function" : { CodeableConcept }, // E.g. Author, Reviewer, Witness, etc.
      // actor[x]: Who/what is participating?. One of these 2:
      "actorCanonical" : "<canonical(CapabilityStatement)>",
      "actorReference" : { Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|
     HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) }
    }],
    "type" : { CodeableConcept }, // create | update | remove | fire-event
    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "requiredBehavior" : "<code>", // must | could | must-unless-documented
    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    "resource" : { Reference(Any) }, // I The target of the action
    // definition[x]: Description of the activity to be performed. One of these 2:
    "definitionCanonical" : "<canonical(ActivityDefinition|ObservationDefinition|PlanDefinition|Questionnaire|SpecimenDefinition)>",
    "definitionUri" : "<uri>",
    "transform" : "<canonical(StructureMap)>", // Transform to apply the template
    "dynamicValue" : [{ // Dynamic aspects of the definition
      "path" : "<string>", // The path to the element to be set dynamically
      "expression" : { Expression } // An expression that provides the dynamic value for the customization
    }],
    "action" : [{ Content as for RequestOrchestration.action }] // I Sub action
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:RequestOrchestration;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:RequestOrchestration.identifier [ Identifier ], ... ; # 0..* Business identifier
  fhir:RequestOrchestration.instantiatesCanonical [ canonical ], ... ; # 0..* Instantiates FHIR protocol or definition
  fhir:RequestOrchestration.instantiatesUri [ uri ], ... ; # 0..* Instantiates external protocol or definition
  fhir:RequestOrchestration.basedOn [ Reference(Any) ], ... ; # 0..* Fulfills plan, proposal, or order
  fhir:RequestOrchestration.replaces [ Reference(Any) ], ... ; # 0..* Request(s) replaced by this request
  fhir:RequestOrchestration.groupIdentifier [ Identifier ]; # 0..1 Composite request this is part of
  fhir:RequestOrchestration.status [ code ]; # 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown
  fhir:RequestOrchestration.intent [ code ]; # 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:RequestOrchestration.priority [ code ]; # 0..1 routine | urgent | asap | stat
  fhir:RequestOrchestration.code [ CodeableConcept ]; # 0..1 What's being requested/ordered
  fhir:RequestOrchestration.subject [ Reference(Group|Patient) ]; # 0..1 Who the request orchestration is about
  fhir:RequestOrchestration.encounter [ Reference(Encounter) ]; # 0..1 Created as part of
  fhir:RequestOrchestration.authoredOn [ dateTime ]; # 0..1 When the request orchestration was authored
  fhir:RequestOrchestration.author [ Reference(Device|Practitioner|PractitionerRole) ]; # 0..1 Device or practitioner that authored the request orchestration
  fhir:RequestOrchestration.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Why the request orchestration is needed
  fhir:RequestOrchestration.goal [ Reference(Goal) ], ... ; # 0..* What goals
  fhir:RequestOrchestration.note [ Annotation ], ... ; # 0..* Additional notes about the response
  fhir:RequestOrchestration.action [ # 0..* Proposed actions, if any
    fhir:RequestOrchestration.action.linkId [ string ]; # 0..1 Pointer to specific item from the PlanDefinition
    fhir:RequestOrchestration.action.prefix [ string ]; # 0..1 User-visible prefix for the action (e.g. 1. or A.)
    fhir:RequestOrchestration.action.title [ string ]; # 0..1 User-visible title
    fhir:RequestOrchestration.action.description [ string ]; # 0..1 Short description of the action
    fhir:RequestOrchestration.action.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:RequestOrchestration.action.priority [ code ]; # 0..1 routine | urgent | asap | stat
    fhir:RequestOrchestration.action.code [ CodeableConcept ], ... ; # 0..* Code representing the meaning of the action or sub-actions
    fhir:RequestOrchestration.action.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:RequestOrchestration.action.goal [ Reference(Goal) ], ... ; # 0..* What goals
    fhir:RequestOrchestration.action.condition [ # 0..* Whether or not the action is applicable
      fhir:RequestOrchestration.action.condition.kind [ code ]; # 1..1 applicability | start | stop
      fhir:RequestOrchestration.action.condition.expression [ Expression ]; # 0..1 Boolean-valued expression
    ], ...;
    fhir:RequestOrchestration.action.input [ # 0..* Input data requirements
      fhir:RequestOrchestration.action.input.title [ string ]; # 0..1 User-visible title
      fhir:RequestOrchestration.action.input.requirement [ DataRequirement ]; # 0..1 What data is provided
      fhir:RequestOrchestration.action.input.relatedData [ id ]; # 0..1 What data is provided
    ], ...;
    fhir:RequestOrchestration.action.output [ # 0..* Output data definition
      fhir:RequestOrchestration.action.output.title [ string ]; # 0..1 User-visible title
      fhir:RequestOrchestration.action.output.requirement [ DataRequirement ]; # 0..1 What data is provided
      fhir:RequestOrchestration.action.output.relatedData [ string ]; # 0..1 What data is provided
    ], ...;
    fhir:RequestOrchestration.action.relatedAction [ # 0..* Relationship to another action
      fhir:RequestOrchestration.action.relatedAction.targetId [ id ]; # 1..1 What action this is related to
      fhir:RequestOrchestration.action.relatedAction.relationship [ code ]; # 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      # RequestOrchestration.action.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:RequestOrchestration.action.relatedAction.offsetDuration [ Duration ]
        fhir:RequestOrchestration.action.relatedAction.offsetRange [ Range ]
    ], ...;
    # RequestOrchestration.action.timing[x] : 0..1 When the action should take place. One of these 6
      fhir:RequestOrchestration.action.timingDateTime [ dateTime ]
      fhir:RequestOrchestration.action.timingAge [ Age ]
      fhir:RequestOrchestration.action.timingPeriod [ Period ]
      fhir:RequestOrchestration.action.timingDuration [ Duration ]
      fhir:RequestOrchestration.action.timingRange [ Range ]
      fhir:RequestOrchestration.action.timingTiming [ Timing ]
    fhir:RequestOrchestration.action.location [ CodeableReference(Location) ]; # 0..1 Where it should happen
    fhir:RequestOrchestration.action.participant [ # 0..* Who should perform the action
      fhir:RequestOrchestration.action.participant.type [ code ]; # 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      fhir:RequestOrchestration.action.participant.typeCanonical [ canonical(CapabilityStatement) ]; # 0..1 Who or what can participate
      fhir:RequestOrchestration.action.participant.typeReference [ Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|
  Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who or what can participate
      fhir:RequestOrchestration.action.participant.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent, etc.
      fhir:RequestOrchestration.action.participant.function [ CodeableConcept ]; # 0..1 E.g. Author, Reviewer, Witness, etc.
      # RequestOrchestration.action.participant.actor[x] : 0..1 Who/what is participating?. One of these 2
        fhir:RequestOrchestration.action.participant.actorCanonical [ canonical(CapabilityStatement) ]
        fhir:RequestOrchestration.action.participant.actorReference [ Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|
  Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]
    ], ...;
    fhir:RequestOrchestration.action.type [ CodeableConcept ]; # 0..1 create | update | remove | fire-event
    fhir:RequestOrchestration.action.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:RequestOrchestration.action.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:RequestOrchestration.action.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:RequestOrchestration.action.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:RequestOrchestration.action.cardinalityBehavior [ code ]; # 0..1 single | multiple
    fhir:RequestOrchestration.action.resource [ Reference(Any) ]; # 0..1 I The target of the action
    # RequestOrchestration.action.definition[x] : 0..1 Description of the activity to be performed. One of these 2
      fhir:RequestOrchestration.action.definitionCanonical [ canonical(ActivityDefinition|ObservationDefinition|PlanDefinition|Questionnaire|
  SpecimenDefinition) ]
      fhir:RequestOrchestration.action.definitionUri [ uri ]
    fhir:RequestOrchestration.action.transform [ canonical(StructureMap) ]; # 0..1 Transform to apply the template
    fhir:RequestOrchestration.action.dynamicValue [ # 0..* Dynamic aspects of the definition
      fhir:RequestOrchestration.action.dynamicValue.path [ string ]; # 0..1 The path to the element to be set dynamically
      fhir:RequestOrchestration.action.dynamicValue.expression [ Expression ]; # 0..1 An expression that provides the dynamic value for the customization
    ], ...;
    fhir:RequestOrchestration.action.action [ See RequestOrchestration.action ], ... ; # 0..* I Sub action
  ], ...;
]

Changes since R4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
RequestOrchestration	TU		DomainResource	A set of related requests Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	Business identifier
instantiatesCanonical	Σ	0..*	canonical()	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn		0..*	Reference(Any)	Fulfills plan, proposal, or order
replaces		0..*	Reference(Any)	Request(s) replaced by this request
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	1..1	code	draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown RequestStatus (Required)
intent	?!Σ	1..1	code	proposal \| plan \| directive \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option RequestIntent (Required)
priority	Σ	0..1	code	routine \| urgent \| asap \| stat RequestPriority (Required)
code	Σ	0..1	CodeableConcept	What's being requested/ordered ActionCode (Example)
subject		0..1	Reference(Patient \| Group)	Who the request orchestration is about
encounter		0..1	Reference(Encounter)	Created as part of
authoredOn		0..1	dateTime	When the request orchestration was authored
author		0..1	Reference(Device \| Practitioner \| PractitionerRole)	Device or practitioner that authored the request orchestration
reason		0..*	CodeableReference(Condition \| Observation \| DiagnosticReport \| DocumentReference)	Why the request orchestration is needed ActionReasonCode (Example)
goal		0..*	Reference(Goal)	What goals
note		0..*	Annotation	Additional notes about the response
action	C	0..*	BackboneElement	Proposed actions, if any + Rule: Must have resource or action but not both
linkId		0..1	string	Pointer to specific item from the PlanDefinition
prefix		0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title		0..1	string	User-visible title
description	Σ	0..1	string	Short description of the action
textEquivalent	Σ	0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority		0..1	code	routine \| urgent \| asap \| stat RequestPriority (Required)
code		0..*	CodeableConcept	Code representing the meaning of the action or sub-actions ActionCode (Example)
documentation		0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
goal		0..*	Reference(Goal)	What goals
condition		0..*	BackboneElement	Whether or not the action is applicable
kind		1..1	code	applicability \| start \| stop ActionConditionKind (Required)
expression		0..1	Expression	Boolean-valued expression
input	C	0..*	BackboneElement	Input data requirements + Rule: Input data elements must have a requirement or a relatedData, but not both
title		0..1	string	User-visible title
requirement		0..1	DataRequirement	What data is provided
relatedData		0..1	id	What data is provided
output	C	0..*	BackboneElement	Output data definition + Rule: Output data element must have a requirement or a relatedData, but not both
title		0..1	string	User-visible title
requirement		0..1	DataRequirement	What data is provided
relatedData		0..1	string	What data is provided
relatedAction		0..*	BackboneElement	Relationship to another action
targetId		1..1	id	What action this is related to
relationship		1..1	code	before-start \| before \| before-end \| concurrent-with-start \| concurrent \| concurrent-with-end \| after-start \| after \| after-end ActionRelationshipType (Required)
offset[x]		0..1		Time offset for the relationship
offsetDuration			Duration
offsetRange			Range
timing[x]		0..1		When the action should take place
timingDateTime			dateTime
timingAge			Age
timingPeriod			Period
timingDuration			Duration
timingRange			Range
timingTiming			Timing
location		0..1	CodeableReference(Location)	Where it should happen
participant		0..*	BackboneElement	Who should perform the action
type		0..1	code	careteam \| device \| group \| healthcareservice \| location \| organization \| patient \| practitioner \| practitionerrole \| relatedperson ActionParticipantType (Required)
typeCanonical		0..1	canonical(CapabilityStatement)	Who or what can participate
typeReference		0..1	Reference(CareTeam \| Device \| DeviceDefinition \| Endpoint \| Group \| HealthcareService \| Location \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson)	Who or what can participate
role		0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent, etc. ActionParticipantRole (Example)
function		0..1	CodeableConcept	E.g. Author, Reviewer, Witness, etc. ActionParticipantFunction (Example)
actor[x]		0..1		Who/what is participating?
actorCanonical			canonical(CapabilityStatement)
actorReference			Reference(CareTeam \| Device \| DeviceDefinition \| Endpoint \| Group \| HealthcareService \| Location \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson)
type		0..1	CodeableConcept	create \| update \| remove \| fire-event ActionType (Extensible)
groupingBehavior		0..1	code	visual-group \| logical-group \| sentence-group ActionGroupingBehavior (Required)
selectionBehavior		0..1	code	any \| all \| all-or-none \| exactly-one \| at-most-one \| one-or-more ActionSelectionBehavior (Required)
requiredBehavior		0..1	code	must \| could \| must-unless-documented ActionRequiredBehavior (Required)
precheckBehavior		0..1	code	yes \| no ActionPrecheckBehavior (Required)
cardinalityBehavior		0..1	code	single \| multiple ActionCardinalityBehavior (Required)
resource	C	0..1	Reference(Any)	The target of the action
definition[x]		0..1		Description of the activity to be performed
definitionCanonical			canonical(ActivityDefinition \| ObservationDefinition \| PlanDefinition \| Questionnaire \| SpecimenDefinition)
definitionUri			uri
transform		0..1	canonical(StructureMap)	Transform to apply the template
dynamicValue		0..*	BackboneElement	Dynamic aspects of the definition
path		0..1	string	The path to the element to be set dynamically
expression		0..1	Expression	An expression that provides the dynamic value for the customization
action	C	0..*	see action	Sub action
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<RequestOrchestration xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier --></identifier>
 <instantiatesCanonical value="[canonical]"/><!-- 0..* Instantiates FHIR protocol or definition -->
 <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition -->
 <basedOn><!-- 0..* Reference(Any) Fulfills plan, proposal, or order --></basedOn>
 <replaces><!-- 0..* Reference(Any) Request(s) replaced by this request --></replaces>
 <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier>
 <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown -->
 <intent value="[code]"/><!-- 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option -->
 <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
 <code><!-- 0..1 CodeableConcept What's being requested/ordered --></code>
 <subject><!-- 0..1 Reference(Group|Patient) Who the request orchestration is about --></subject>
 <encounter><!-- 0..1 Reference(Encounter) Created as part of --></encounter>
 <authoredOn value="[dateTime]"/><!-- 0..1 When the request orchestration was authored -->
 <author><!-- 0..1 Reference(Device|Practitioner|PractitionerRole) Device or practitioner that authored the request orchestration --></author>
 <reason><!-- 0..* CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) Why the request orchestration is needed --></reason>
 <goal><!-- 0..* Reference(Goal) What goals --></goal>
 <note><!-- 0..* Annotation Additional notes about the response --></note>
 <action>  <!-- 0..* Proposed actions, if any -->
  <linkId value="[string]"/><!-- 0..1 Pointer to specific item from the PlanDefinition -->
  <prefix value="[string]"/><!-- 0..1 User-visible prefix for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[string]"/><!-- 0..1 Short description of the action -->
  <textEquivalent value="[string]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
  <code><!-- 0..* CodeableConcept Code representing the meaning of the action or sub-actions --></code>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
  <goal><!-- 0..* Reference(Goal) What goals --></goal>
  <condition>  <!-- 0..* Whether or not the action is applicable -->
   <kind value="[code]"/><!-- 1..1 applicability | start | stop -->
   <expression><!-- 0..1 Expression Boolean-valued expression --></expression>
  </condition>
  <input>  <!-- 0..* Input data requirements -->
   <title value="[string]"/><!-- 0..1 User-visible title -->
   <requirement><!-- 0..1 DataRequirement What data is provided --></requirement>
   <relatedData value="[id]"/><!-- 0..1 What data is provided -->
  </input>
  <output>  <!-- 0..* Output data definition -->
   <title value="[string]"/><!-- 0..1 User-visible title -->
   <requirement><!-- 0..1 DataRequirement What data is provided --></requirement>
   <relatedData value="[string]"/><!-- 0..1 What data is provided -->
  </output>
  <relatedAction>  <!-- 0..* Relationship to another action -->
   <targetId value="[id]"/><!-- 1..1 What action this is related to -->
   <relationship value="[code]"/><!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- 0..1 dateTime|Age|Period|Duration|Range|Timing When the action should take place --></timing[x]>
  <location><!-- 0..1 CodeableReference(Location) Where it should happen --></location>
  <participant>  <!-- 0..* Who should perform the action -->
   <type value="[code]"/><!-- 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson -->
   <typeCanonical><!-- 0..1 canonical(CapabilityStatement) Who or what can participate --></typeCanonical>
   <typeReference><!-- 0..1 Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) Who or what can participate --></typeReference>
   <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.  --></role>
   <function><!-- 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc. --></function>
   <actor[x]><!-- 0..1 canonical(CapabilityStatement)|Reference(CareTeam|Device|
     DeviceDefinition|Endpoint|Group|HealthcareService|Location|Organization|
     Patient|Practitioner|PractitionerRole|RelatedPerson) Who/what is participating? --></actor[x]>
  </participant>
  <type><!-- 0..1 CodeableConcept create | update | remove | fire-event --></type>
  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->
  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <resource><!-- I 0..1 Reference(Any) The target of the action --></resource>
  <definition[x]><!-- 0..1 canonical(ActivityDefinition|ObservationDefinition|
    PlanDefinition|Questionnaire|SpecimenDefinition)|uri Description of the activity to be performed --></definition[x]>
  <transform><!-- 0..1 canonical(StructureMap) Transform to apply the template --></transform>
  <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
   <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
   <expression><!-- 0..1 Expression An expression that provides the dynamic value for the customization --></expression>
  </dynamicValue>
  <action><!-- I 0..* Content as for RequestOrchestration.action Sub action --></action>
 </action>
</RequestOrchestration>

JSON Template

{
  "resourceType" : "RequestOrchestration",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "instantiatesCanonical" : ["<canonical>"], // Instantiates FHIR protocol or definition
  "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
  "basedOn" : [{ Reference(Any) }], // Fulfills plan, proposal, or order
  "replaces" : [{ Reference(Any) }], // Request(s) replaced by this request
  "groupIdentifier" : { Identifier }, // Composite request this is part of
  "status" : "<code>", // R!  draft | active | on-hold | revoked | completed | entered-in-error | unknown
  "intent" : "<code>", // R!  proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | urgent | asap | stat
  "code" : { CodeableConcept }, // What's being requested/ordered
  "subject" : { Reference(Group|Patient) }, // Who the request orchestration is about
  "encounter" : { Reference(Encounter) }, // Created as part of
  "authoredOn" : "<dateTime>", // When the request orchestration was authored
  "author" : { Reference(Device|Practitioner|PractitionerRole) }, // Device or practitioner that authored the request orchestration
  "reason" : [{ CodeableReference(Condition|DiagnosticReport|DocumentReference|
   Observation) }], // Why the request orchestration is needed
  "goal" : [{ Reference(Goal) }], // What goals
  "note" : [{ Annotation }], // Additional notes about the response
  "action" : [{ // Proposed actions, if any
    "linkId" : "<string>", // Pointer to specific item from the PlanDefinition
    "prefix" : "<string>", // User-visible prefix for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<string>", // Short description of the action
    "textEquivalent" : "<string>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : [{ CodeableConcept }], // Code representing the meaning of the action or sub-actions
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "goal" : [{ Reference(Goal) }], // What goals
    "condition" : [{ // Whether or not the action is applicable
      "kind" : "<code>", // R!  applicability | start | stop
      "expression" : { Expression } // Boolean-valued expression
    }],
    "input" : [{ // Input data requirements
      "title" : "<string>", // User-visible title
      "requirement" : { DataRequirement }, // What data is provided
      "relatedData" : "<id>" // What data is provided
    }],
    "output" : [{ // Output data definition
      "title" : "<string>", // User-visible title
      "requirement" : { DataRequirement }, // What data is provided
      "relatedData" : "<string>" // What data is provided
    }],
    "relatedAction" : [{ // Relationship to another action
      "targetId" : "<id>", // R!  What action this is related to
      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration },
      "offsetRange" : { Range }
    }],
    // timing[x]: When the action should take place. One of these 6:
    "timingDateTime" : "<dateTime>",
    "timingAge" : { Age },
    "timingPeriod" : { Period },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "location" : { CodeableReference(Location) }, // Where it should happen
    "participant" : [{ // Who should perform the action
      "type" : "<code>", // careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      "typeCanonical" : "<canonical(CapabilityStatement)>", // Who or what can participate
      "typeReference" : { Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) }, // Who or what can participate
      "role" : { CodeableConcept }, // E.g. Nurse, Surgeon, Parent, etc. 
      "function" : { CodeableConcept }, // E.g. Author, Reviewer, Witness, etc.
      // actor[x]: Who/what is participating?. One of these 2:
      "actorCanonical" : "<canonical(CapabilityStatement)>",
      "actorReference" : { Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|
     HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) }
    }],
    "type" : { CodeableConcept }, // create | update | remove | fire-event
    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "requiredBehavior" : "<code>", // must | could | must-unless-documented
    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    "resource" : { Reference(Any) }, // I The target of the action
    // definition[x]: Description of the activity to be performed. One of these 2:
    "definitionCanonical" : "<canonical(ActivityDefinition|ObservationDefinition|PlanDefinition|Questionnaire|SpecimenDefinition)>",
    "definitionUri" : "<uri>",
    "transform" : "<canonical(StructureMap)>", // Transform to apply the template
    "dynamicValue" : [{ // Dynamic aspects of the definition
      "path" : "<string>", // The path to the element to be set dynamically
      "expression" : { Expression } // An expression that provides the dynamic value for the customization
    }],
    "action" : [{ Content as for RequestOrchestration.action }] // I Sub action
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:RequestOrchestration;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:RequestOrchestration.identifier [ Identifier ], ... ; # 0..* Business identifier
  fhir:RequestOrchestration.instantiatesCanonical [ canonical ], ... ; # 0..* Instantiates FHIR protocol or definition
  fhir:RequestOrchestration.instantiatesUri [ uri ], ... ; # 0..* Instantiates external protocol or definition
  fhir:RequestOrchestration.basedOn [ Reference(Any) ], ... ; # 0..* Fulfills plan, proposal, or order
  fhir:RequestOrchestration.replaces [ Reference(Any) ], ... ; # 0..* Request(s) replaced by this request
  fhir:RequestOrchestration.groupIdentifier [ Identifier ]; # 0..1 Composite request this is part of
  fhir:RequestOrchestration.status [ code ]; # 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown
  fhir:RequestOrchestration.intent [ code ]; # 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  fhir:RequestOrchestration.priority [ code ]; # 0..1 routine | urgent | asap | stat
  fhir:RequestOrchestration.code [ CodeableConcept ]; # 0..1 What's being requested/ordered
  fhir:RequestOrchestration.subject [ Reference(Group|Patient) ]; # 0..1 Who the request orchestration is about
  fhir:RequestOrchestration.encounter [ Reference(Encounter) ]; # 0..1 Created as part of
  fhir:RequestOrchestration.authoredOn [ dateTime ]; # 0..1 When the request orchestration was authored
  fhir:RequestOrchestration.author [ Reference(Device|Practitioner|PractitionerRole) ]; # 0..1 Device or practitioner that authored the request orchestration
  fhir:RequestOrchestration.reason [ CodeableReference(Condition|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Why the request orchestration is needed
  fhir:RequestOrchestration.goal [ Reference(Goal) ], ... ; # 0..* What goals
  fhir:RequestOrchestration.note [ Annotation ], ... ; # 0..* Additional notes about the response
  fhir:RequestOrchestration.action [ # 0..* Proposed actions, if any
    fhir:RequestOrchestration.action.linkId [ string ]; # 0..1 Pointer to specific item from the PlanDefinition
    fhir:RequestOrchestration.action.prefix [ string ]; # 0..1 User-visible prefix for the action (e.g. 1. or A.)
    fhir:RequestOrchestration.action.title [ string ]; # 0..1 User-visible title
    fhir:RequestOrchestration.action.description [ string ]; # 0..1 Short description of the action
    fhir:RequestOrchestration.action.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:RequestOrchestration.action.priority [ code ]; # 0..1 routine | urgent | asap | stat
    fhir:RequestOrchestration.action.code [ CodeableConcept ], ... ; # 0..* Code representing the meaning of the action or sub-actions
    fhir:RequestOrchestration.action.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:RequestOrchestration.action.goal [ Reference(Goal) ], ... ; # 0..* What goals
    fhir:RequestOrchestration.action.condition [ # 0..* Whether or not the action is applicable
      fhir:RequestOrchestration.action.condition.kind [ code ]; # 1..1 applicability | start | stop
      fhir:RequestOrchestration.action.condition.expression [ Expression ]; # 0..1 Boolean-valued expression
    ], ...;
    fhir:RequestOrchestration.action.input [ # 0..* Input data requirements
      fhir:RequestOrchestration.action.input.title [ string ]; # 0..1 User-visible title
      fhir:RequestOrchestration.action.input.requirement [ DataRequirement ]; # 0..1 What data is provided
      fhir:RequestOrchestration.action.input.relatedData [ id ]; # 0..1 What data is provided
    ], ...;
    fhir:RequestOrchestration.action.output [ # 0..* Output data definition
      fhir:RequestOrchestration.action.output.title [ string ]; # 0..1 User-visible title
      fhir:RequestOrchestration.action.output.requirement [ DataRequirement ]; # 0..1 What data is provided
      fhir:RequestOrchestration.action.output.relatedData [ string ]; # 0..1 What data is provided
    ], ...;
    fhir:RequestOrchestration.action.relatedAction [ # 0..* Relationship to another action
      fhir:RequestOrchestration.action.relatedAction.targetId [ id ]; # 1..1 What action this is related to
      fhir:RequestOrchestration.action.relatedAction.relationship [ code ]; # 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      # RequestOrchestration.action.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:RequestOrchestration.action.relatedAction.offsetDuration [ Duration ]
        fhir:RequestOrchestration.action.relatedAction.offsetRange [ Range ]
    ], ...;
    # RequestOrchestration.action.timing[x] : 0..1 When the action should take place. One of these 6
      fhir:RequestOrchestration.action.timingDateTime [ dateTime ]
      fhir:RequestOrchestration.action.timingAge [ Age ]
      fhir:RequestOrchestration.action.timingPeriod [ Period ]
      fhir:RequestOrchestration.action.timingDuration [ Duration ]
      fhir:RequestOrchestration.action.timingRange [ Range ]
      fhir:RequestOrchestration.action.timingTiming [ Timing ]
    fhir:RequestOrchestration.action.location [ CodeableReference(Location) ]; # 0..1 Where it should happen
    fhir:RequestOrchestration.action.participant [ # 0..* Who should perform the action
      fhir:RequestOrchestration.action.participant.type [ code ]; # 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      fhir:RequestOrchestration.action.participant.typeCanonical [ canonical(CapabilityStatement) ]; # 0..1 Who or what can participate
      fhir:RequestOrchestration.action.participant.typeReference [ Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|
  Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who or what can participate
      fhir:RequestOrchestration.action.participant.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent, etc.
      fhir:RequestOrchestration.action.participant.function [ CodeableConcept ]; # 0..1 E.g. Author, Reviewer, Witness, etc.
      # RequestOrchestration.action.participant.actor[x] : 0..1 Who/what is participating?. One of these 2
        fhir:RequestOrchestration.action.participant.actorCanonical [ canonical(CapabilityStatement) ]
        fhir:RequestOrchestration.action.participant.actorReference [ Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|
  Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]
    ], ...;
    fhir:RequestOrchestration.action.type [ CodeableConcept ]; # 0..1 create | update | remove | fire-event
    fhir:RequestOrchestration.action.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:RequestOrchestration.action.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:RequestOrchestration.action.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:RequestOrchestration.action.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:RequestOrchestration.action.cardinalityBehavior [ code ]; # 0..1 single | multiple
    fhir:RequestOrchestration.action.resource [ Reference(Any) ]; # 0..1 I The target of the action
    # RequestOrchestration.action.definition[x] : 0..1 Description of the activity to be performed. One of these 2
      fhir:RequestOrchestration.action.definitionCanonical [ canonical(ActivityDefinition|ObservationDefinition|PlanDefinition|Questionnaire|
  SpecimenDefinition) ]
      fhir:RequestOrchestration.action.definitionUri [ uri ]
    fhir:RequestOrchestration.action.transform [ canonical(StructureMap) ]; # 0..1 Transform to apply the template
    fhir:RequestOrchestration.action.dynamicValue [ # 0..* Dynamic aspects of the definition
      fhir:RequestOrchestration.action.dynamicValue.path [ string ]; # 0..1 The path to the element to be set dynamically
      fhir:RequestOrchestration.action.dynamicValue.expression [ Expression ]; # 0..1 An expression that provides the dynamic value for the customization
    ], ...;
    fhir:RequestOrchestration.action.action [ See RequestOrchestration.action ], ... ; # 0..* I Sub action
  ], ...;
]

Changes since Release 4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

14.17.3.1 Terminology Bindings

Path	Definition	Type	Reference
RequestOrchestration.status	Codes identifying the lifecycle stage of a request.	Required	RequestStatus
RequestOrchestration.intent	Codes indicating the degree of authority/intentionality associated with a request.	Required	RequestIntent
RequestOrchestration.priority	Identifies the level of importance to be assigned to actioning the request.	Required	RequestPriority
RequestOrchestration.code	Provides examples of actions to be performed.	Example	ActionCode
RequestOrchestration.reason	Provides examples of reasons for actions to be performed.	Example	ActionReasonCode
RequestOrchestration.action.priority	Identifies the level of importance to be assigned to actioning the request.	Required	RequestPriority
RequestOrchestration.action.code	Provides examples of actions to be performed.	Example	ActionCode
RequestOrchestration.action.condition.kind	Defines the kinds of conditions that can appear on actions.	Required	ActionConditionKind
RequestOrchestration.action.relatedAction.relationship	Defines the types of relationships between actions.	Required	ActionRelationshipType
RequestOrchestration.action.participant.type	The type of participant for the action.	Required	ActionParticipantType
RequestOrchestration.action.participant.role	Either a practitioner role or a relationship type. Note from UTG import - may have been a temporary entry that subsequently disappeared from the FHIR source; unable to locate. Version set to 0.1.0	Example	ActionParticipantRole
RequestOrchestration.action.participant.function	The function performed by the participant for the action.	Example	ActionParticipantFunction
RequestOrchestration.action.type	The type of action to be performed.	Extensible	ActionType
RequestOrchestration.action.groupingBehavior	Defines organization behavior of a group.	Required	ActionGroupingBehavior
RequestOrchestration.action.selectionBehavior	Defines selection behavior of a group.	Required	ActionSelectionBehavior
RequestOrchestration.action.requiredBehavior	Defines expectations around whether an action or action group is required.	Required	ActionRequiredBehavior
RequestOrchestration.action.precheckBehavior	Defines selection frequency behavior for an action or group.	Required	ActionPrecheckBehavior
RequestOrchestration.action.cardinalityBehavior	Defines behavior for an action or a group for how many times that item may be repeated.	Required	ActionCardinalityBehavior

Path

Definition

Type

Reference

RequestOrchestration.status

Codes identifying the lifecycle stage of a request.

Required

RequestStatus

RequestOrchestration.intent

Codes indicating the degree of authority/intentionality associated with a request.

Required

RequestIntent

RequestOrchestration.priority

Identifies the level of importance to be assigned to actioning the request.

Required

RequestPriority

RequestOrchestration.code

Provides examples of actions to be performed.

Example

ActionCode

RequestOrchestration.reason

Provides examples of reasons for actions to be performed.

Example

ActionReasonCode

RequestOrchestration.action.priority

Identifies the level of importance to be assigned to actioning the request.

Required

RequestPriority

RequestOrchestration.action.code

Provides examples of actions to be performed.

Example

ActionCode

RequestOrchestration.action.condition.kind

Defines the kinds of conditions that can appear on actions.

Required

ActionConditionKind

RequestOrchestration.action.relatedAction.relationship

Defines the types of relationships between actions.

Required

ActionRelationshipType

RequestOrchestration.action.participant.type

The type of participant for the action.

Required

ActionParticipantType

RequestOrchestration.action.participant.role

Either a practitioner role or a relationship type. Note from UTG import - may have been a temporary entry that subsequently disappeared from the FHIR source; unable to locate. Version set to 0.1.0

Example

ActionParticipantRole icon

RequestOrchestration.action.participant.function

The function performed by the participant for the action.

Example

ActionParticipantFunction

RequestOrchestration.action.type

The type of action to be performed.

Extensible

ActionType

RequestOrchestration.action.groupingBehavior

Defines organization behavior of a group.

Required

ActionGroupingBehavior

RequestOrchestration.action.selectionBehavior

Defines selection behavior of a group.

Required

ActionSelectionBehavior

RequestOrchestration.action.requiredBehavior

Defines expectations around whether an action or action group is required.

Required

ActionRequiredBehavior

RequestOrchestration.action.precheckBehavior

Defines selection frequency behavior for an action or group.

Required

ActionPrecheckBehavior

RequestOrchestration.action.cardinalityBehavior

Defines behavior for an action or a group for how many times that item may be repeated.

Required

ActionCardinalityBehavior

14.17.3.2 Constraints

UniqueKey

Level

Location

Description

Expression

pld-0

Rule

RequestOrchestration.action.input

Input data elements must have a requirement or a relatedData, but not both

requirement.exists() xor relatedData.exists()

pld-1

Rule

RequestOrchestration.action.output

Output data element must have a requirement or a relatedData, but not both

requirement.exists() xor relatedData.exists()

rqg-1

Rule

RequestOrchestration.action

Must have resource or action but not both

resource.exists() != action.exists()

14.17.4 Usage

The RequestOrchestration resource is used when there are temporal, co-occurrence or other dependencies between one or more steps of an overall workflow. For example, "do procedure A or procedure B, but not both" or "do procedure A after procedure B" or "Act on this ServiceRequest, then use the value of that observation in the calculation of the dose of this subsequent MedicationRequest". RequestOrchestrations that define actions (i.e. that are more than just narrative representations) will always reference other Request resources with an intent of "option".

Each "option" request can only be interpreted in the context of a RequestOrchestration that references it. This is because the RequestOrchestration defines the context in which the option request may/should/must occur, including any triggers, timing constraints, choices, sequencing requirements, etc. Typically such "option" requests will be contained resources due to this dependency. However, in some cases "option" requests may be stand-alone if they are immutable or tightly tied to a ActivityDefinition such that the option resources can safely be referenced without a risk of their content/intent changing

Elements in the "option" requests may include extensions for timing or other elements that allow calculation based on information found in the RequestOrchestration or other referenced "option" resources, as well as to expose elements within the "option" resource for referencing in other "option" resources. These extensions are:

TODO

The RequestOrchestration and all of its referenced "option" Requests are treated as a single integrated Request whose status is the status of the RequestOrchestration. If there is a need to manage statuses of the different parts, separately, refer to the guidance here.

14.17.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
author	reference	The author of the request orchestration	RequestOrchestration.author (Practitioner, Device, PractitionerRole)
authored	date	The date the request orchestration was authored	RequestOrchestration.authoredOn
code	token	The code of the request orchestration	RequestOrchestration.code
encounter	reference	The encounter the request orchestration applies to	RequestOrchestration.encounter (Encounter)
group-identifier	token	The group identifier for the request orchestration	RequestOrchestration.groupIdentifier
identifier	token	External identifiers for the request orchestration	RequestOrchestration.identifier
instantiates-canonical	reference	The FHIR-based definition from which the request orchestration is realized	RequestOrchestration.instantiatesCanonical
instantiates-uri	uri	The external definition from which the request orchestration is realized	RequestOrchestration.instantiatesUri
intent	token	The intent of the request orchestration	RequestOrchestration.intent
participant	reference	The participant in the requests in the orchestration	RequestOrchestration.action.participant.actor.as(Reference) \| RequestOrchestration.action.participant.actor.as(canonical) (Group, Organization, CareTeam, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Practitioner, Endpoint, CapabilityStatement, DeviceDefinition, Location)
patient	reference	The identity of a patient to search for request orchestrations	RequestOrchestration.subject.where(resolve() is Patient) (Patient)
priority	token	The priority of the request orchestration	RequestOrchestration.priority
status	token	The status of the request orchestration	RequestOrchestration.status
subject	reference	The subject that the request orchestration is about	RequestOrchestration.subject (Group, Patient)