Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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 GroupMaturity Level: 2 Trial UseSecurity 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

14.17.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestOrchestration TUDomainResourceA set of related requests

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifier

... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition

... instantiatesUri Σ0..*uriInstantiates external protocol or definition

... replaces 0..*Reference(Any)Request(s) replaced by this request

... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
RequestStatus (Required)
... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required)
... priority Σ0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
... code Σ0..1CodeableConceptWhat's being requested/ordered
ActionCode (Example)
... subject 0..1Reference(Patient | Group)Who the request orchestration is about
... encounter 0..1Reference(Encounter)Created as part of
... authoredOn 0..1dateTimeWhen the request orchestration was authored
... author 0..1Reference(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..*AnnotationAdditional notes about the response

... action C0..*BackboneElementProposed actions, if any
+ Rule: Must have resource or action but not both

.... linkId 0..1stringPointer to specific item from the PlanDefinition
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description Σ0..1stringShort description of the action
.... textEquivalent Σ0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
ActionCode (Example)

.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action

.... goal 0..*Reference(Goal)What goals

.... condition 0..*BackboneElementWhether or not the action is applicable

..... kind 1..1codeapplicability | start | stop
ActionConditionKind (Required)
..... expression 0..1ExpressionBoolean-valued expression
.... input C0..*BackboneElementInput data requirements
+ Rule: Input data elements must have a requirement or a relatedData, but not both

..... title 0..1stringUser-visible title
..... requirement 0..1DataRequirementWhat data is provided
..... relatedData 0..1idWhat data is provided
.... output C0..*BackboneElementOutput data definition
+ Rule: Output data element must have a requirement or a relatedData, but not both

..... title 0..1stringUser-visible title
..... requirement 0..1DataRequirementWhat data is provided
..... relatedData 0..1stringWhat data is provided
.... relatedAction 0..*BackboneElementRelationship to another action

..... targetId 1..1idWhat action this is related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
ActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... location 0..1CodeableReference(Location)Where it should happen
.... participant 0..*BackboneElementWho should perform the action

..... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
ActionParticipantType (Required)
..... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
..... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc.
ActionParticipantRole icon (Example)
..... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc.
ActionParticipantFunction (Example)
..... actor[x] 0..1Who/what is participating?
...... actorCanonicalcanonical(CapabilityStatement)
...... actorReferenceReference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
.... type 0..1CodeableConceptcreate | update | remove | fire-event
ActionType (Extensible)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
ActionGroupingBehavior (Required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
ActionSelectionBehavior (Required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
ActionRequiredBehavior (Required)
.... precheckBehavior 0..1codeyes | no
ActionPrecheckBehavior (Required)
.... cardinalityBehavior 0..1codesingle | multiple
ActionCardinalityBehavior (Required)
.... resource C0..1Reference(Any)The target of the action
.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition

..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action C0..*see actionSub action


doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

RequestOrchestration (DomainResource)Allows a service to provide a unique, business identifier for the requestidentifier : Identifier [0..*]A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this requestinstantiatesCanonical : canonical [0..*] « »A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this requestinstantiatesUri : uri [0..*]A plan, proposal or order that is fulfilled in whole or in part by this requestbasedOn : Reference [0..*] « Any »Completed or terminated request(s) whose function is taken by this new requestreplaces : Reference [0..*] « Any »A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar formgroupIdentifier : Identifier [0..1]The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)RequestStatus! »Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain (this element modifies the meaning of other elements)intent : code [1..1] « null (Strength=Required)RequestIntent! »Indicates how quickly the request should be addressed with respect to other requestspriority : code [0..1] « null (Strength=Required)RequestPriority! »A code that identifies what the overall request orchestration iscode : CodeableConcept [0..1] « null (Strength=Example)ActionCode?? »The subject for which the request orchestration was createdsubject : Reference [0..1] « Patient|Group »Describes the context of the request orchestration, if anyencounter : Reference [0..1] « Encounter »Indicates when the request orchestration was createdauthoredOn : dateTime [0..1]Provides a reference to the author of the request orchestrationauthor : Reference [0..1] « Device|Practitioner|PractitionerRole »Describes the reason for the request orchestration in coded or textual formreason : CodeableReference [0..*] « Condition|Observation| DiagnosticReport|DocumentReference; null (Strength=Example)ActionReasonCode?? »Goals that are intended to be achieved by following the requests in this RequestOrchestrationgoal : Reference [0..*] « Goal »Provides a mechanism to communicate additional information about the responsenote : Annotation [0..*]ActionThe linkId of the action from the PlanDefinition that corresponds to this action in the RequestOrchestration resourcelinkId : string [0..1]A user-visible prefix for the action. For example a section or item numbering such as 1. or Aprefix : string [0..1]The title of the action displayed to a usertitle : string [0..1]A short description of the action used to provide a summary to display to the userdescription : string [0..1]A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamicallytextEquivalent : string [0..1]Indicates how quickly the action should be addressed with respect to other actionspriority : code [0..1] « null (Strength=Required)RequestPriority! »A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation templatecode : CodeableConcept [0..*] « null (Strength=Example)ActionCode?? »Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedArtifact [0..*]Goals that are intended to be achieved by following the requests in this actiongoal : Reference [0..*] « Goal »An optional value describing when the action should be performedtiming[x] : DataType [0..1] « dateTime|Age|Period|Duration|Range| Timing »Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etclocation : CodeableReference [0..1] « Location »The type of action to perform (create, update, remove)type : CodeableConcept [0..1] « null (Strength=Extensible)ActionType+ »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « null (Strength=Required)ActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « null (Strength=Required)ActionSelectionBehavior! »Defines expectations around whether an action is requiredrequiredBehavior : code [0..1] « null (Strength=Required)ActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « null (Strength=Required)ActionPrecheckBehavior! »Defines whether the action can be selected multiple timescardinalityBehavior : code [0..1] « null (Strength=Required)ActionCardinalityBehavior! »The resource that is the target of the action (e.g. CommunicationRequest)resource : Reference [0..1] « Any » « This element has or is affected by some invariantsC »A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captureddefinition[x] : PrimitiveType [0..1] « canonical(ActivityDefinition| ObservationDefinition|PlanDefinition|Questionnaire| SpecimenDefinition)|uri »A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the inputtransform : canonical [0..1] « StructureMap »ConditionThe kind of conditionkind : code [1..1] « null (Strength=Required)ActionConditionKind! »An expression that returns true or false, indicating whether or not the condition is satisfiedexpression : Expression [0..1]InputA human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readerstitle : string [0..1]Defines the data that is to be provided as input to the actionrequirement : DataRequirement [0..1]Points to an existing input or output element that provides data to this inputrelatedData : id [0..1]OutputA human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readerstitle : string [0..1]Defines the data that results as output from the actionrequirement : DataRequirement [0..1]Points to an existing input or output element that is results as output from the actionrelatedData : string [0..1]RelatedActionThe element id of the target related actiontargetId : id [1..1]The relationship of this action to the related actionrelationship : code [1..1] « null (Strength=Required)ActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : DataType [0..1] « Duration|Range »ParticipantThe type of participant in the actiontype : code [0..1] « null (Strength=Required)ActionParticipantType! »The type of participant in the actiontypeCanonical : canonical [0..1] « CapabilityStatement »The type of participant in the actiontypeReference : Reference [0..1] « CareTeam|Device|DeviceDefinition| Endpoint|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson »The role the participant should play in performing the described actionrole : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantRole?? »Indicates how the actor will be involved in the action - author, reviewer, witness, etcfunction : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantFunction?? »A reference to the actual participantactor[x] : DataType [0..1] « canonical(CapabilityStatement)| Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group| HealthcareService|Location|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) »DynamicValueThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details)path : string [0..1]An expression specifying the value of the customized elementexpression : Expression [0..1]Defines input data requirements for the actioninput[0..*]Defines the outputs of the action, if anyoutput[0..*]A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[0..*]The participant that should perform or be responsible for this actionparticipant[0..*]Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the resultdynamicValue[0..*]Sub actionsaction[0..*]The actions, if any, produced by the evaluation of the artifactaction[0..*]

XML Template

<RequestOrchestration xmlns="http://hl7.org/fhir"> doco
 <!-- 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. icon --></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

{doco
  "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. icon
      "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/> .doco


[ 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestOrchestration TUDomainResourceA set of related requests

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifier

... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition

... instantiatesUri Σ0..*uriInstantiates external protocol or definition

... replaces 0..*Reference(Any)Request(s) replaced by this request

... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
RequestStatus (Required)
... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
RequestIntent (Required)
... priority Σ0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
... code Σ0..1CodeableConceptWhat's being requested/ordered
ActionCode (Example)
... subject 0..1Reference(Patient | Group)Who the request orchestration is about
... encounter 0..1Reference(Encounter)Created as part of
... authoredOn 0..1dateTimeWhen the request orchestration was authored
... author 0..1Reference(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..*AnnotationAdditional notes about the response

... action C0..*BackboneElementProposed actions, if any
+ Rule: Must have resource or action but not both

.... linkId 0..1stringPointer to specific item from the PlanDefinition
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description Σ0..1stringShort description of the action
.... textEquivalent Σ0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
RequestPriority (Required)
.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
ActionCode (Example)

.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action

.... goal 0..*Reference(Goal)What goals

.... condition 0..*BackboneElementWhether or not the action is applicable

..... kind 1..1codeapplicability | start | stop
ActionConditionKind (Required)
..... expression 0..1ExpressionBoolean-valued expression
.... input C0..*BackboneElementInput data requirements
+ Rule: Input data elements must have a requirement or a relatedData, but not both

..... title 0..1stringUser-visible title
..... requirement 0..1DataRequirementWhat data is provided
..... relatedData 0..1idWhat data is provided
.... output C0..*BackboneElementOutput data definition
+ Rule: Output data element must have a requirement or a relatedData, but not both

..... title 0..1stringUser-visible title
..... requirement 0..1DataRequirementWhat data is provided
..... relatedData 0..1stringWhat data is provided
.... relatedAction 0..*BackboneElementRelationship to another action

..... targetId 1..1idWhat action this is related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
ActionRelationshipType (Required)
..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... location 0..1CodeableReference(Location)Where it should happen
.... participant 0..*BackboneElementWho should perform the action

..... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
ActionParticipantType (Required)
..... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
..... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)Who or what can participate
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc.
ActionParticipantRole icon (Example)
..... function 0..1CodeableConceptE.g. Author, Reviewer, Witness, etc.
ActionParticipantFunction (Example)
..... actor[x] 0..1Who/what is participating?
...... actorCanonicalcanonical(CapabilityStatement)
...... actorReferenceReference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
.... type 0..1CodeableConceptcreate | update | remove | fire-event
ActionType (Extensible)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
ActionGroupingBehavior (Required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
ActionSelectionBehavior (Required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
ActionRequiredBehavior (Required)
.... precheckBehavior 0..1codeyes | no
ActionPrecheckBehavior (Required)
.... cardinalityBehavior 0..1codesingle | multiple
ActionCardinalityBehavior (Required)
.... resource C0..1Reference(Any)The target of the action
.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition

..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action C0..*see actionSub action


doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

RequestOrchestration (DomainResource)Allows a service to provide a unique, business identifier for the requestidentifier : Identifier [0..*]A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this requestinstantiatesCanonical : canonical [0..*] « »A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this requestinstantiatesUri : uri [0..*]A plan, proposal or order that is fulfilled in whole or in part by this requestbasedOn : Reference [0..*] « Any »Completed or terminated request(s) whose function is taken by this new requestreplaces : Reference [0..*] « Any »A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar formgroupIdentifier : Identifier [0..1]The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)RequestStatus! »Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain (this element modifies the meaning of other elements)intent : code [1..1] « null (Strength=Required)RequestIntent! »Indicates how quickly the request should be addressed with respect to other requestspriority : code [0..1] « null (Strength=Required)RequestPriority! »A code that identifies what the overall request orchestration iscode : CodeableConcept [0..1] « null (Strength=Example)ActionCode?? »The subject for which the request orchestration was createdsubject : Reference [0..1] « Patient|Group »Describes the context of the request orchestration, if anyencounter : Reference [0..1] « Encounter »Indicates when the request orchestration was createdauthoredOn : dateTime [0..1]Provides a reference to the author of the request orchestrationauthor : Reference [0..1] « Device|Practitioner|PractitionerRole »Describes the reason for the request orchestration in coded or textual formreason : CodeableReference [0..*] « Condition|Observation| DiagnosticReport|DocumentReference; null (Strength=Example)ActionReasonCode?? »Goals that are intended to be achieved by following the requests in this RequestOrchestrationgoal : Reference [0..*] « Goal »Provides a mechanism to communicate additional information about the responsenote : Annotation [0..*]ActionThe linkId of the action from the PlanDefinition that corresponds to this action in the RequestOrchestration resourcelinkId : string [0..1]A user-visible prefix for the action. For example a section or item numbering such as 1. or Aprefix : string [0..1]The title of the action displayed to a usertitle : string [0..1]A short description of the action used to provide a summary to display to the userdescription : string [0..1]A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamicallytextEquivalent : string [0..1]Indicates how quickly the action should be addressed with respect to other actionspriority : code [0..1] « null (Strength=Required)RequestPriority! »A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation templatecode : CodeableConcept [0..*] « null (Strength=Example)ActionCode?? »Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedArtifact [0..*]Goals that are intended to be achieved by following the requests in this actiongoal : Reference [0..*] « Goal »An optional value describing when the action should be performedtiming[x] : DataType [0..1] « dateTime|Age|Period|Duration|Range| Timing »Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etclocation : CodeableReference [0..1] « Location »The type of action to perform (create, update, remove)type : CodeableConcept [0..1] « null (Strength=Extensible)ActionType+ »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « null (Strength=Required)ActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « null (Strength=Required)ActionSelectionBehavior! »Defines expectations around whether an action is requiredrequiredBehavior : code [0..1] « null (Strength=Required)ActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « null (Strength=Required)ActionPrecheckBehavior! »Defines whether the action can be selected multiple timescardinalityBehavior : code [0..1] « null (Strength=Required)ActionCardinalityBehavior! »The resource that is the target of the action (e.g. CommunicationRequest)resource : Reference [0..1] « Any » « This element has or is affected by some invariantsC »A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captureddefinition[x] : PrimitiveType [0..1] « canonical(ActivityDefinition| ObservationDefinition|PlanDefinition|Questionnaire| SpecimenDefinition)|uri »A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the inputtransform : canonical [0..1] « StructureMap »ConditionThe kind of conditionkind : code [1..1] « null (Strength=Required)ActionConditionKind! »An expression that returns true or false, indicating whether or not the condition is satisfiedexpression : Expression [0..1]InputA human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readerstitle : string [0..1]Defines the data that is to be provided as input to the actionrequirement : DataRequirement [0..1]Points to an existing input or output element that provides data to this inputrelatedData : id [0..1]OutputA human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readerstitle : string [0..1]Defines the data that results as output from the actionrequirement : DataRequirement [0..1]Points to an existing input or output element that is results as output from the actionrelatedData : string [0..1]RelatedActionThe element id of the target related actiontargetId : id [1..1]The relationship of this action to the related actionrelationship : code [1..1] « null (Strength=Required)ActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : DataType [0..1] « Duration|Range »ParticipantThe type of participant in the actiontype : code [0..1] « null (Strength=Required)ActionParticipantType! »The type of participant in the actiontypeCanonical : canonical [0..1] « CapabilityStatement »The type of participant in the actiontypeReference : Reference [0..1] « CareTeam|Device|DeviceDefinition| Endpoint|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson »The role the participant should play in performing the described actionrole : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantRole?? »Indicates how the actor will be involved in the action - author, reviewer, witness, etcfunction : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantFunction?? »A reference to the actual participantactor[x] : DataType [0..1] « canonical(CapabilityStatement)| Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group| HealthcareService|Location|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) »DynamicValueThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details)path : string [0..1]An expression specifying the value of the customized elementexpression : Expression [0..1]Defines input data requirements for the actioninput[0..*]Defines the outputs of the action, if anyoutput[0..*]A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[0..*]The participant that should perform or be responsible for this actionparticipant[0..*]Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the resultdynamicValue[0..*]Sub actionsaction[0..*]The actions, if any, produced by the evaluation of the artifactaction[0..*]

XML Template

<RequestOrchestration xmlns="http://hl7.org/fhir"> doco
 <!-- 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. icon --></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

{doco
  "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. icon
      "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/> .doco


[ 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

PathDefinitionTypeReference
RequestOrchestration.status

Codes identifying the lifecycle stage of a request.

RequiredRequestStatus
RequestOrchestration.intent

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

RequiredRequestIntent
RequestOrchestration.priority

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

RequiredRequestPriority
RequestOrchestration.code

Provides examples of actions to be performed.

ExampleActionCode
RequestOrchestration.reason

Provides examples of reasons for actions to be performed.

ExampleActionReasonCode
RequestOrchestration.action.priority

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

RequiredRequestPriority
RequestOrchestration.action.code

Provides examples of actions to be performed.

ExampleActionCode
RequestOrchestration.action.condition.kind

Defines the kinds of conditions that can appear on actions.

RequiredActionConditionKind
RequestOrchestration.action.relatedAction.relationship

Defines the types of relationships between actions.

RequiredActionRelationshipType
RequestOrchestration.action.participant.type

The type of participant for the action.

RequiredActionParticipantType
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

ExampleActionParticipantRole icon
RequestOrchestration.action.participant.function

The function performed by the participant for the action.

ExampleActionParticipantFunction
RequestOrchestration.action.type

The type of action to be performed.

ExtensibleActionType
RequestOrchestration.action.groupingBehavior

Defines organization behavior of a group.

RequiredActionGroupingBehavior
RequestOrchestration.action.selectionBehavior

Defines selection behavior of a group.

RequiredActionSelectionBehavior
RequestOrchestration.action.requiredBehavior

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

RequiredActionRequiredBehavior
RequestOrchestration.action.precheckBehavior

Defines selection frequency behavior for an action or group.

RequiredActionPrecheckBehavior
RequestOrchestration.action.cardinalityBehavior

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

RequiredActionCardinalityBehavior

14.17.3.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img pld-0Rule RequestOrchestration.action.inputInput data elements must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
img pld-1Rule RequestOrchestration.action.outputOutput data element must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
img rqg-1Rule RequestOrchestration.actionMust have resource or action but not bothresource.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.

NameTypeDescriptionExpressionIn Common
authorreferenceThe author of the request orchestrationRequestOrchestration.author
(Practitioner, Device, PractitionerRole)
authored NdateThe date the request orchestration was authoredRequestOrchestration.authoredOn
codetokenThe code of the request orchestrationRequestOrchestration.code
encounterreferenceThe encounter the request orchestration applies toRequestOrchestration.encounter
(Encounter)
group-identifiertokenThe group identifier for the request orchestrationRequestOrchestration.groupIdentifier
identifiertokenExternal identifiers for the request orchestrationRequestOrchestration.identifier
instantiates-canonical NreferenceThe FHIR-based definition from which the request orchestration is realizedRequestOrchestration.instantiatesCanonical
instantiates-uri NuriThe external definition from which the request orchestration is realizedRequestOrchestration.instantiatesUri
intent NtokenThe intent of the request orchestrationRequestOrchestration.intent
participantreferenceThe participant in the requests in the orchestrationRequestOrchestration.action.participant.actor
(Group, Organization, CareTeam, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Practitioner, Endpoint, CapabilityStatement, DeviceDefinition, Location)
patientreferenceThe identity of a patient to search for request orchestrationsRequestOrchestration.subject.where(resolve() is Patient)
(Patient)
priority NtokenThe priority of the request orchestrationRequestOrchestration.priority
status NtokenThe status of the request orchestrationRequestOrchestration.status
subjectreferenceThe subject that the request orchestration is aboutRequestOrchestration.subject
(Group, Patient)