FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Clinical Decision Support icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the RequestOrchestration resource.

RequestOrchestration
Element IdRequestOrchestration
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".

Short DisplayA set of related requests
Cardinality0..*
TypeDomainResource
Summaryfalse
RequestOrchestration.identifier
Element IdRequestOrchestration.identifier
Definition

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

Short DisplayBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

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

Summarytrue
RequestOrchestration.instantiatesCanonical
Element IdRequestOrchestration.instantiatesCanonical
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.

Short DisplayInstantiates FHIR protocol or definition
Cardinality0..*
Typecanonical
Summarytrue
RequestOrchestration.instantiatesUri
Element IdRequestOrchestration.instantiatesUri
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.

Short DisplayInstantiates external protocol or definition
Cardinality0..*
Typeuri
Summarytrue
RequestOrchestration.basedOn
Element IdRequestOrchestration.basedOn
Definition

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

Short DisplayFulfills plan, proposal, or order
Cardinality0..*
TypeReference(Any)
Requirements

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

Alternate Namesfulfills
Summaryfalse
RequestOrchestration.replaces
Element IdRequestOrchestration.replaces
Definition

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

Short DisplayRequest(s) replaced by this request
Cardinality0..*
TypeReference(Any)
Requirements

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

Alternate Namessupersedes; prior; renewed order
Summaryfalse
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.

RequestOrchestration.groupIdentifier
Element IdRequestOrchestration.groupIdentifier
Definition

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

Short DisplayComposite request this is part of
Cardinality0..1
TypeIdentifier
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.

Alternate Namesgrouperid; requisition
Summarytrue
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.

RequestOrchestration.status
Element IdRequestOrchestration.status
Definition

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

Short Displaydraft | active | on-hold | revoked | completed | entered-in-error | unknown
Cardinality1..1
Terminology BindingRequestStatus (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
RequestOrchestration.intent
Element IdRequestOrchestration.intent
Definition

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

Short Displayproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Cardinality1..1
Terminology BindingRequestIntent (Required)
Typecode
Is Modifiertrue (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)
Requirements

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

Alternate Namescategory
Summarytrue
RequestOrchestration.priority
Element IdRequestOrchestration.priority
Definition

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

Short Displayroutine | urgent | asap | stat
Cardinality0..1
Terminology BindingRequestPriority (Required)
Typecode
Meaning if MissingIf missing, this request should be performed with normal priority
Summarytrue
RequestOrchestration.code
Element IdRequestOrchestration.code
Definition

A code that identifies what the overall request orchestration is.

Short DisplayWhat's being requested/ordered
Cardinality0..1
Terminology BindingActionCode (Example)
TypeCodeableConcept
Summarytrue
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.

RequestOrchestration.subject
Element IdRequestOrchestration.subject
Definition

The subject for which the request orchestration was created.

Short DisplayWho the request orchestration is about
Cardinality0..1
TypeReference(Patient | Group)
Summaryfalse
RequestOrchestration.encounter
Element IdRequestOrchestration.encounter
Definition

Describes the context of the request orchestration, if any.

Short DisplayCreated as part of
Cardinality0..1
TypeReference(Encounter)
Summaryfalse
RequestOrchestration.authoredOn
Element IdRequestOrchestration.authoredOn
Definition

Indicates when the request orchestration was created.

Short DisplayWhen the request orchestration was authored
Cardinality0..1
TypedateTime
Summaryfalse
RequestOrchestration.author
Element IdRequestOrchestration.author
Definition

Provides a reference to the author of the request orchestration.

Short DisplayDevice or practitioner that authored the request orchestration
Cardinality0..1
TypeReference(Device | Practitioner | PractitionerRole)
Summaryfalse
RequestOrchestration.reason
Element IdRequestOrchestration.reason
Definition

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

Short DisplayWhy the request orchestration is needed
Cardinality0..*
Terminology BindingActionReasonCode (Example)
TypeCodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)
Summaryfalse
RequestOrchestration.goal
Element IdRequestOrchestration.goal
Definition

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

Short DisplayWhat goals
Cardinality0..*
TypeReference(Goal)
Summaryfalse
RequestOrchestration.note
Element IdRequestOrchestration.note
Definition

Provides a mechanism to communicate additional information about the response.

Short DisplayAdditional notes about the response
Cardinality0..*
TypeAnnotation
Summaryfalse
RequestOrchestration.action
Element IdRequestOrchestration.action
Definition

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

Short DisplayProposed actions, if any
Cardinality0..*
Summaryfalse
Invariants
Defined on this element
rqg-1Rule Must have resource or action but not bothresource.exists() != action.exists()
RequestOrchestration.action.linkId
Element IdRequestOrchestration.action.linkId
Definition

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

Short DisplayPointer to specific item from the PlanDefinition
Cardinality0..1
Typestring
Summaryfalse
RequestOrchestration.action.prefix
Element IdRequestOrchestration.action.prefix
Definition

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

Short DisplayUser-visible prefix for the action (e.g. 1. or A.)
Cardinality0..1
Typestring
Summaryfalse
RequestOrchestration.action.title
Element IdRequestOrchestration.action.title
Definition

The title of the action displayed to a user.

Short DisplayUser-visible title
Cardinality0..1
Typestring
Summaryfalse
RequestOrchestration.action.description
Element IdRequestOrchestration.action.description
Definition

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

Short DisplayShort description of the action
Cardinality0..1
Typestring
Summarytrue
RequestOrchestration.action.textEquivalent
Element IdRequestOrchestration.action.textEquivalent
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.

Short DisplayStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Cardinality0..1
Typestring
Summarytrue
RequestOrchestration.action.priority
Element IdRequestOrchestration.action.priority
Definition

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

Short Displayroutine | urgent | asap | stat
Cardinality0..1
Terminology BindingRequestPriority (Required)
Typecode
Summaryfalse
RequestOrchestration.action.code
Element IdRequestOrchestration.action.code
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.

Short DisplayCode representing the meaning of the action or sub-actions
Cardinality0..*
Terminology BindingActionCode (Example)
TypeCodeableConcept
Summaryfalse
RequestOrchestration.action.documentation
Element IdRequestOrchestration.action.documentation
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.

Short DisplaySupporting documentation for the intended performer of the action
Cardinality0..*
TypeRelatedArtifact
Summaryfalse
RequestOrchestration.action.goal
Element IdRequestOrchestration.action.goal
Definition

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

Short DisplayWhat goals
Cardinality0..*
TypeReference(Goal)
Summaryfalse
RequestOrchestration.action.condition
Element IdRequestOrchestration.action.condition
Definition

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

Short DisplayWhether or not the action is applicable
Cardinality0..*
Summaryfalse
Comments

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 of the conditions are true.

RequestOrchestration.action.condition.kind
Element IdRequestOrchestration.action.condition.kind
Definition

The kind of condition.

Short Displayapplicability | start | stop
Cardinality1..1
Terminology BindingActionConditionKind (Required)
Typecode
Summaryfalse
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.

RequestOrchestration.action.condition.expression
Element IdRequestOrchestration.action.condition.expression
Definition

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

Short DisplayBoolean-valued expression
Cardinality0..1
TypeExpression
Summaryfalse
Comments

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

RequestOrchestration.action.input
Element IdRequestOrchestration.action.input
Definition

Defines input data requirements for the action.

Short DisplayInput data requirements
Cardinality0..*
Summaryfalse
Invariants
Defined on this element
pld-0Rule Input data elements must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
RequestOrchestration.action.input.title
Element IdRequestOrchestration.action.input.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.

Short DisplayUser-visible title
Cardinality0..1
Typestring
Summaryfalse
RequestOrchestration.action.input.requirement
Element IdRequestOrchestration.action.input.requirement
Definition

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

Short DisplayWhat data is provided
Cardinality0..1
TypeDataRequirement
Summaryfalse
RequestOrchestration.action.input.relatedData
Element IdRequestOrchestration.action.input.relatedData
Definition

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

Short DisplayWhat data is provided
Cardinality0..1
Typeid
Summaryfalse
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

RequestOrchestration.action.output
Element IdRequestOrchestration.action.output
Definition

Defines the outputs of the action, if any.

Short DisplayOutput data definition
Cardinality0..*
Summaryfalse
Invariants
Defined on this element
pld-1Rule Output data element must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
RequestOrchestration.action.output.title
Element IdRequestOrchestration.action.output.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.

Short DisplayUser-visible title
Cardinality0..1
Typestring
Summaryfalse
RequestOrchestration.action.output.requirement
Element IdRequestOrchestration.action.output.requirement
Definition

Defines the data that results as output from the action.

Short DisplayWhat data is provided
Cardinality0..1
TypeDataRequirement
Summaryfalse
RequestOrchestration.action.output.relatedData
Element IdRequestOrchestration.action.output.relatedData
Definition

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

Short DisplayWhat data is provided
Cardinality0..1
Typestring
Summaryfalse
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

RequestOrchestration.action.relatedAction
Element IdRequestOrchestration.action.relatedAction
Definition

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

Short DisplayRelationship to another action
Cardinality0..*
Summaryfalse
RequestOrchestration.action.relatedAction.targetId
Element IdRequestOrchestration.action.relatedAction.targetId
Definition

The element id of the target related action.

Short DisplayWhat action this is related to
Cardinality1..1
Typeid
Summaryfalse
RequestOrchestration.action.relatedAction.relationship
Element IdRequestOrchestration.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Short Displaybefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Cardinality1..1
Terminology BindingActionRelationshipType (Required)
Typecode
Summaryfalse
RequestOrchestration.action.relatedAction.offset[x]
Element IdRequestOrchestration.action.relatedAction.offset[x]
Definition

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

Short DisplayTime offset for the relationship
Cardinality0..1
TypeDuration|Range
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
RequestOrchestration.action.timing[x]
Element IdRequestOrchestration.action.timing[x]
Definition

An optional value describing when the action should be performed.

Short DisplayWhen the action should take place
Cardinality0..1
TypedateTime|Age|Period|Duration|Range|Timing
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Requirements

Allows prompting for activities and detection of missed planned activities.

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

RequestOrchestration.action.location
Element IdRequestOrchestration.action.location
Definition

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

Short DisplayWhere it should happen
Cardinality0..1
TypeCodeableReference(Location)
Requirements

Helps in planning of activity.

Alternate Namesfacility
Summaryfalse
Comments

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

RequestOrchestration.action.participant
Element IdRequestOrchestration.action.participant
Definition

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

Short DisplayWho should perform the action
Cardinality0..*
Summaryfalse
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.

RequestOrchestration.action.participant.type
Element IdRequestOrchestration.action.participant.type
Definition

The type of participant in the action.

Short Displaycareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Cardinality0..1
Terminology BindingActionParticipantType (Required)
Typecode
Summaryfalse
RequestOrchestration.action.participant.typeCanonical
Element IdRequestOrchestration.action.participant.typeCanonical
Definition

The type of participant in the action.

Short DisplayWho or what can participate
Cardinality0..1
Typecanonical(CapabilityStatement)
Summaryfalse
RequestOrchestration.action.participant.typeReference
Element IdRequestOrchestration.action.participant.typeReference
Definition

The type of participant in the action.

Short DisplayWho or what can participate
Cardinality0..1
TypeReference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
Summaryfalse
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).

RequestOrchestration.action.participant.role
Element IdRequestOrchestration.action.participant.role
Definition

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

Short DisplayE.g. Nurse, Surgeon, Parent, etc.
Cardinality0..1
Terminology BindingActionParticipantRole icon (Example)
TypeCodeableConcept
Summaryfalse
RequestOrchestration.action.participant.function
Element IdRequestOrchestration.action.participant.function
Definition

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

Short DisplayE.g. Author, Reviewer, Witness, etc.
Cardinality0..1
Terminology BindingActionParticipantFunction (Example)
TypeCodeableConcept
Summaryfalse
RequestOrchestration.action.participant.actor[x]
Element IdRequestOrchestration.action.participant.actor[x]
Definition

A reference to the actual participant.

Short DisplayWho/what is participating?
Cardinality0..1
Typecanonical(CapabilityStatement)|Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
RequestOrchestration.action.type
Element IdRequestOrchestration.action.type
Definition

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

Short Displaycreate | update | remove | fire-event
Cardinality0..1
Terminology BindingActionType (Extensible)
TypeCodeableConcept
Summaryfalse
RequestOrchestration.action.groupingBehavior
Element IdRequestOrchestration.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Short Displayvisual-group | logical-group | sentence-group
Cardinality0..1
Terminology BindingActionGroupingBehavior (Required)
Typecode
Summaryfalse
RequestOrchestration.action.selectionBehavior
Element IdRequestOrchestration.action.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Short Displayany | all | all-or-none | exactly-one | at-most-one | one-or-more
Cardinality0..1
Terminology BindingActionSelectionBehavior (Required)
Typecode
Summaryfalse
RequestOrchestration.action.requiredBehavior
Element IdRequestOrchestration.action.requiredBehavior
Definition

Defines expectations around whether an action is required.

Short Displaymust | could | must-unless-documented
Cardinality0..1
Terminology BindingActionRequiredBehavior (Required)
Typecode
Summaryfalse
RequestOrchestration.action.precheckBehavior
Element IdRequestOrchestration.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Short Displayyes | no
Cardinality0..1
Terminology BindingActionPrecheckBehavior (Required)
Typecode
Summaryfalse
RequestOrchestration.action.cardinalityBehavior
Element IdRequestOrchestration.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Short Displaysingle | multiple
Cardinality0..1
Terminology BindingActionCardinalityBehavior (Required)
Typecode
Summaryfalse
RequestOrchestration.action.resource
Element IdRequestOrchestration.action.resource
Definition

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

Short DisplayThe target of the action
Cardinality0..1
TypeReference(Any)
Summaryfalse
Comments

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

Invariants
Affect this element
rqg-1Rule Must have resource or action but not bothresource.exists() != action.exists()
RequestOrchestration.action.definition[x]
Element IdRequestOrchestration.action.definition[x]
Definition

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

Short DisplayDescription of the activity to be performed
Cardinality0..1
Typecanonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)|uri
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
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.

RequestOrchestration.action.transform
Element IdRequestOrchestration.action.transform
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.

Short DisplayTransform to apply the template
Cardinality0..1
Typecanonical(StructureMap)
Summaryfalse
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.

RequestOrchestration.action.dynamicValue
Element IdRequestOrchestration.action.dynamicValue
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.

Short DisplayDynamic aspects of the definition
Cardinality0..*
Summaryfalse
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.

RequestOrchestration.action.dynamicValue.path
Element IdRequestOrchestration.action.dynamicValue.path
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 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 for full details).

Short DisplayThe path to the element to be set dynamically
Cardinality0..1
Typestring
Summaryfalse
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.

RequestOrchestration.action.dynamicValue.expression
Element IdRequestOrchestration.action.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

Short DisplayAn expression that provides the dynamic value for the customization
Cardinality0..1
TypeExpression
Summaryfalse
Comments

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

RequestOrchestration.action.action
Element IdRequestOrchestration.action.action
Definition

Sub actions.

Short DisplaySub action
Cardinality0..*
TypeSee RequestOrchestration.action
Summaryfalse
Invariants
Affect this element
rqg-1Rule Must have resource or action but not bothresource.exists() != action.exists()