type: resource-definitionsresource: RequestOrchestration

RequestOrchestration Definitions

RequestOrchestration

A set of related requests

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

Cardinality: 0..*

Mappings: workflow=Request; w5=clinical.general

RequestOrchestration.identifier

Business identifier

Definition: Allows a service to provide a unique, business identifier for the request.

Requirements: Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: workflow=Request.identifier; w5=FiveWs.identifier

RequestOrchestration.instantiatesCanonical

Instantiates FHIR protocol or definition

Definition: A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

Cardinality: 0..*

Type: canonical

Summary: true

Mappings: workflow=Request.instantiatesCanonical

RequestOrchestration.instantiatesUri

Instantiates external protocol or definition

Definition: A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

Cardinality: 0..*

Type: uri

Summary: true

Mappings: workflow=Request.instantiatesUri

RequestOrchestration.basedOn

Fulfills plan, proposal, or order

Definition: A plan, proposal or order that is fulfilled in whole or in part by this request.

Requirements: Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.

Aliases: fulfills

Cardinality: 0..*

Type: Reference(Resource)

Mappings: workflow=Request.basedOn

RequestOrchestration.replaces

Request(s) replaced by this request

Definition: Completed or terminated request(s) whose function is taken by this new request.

Comments: The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

Requirements: Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

Aliases: supersedes, prior, renewed order

Cardinality: 0..*

Type: Reference(Resource)

Mappings: workflow=Request.replaces

RequestOrchestration.groupIdentifier

Composite request this is part of

Definition: A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

Comments: Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

Requirements: Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes.

Aliases: grouperid, requisition

Cardinality: 0..1

Type: Identifier

Summary: true

Mappings: workflow=Request.groupIdentifier

RequestOrchestration.status

Definition: The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration.

Cardinality: 1..1

Type: code

Binding: required:request-status

Summary: true

Is Modifier: true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)

Mappings: workflow=Request.status; w5=FiveWs.status

RequestOrchestration.intent

Definition: Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

Requirements: Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

Aliases: category

Cardinality: 1..1

Type: code

Binding: required:request-intent

Summary: true

Is Modifier: true (Reason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request)

Mappings: workflow=Request.intent; w5=FiveWs.class

RequestOrchestration.priority

routine | urgent | asap | stat

Definition: Indicates how quickly the request should be addressed with respect to other requests.

Meaning if Missing: If missing, this request should be performed with normal priority

Cardinality: 0..1

Type: code

Binding: required:request-priority

Summary: true

Mappings: workflow=Request.priority; w5=FiveWs.grade

RequestOrchestration.code

What's being requested/ordered

Definition: A code that identifies what the overall request orchestration is.

Comments: This element can be used to provide a code that captures the meaning of the request orchestration as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request orchestration.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:action-code

Summary: true

Mappings: workflow=Request.code; w5=FiveWs.what[x]

RequestOrchestration.subject

Who the request orchestration is about

Definition: The subject for which the request orchestration was created.

Cardinality: 0..1

Type: Reference(CareTeam, Device, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)

Mappings: workflow=Request.subject; w5=FiveWs.subject

RequestOrchestration.encounter

Created as part of

Definition: Describes the context of the request orchestration, if any.

Cardinality: 0..1

Type: Reference(Encounter)

Mappings: workflow=Request.encounter; w5=FiveWs.context

RequestOrchestration.authoredOn

When the request orchestration was authored

Definition: Indicates when the request orchestration was created.

Cardinality: 0..1

Type: dateTime

Mappings: workflow=Request.authoredOn; w5=FiveWs.recorded

RequestOrchestration.author

Device or practitioner that authored the request orchestration

Definition: Provides a reference to the author of the request orchestration.

Cardinality: 0..1

Type: Reference(Device, Practitioner, PractitionerRole)

Mappings: workflow=Request.requester; w5=FiveWs.author

RequestOrchestration.reason

Why the request orchestration is needed

Definition: Describes the reason for the request orchestration in coded or textual form.

Cardinality: 0..*

Type: CodeableReference

Binding: example:action-reason-code

Mappings: workflow=Request.reason; w5=FiveWs.why[x]

RequestOrchestration.goal

What goals

Definition: Goals that are intended to be achieved by following the requests in this RequestOrchestration.

Cardinality: 0..*

Type: Reference(Goal)

Mappings: w5=FiveWs.why[x]; rim=N/A

RequestOrchestration.note

Additional notes about the response

Definition: Provides a mechanism to communicate additional information about the response.

Cardinality: 0..*

Type: Annotation

Mappings: workflow=Request.note

RequestOrchestration.action

Proposed actions, if any

Definition: The actions, if any, produced by the evaluation of the artifact.

Cardinality: 0..*

Type: BackboneElement

Constraints: rqg-1 | error | Must have either resource, action, or definition | iif(resource.exists(), 1, 0) + iif(action.exists(), 1, 0) + iif(definition.exists(), 1, 0) = 1

RequestOrchestration.action.linkId

Pointer to specific item from the PlanDefinition

Definition: The linkId of the action from the PlanDefinition that corresponds to this action in the RequestOrchestration resource.

Cardinality: 0..1

Type: string

Mappings: rim=N/A (to add?)

RequestOrchestration.action.prefix

User-visible prefix for the action (e.g. 1. or A.)

Definition: A user-visible prefix for the action. For example a section or item numbering such as 1. or A.

Cardinality: 0..1

Type: string

RequestOrchestration.action.title

User-visible title

Definition: The title of the action displayed to a user.

Cardinality: 0..1

Type: string

RequestOrchestration.action.description

Short description of the action

Definition: A short description of the action used to provide a summary to display to the user.

Cardinality: 0..1

Type: markdown

Summary: true

RequestOrchestration.action.textEquivalent

Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system

Definition: 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 dynamically.

Cardinality: 0..1

Type: markdown

Summary: true

RequestOrchestration.action.priority

routine | urgent | asap | stat

Definition: Indicates how quickly the action should be addressed with respect to other actions.

Cardinality: 0..1

Type: code

Binding: required:request-priority

Mappings: workflow=Request.priority

RequestOrchestration.action.code

Code representing the meaning of the action or sub-actions

Definition: 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 template.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:action-code

Mappings: workflow=Request.code

RequestOrchestration.action.documentation

Supporting documentation for the intended performer of the action

Definition: 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 resources.

Cardinality: 0..*

Type: RelatedArtifact

Mappings: workflow=Request.supportingInfo

RequestOrchestration.action.goal

What goals

Definition: Goals that are intended to be achieved by following the requests in this action.

Cardinality: 0..*

Type: Reference(Goal)

Mappings: w5=FiveWs.why[x]; rim=N/A

RequestOrchestration.action.condition

Whether or not the action is applicable

Definition: An expression that describes applicability criteria, or start/stop conditions for the action.

Comments: If no applicability conditions are present, the action is considered applicable (i.e. it should be performed). When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true. Conditions of different kinds are always considered separately (e.g. applicability and start criteria are never considered together)

Cardinality: 0..*

Type: BackboneElement

RequestOrchestration.action.condition.kind

applicability | start | stop

Definition: The kind of condition.

Comments: Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.

Cardinality: 1..1

Type: code

Binding: required:action-condition-kind

RequestOrchestration.action.condition.expression

Boolean-valued expression

Definition: An expression that returns true or false, indicating whether or not the condition is satisfied.

Comments: The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.

Cardinality: 0..1

Type: Expression

RequestOrchestration.action.input

Input data requirements

Definition: Defines input data requirements for the action.

Cardinality: 0..*

Type: BackboneElement

Constraints: pld-0 | error | Input data elements must have a requirement or a relatedData, but not both | requirement.exists() xor relatedData.exists()

Mappings: rim=N/A (to add?)

RequestOrchestration.action.input.title

User-visible title

Definition: A 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 readers.

Cardinality: 0..1

Type: string

Mappings: rim=N/A (to add?)

RequestOrchestration.action.input.requirement

What data is provided

Definition: Defines the data that is to be provided as input to the action.

Conditions: pld-0

Cardinality: 0..1

Type: DataRequirement

Mappings: rim=N/A (to add?)

RequestOrchestration.action.input.relatedData

What data is provided

Definition: Points to an existing input or output element that provides data to this input.

Comments: The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action

Conditions: pld-0

Cardinality: 0..1

Type: id

Mappings: rim=N/A (to add?)

RequestOrchestration.action.output

Output data definition

Definition: Defines the outputs of the action, if any.

Cardinality: 0..*

Type: BackboneElement

Constraints: pld-1 | error | Output data element must have a requirement or a relatedData, but not both | requirement.exists() xor relatedData.exists()

Mappings: rim=N/A (to add?)

RequestOrchestration.action.output.title

User-visible title

Cardinality: 0..1

Type: string

Mappings: rim=N/A (to add?)

RequestOrchestration.action.output.requirement

What data is provided

Definition: Defines the data that results as output from the action.

Conditions: pld-1

Cardinality: 0..1

Type: DataRequirement

Mappings: rim=N/A (to add?)

RequestOrchestration.action.output.relatedData

What data is provided

Definition: Points to an existing input or output element that is results as output from the action.

Comments: The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action

Conditions: pld-1

Cardinality: 0..1

Type: string

Mappings: rim=N/A (to add?)

RequestOrchestration.action.relatedAction

Relationship to another action

Definition: A relationship to another action such as "before" or "30-60 minutes after start of".

Cardinality: 0..*

Type: BackboneElement

RequestOrchestration.action.relatedAction.targetId

What action this is related to

Definition: The element id of the target related action.

Cardinality: 1..1

Type: id

RequestOrchestration.action.relatedAction.relationship

Definition: The relationship of this action to the related action.

Cardinality: 1..1

Type: code

Binding: required:action-relationship-type

RequestOrchestration.action.relatedAction.endRelationship

Definition: The relationship of the end of this action to the related action.

Cardinality: 0..1

Type: code

Binding: required:action-relationship-type

Mappings: rim=N/A (to add?)

RequestOrchestration.action.relatedAction.offset[x]

Time offset for the relationship

Definition: A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Cardinality: 0..1

Type: Duration, Range

RequestOrchestration.action.timing[x]

When the action should take place

Definition: An optional value describing when the action should be performed.

Comments: The intent of the timing element is to provide timing for when the action should be performed. The timing may be absolute (specified as a dateTime or Period) or relative (specified as an Age, Duration, or Range), or it may be a more complex, potentially repeating timing specified using Timing.

Requirements: Allows prompting for activities and detection of missed planned activities.

Cardinality: 0..1

Type: dateTime, Age, Period, Duration, Range, Timing, RelativeTime

Mappings: workflow=Request.occurrence[x]

RequestOrchestration.action.location

Where it should happen

Definition: Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.

Comments: May reference a specific clinical location or may just identify a type of location.

Requirements: Helps in planning of activity.

Aliases: facility

Cardinality: 0..1

Type: CodeableReference

Mappings: rim=.participation[typeCode=LOC].role

RequestOrchestration.action.participant

Who should perform the action

Definition: The participant that should perform or be responsible for this action.

Comments: Because request orchestrations represent potential options for performing activities, some specific participants may still be unknown, so this element allows for both definitional participants (in the same way they are specified in ActivityDefinition and PlanDefinition resources) as well as identifying specific participants when they are known.

Cardinality: 0..*

Type: BackboneElement

Mappings: workflow=Request.performer; w5=FiveWs.actor

RequestOrchestration.action.participant.type

Definition: The type of participant in the action.

Cardinality: 0..1

Type: code

Binding: required:action-participant-type

Mappings: rim=.role.classCode

RequestOrchestration.action.participant.typeCanonical

Who or what can participate

Definition: The type of participant in the action.

Cardinality: 0..1

Type: canonical

Mappings: rim=.role.classCode

RequestOrchestration.action.participant.typeReference

Who or what can participate

Definition: The type of participant in the action.

Comments: When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).

Cardinality: 0..1

Type: Reference(BiologicallyDerivedProduct, CareTeam, Device, Endpoint, HealthcareService, Location, Medication, MedicinalProductDefinition, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Specimen, Substance, SubstanceDefinition)

Mappings: rim=.role.classCode

RequestOrchestration.action.participant.role

E.g. Nurse, Surgeon, Parent, etc

Definition: The role the participant should play in performing the described action.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:action-participant-role

Mappings: rim=.role.code

RequestOrchestration.action.participant.function

E.g. Author, Reviewer, Witness, etc

Definition: Indicates how the actor will be involved in the action - author, reviewer, witness, etc.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:action-participant-function

Mappings: rim=.role.code

RequestOrchestration.action.participant.actor[x]

Who/what is participating?

Definition: A reference to the actual participant.

Cardinality: 0..1

Type: canonical, Reference(BiologicallyDerivedProduct, CareTeam, Device, Endpoint, HealthcareService, Location, Medication, MedicinalProductDefinition, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Specimen, Substance, SubstanceDefinition)

Mappings: rim=.role.code

RequestOrchestration.action.type

create | update | remove | fire-event

Definition: The type of action to perform (create, update, remove).

Cardinality: 0..1

Type: CodeableConcept

Binding: extensible:action-type

RequestOrchestration.action.applicabilityBehavior

all | any

Definition: All - meaning the applicability of each child action is evaluated independently; if a child action is applicable according to the applicability criteria, it is applied. Any - meaning that each child action is evaluated in order, and the first action that returns an applicability of true will be applied, and processing of the parent action will stop. If not specified, the default behavior of All is used.

Meaning if Missing: If no applicability behavior is specified but the action has children, the default applicability criteria of All is assumed, meaning that each child action is evaluated independently.

Cardinality: 0..1

Type: code

Binding: required:action-applicability-behavior

Mappings: rim=N/A

RequestOrchestration.action.groupingBehavior

visual-group | logical-group | sentence-group

Definition: Defines the grouping behavior for the action and its children.

Cardinality: 0..1

Type: code

Binding: required:action-grouping-behavior

RequestOrchestration.action.selectionBehavior

Definition: Defines the selection behavior for the action and its children.

Cardinality: 0..1

Type: code

Binding: required:action-selection-behavior

RequestOrchestration.action.requiredBehavior

must | could | must-unless-documented

Definition: Defines expectations around whether an action is required.

Cardinality: 0..1

Type: code

Binding: required:action-required-behavior

RequestOrchestration.action.precheckBehavior

yes | no

Definition: Defines whether the action should usually be preselected.

Cardinality: 0..1

Type: code

Binding: required:action-precheck-behavior

RequestOrchestration.action.cardinalityBehavior

single | multiple

Definition: Defines whether the action can be selected multiple times.

Cardinality: 0..1

Type: code

Binding: required:action-cardinality-behavior

RequestOrchestration.action.resource

The target of the action

Definition: The resource that is the target of the action (e.g. CommunicationRequest).

Comments: The target resource SHALL be a Request resource with a Request.intent set to "option".

Conditions: rqg-1

Cardinality: 0..1

Type: Reference(Resource)

RequestOrchestration.action.definition[x]

Description of the activity to be performed

Definition: A reference to an ActivityDefinition that describes the action to be taken in detail, a Measure that specifies a measure to be evaluated, a MessageDefinition that specifies a message to be sent, 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, an ObservationDefinition that specifies what observation should be captured, or an OperationDefinition that specifies what operation should be invoked. When the value is a uri, it is intended to be a reference to non-FHIR content that characterizes the action to be performed. This option is allowed to enable the PlanDefinition to be used to provide semi-structured representation, when the guidance is not computable, but there is still value in elaborating the overall structure with a PlanDefinition. The intended behavior when a definitionUri is realized as part of an apply is that it is copied to the resulting RequestOrchestration so that it is available to the consuming system. How that system interprets that uri is not specified.

Comments: Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. If the reference is to an ActivityDefinition or a PlanDefinition, the realization processing documented in those resources is followed. For the other definitional resource types, implementations SHOULD realize the action as a Task resource with a focus of the definitional resource to indicate that the activity should be carried out (e.g. evaluating a measure, gathering a specimen, filling out a questionnaire, sending a message, invoking an operation, etc.).

Cardinality: 0..1

Type: canonical, uri

Mappings: rim=Act[classCode=ACT; moodCode=DEFN]

RequestOrchestration.action.transform

Transform to apply the template

Definition: 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 input.

Comments: Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Cardinality: 0..1

Type: canonical

Mappings: rim=N/A

RequestOrchestration.action.dynamicValue

Dynamic aspects of the definition

Definition: 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 result.

Comments: Dynamic values are applied in the order in which they are defined in the RequestOrchestration resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Cardinality: 0..*

Type: BackboneElement

Mappings: rim=N/A

RequestOrchestration.action.dynamicValue.path

The path to the element to be set dynamically

Definition: The 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 resolvable 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 for full details).

Comments: To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Cardinality: 0..1

Type: string

Mappings: rim=N/A

RequestOrchestration.action.dynamicValue.expression

An expression that provides the dynamic value for the customization

Definition: An expression specifying the value of the customized element.

Comments: The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Cardinality: 0..1

Type: Expression

Mappings: rim=N/A

RequestOrchestration.action.action

Sub action

Definition: Sub actions.

Cardinality: 0..*