This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - 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
Clinical Decision Support Work Group | Maturity Level: 2 | Trial Use | Security Category: Business | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
Detailed Descriptions for the elements in the RequestOrchestration resource.
RequestOrchestration | |||||||||
Element Id | RequestOrchestration | ||||||||
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 Display | A set of related requests | ||||||||
Cardinality | 0..* | ||||||||
Type | DomainResource | ||||||||
Summary | false | ||||||||
RequestOrchestration.identifier | |||||||||
Element Id | RequestOrchestration.identifier | ||||||||
Definition | Allows a service to provide a unique, business identifier for the request. | ||||||||
Short Display | Business identifier | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. | ||||||||
Summary | true | ||||||||
RequestOrchestration.instantiatesCanonical | |||||||||
Element Id | RequestOrchestration.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 Display | Instantiates FHIR protocol or definition | ||||||||
Cardinality | 0..* | ||||||||
Type | canonical | ||||||||
Summary | true | ||||||||
RequestOrchestration.instantiatesUri | |||||||||
Element Id | RequestOrchestration.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 Display | Instantiates external protocol or definition | ||||||||
Cardinality | 0..* | ||||||||
Type | uri | ||||||||
Summary | true | ||||||||
RequestOrchestration.basedOn | |||||||||
Element Id | RequestOrchestration.basedOn | ||||||||
Definition | A plan, proposal or order that is fulfilled in whole or in part by this request. | ||||||||
Short Display | Fulfills plan, proposal, or order | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(Any) | ||||||||
Requirements | Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. | ||||||||
Alternate Names | fulfills | ||||||||
Summary | false | ||||||||
RequestOrchestration.replaces | |||||||||
Element Id | RequestOrchestration.replaces | ||||||||
Definition | Completed or terminated request(s) whose function is taken by this new request. | ||||||||
Short Display | Request(s) replaced by this request | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(Any) | ||||||||
Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. | ||||||||
Alternate Names | supersedes; prior; renewed order | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.groupIdentifier | ||||||||
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. | ||||||||
Short Display | Composite request this is part of | ||||||||
Cardinality | 0..1 | ||||||||
Type | Identifier | ||||||||
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 Names | grouperid; requisition | ||||||||
Summary | true | ||||||||
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 Id | RequestOrchestration.status | ||||||||
Definition | The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration. | ||||||||
Short Display | draft | active | on-hold | revoked | completed | entered-in-error | unknown | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | RequestStatus (Required) | ||||||||
Type | code | ||||||||
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) | ||||||||
Summary | true | ||||||||
RequestOrchestration.intent | |||||||||
Element Id | RequestOrchestration.intent | ||||||||
Definition | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. | ||||||||
Short Display | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | RequestIntent (Required) | ||||||||
Type | code | ||||||||
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) | ||||||||
Requirements | Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. | ||||||||
Alternate Names | category | ||||||||
Summary | true | ||||||||
RequestOrchestration.priority | |||||||||
Element Id | RequestOrchestration.priority | ||||||||
Definition | Indicates how quickly the request should be addressed with respect to other requests. | ||||||||
Short Display | routine | urgent | asap | stat | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | RequestPriority (Required) | ||||||||
Type | code | ||||||||
Meaning if Missing | If missing, this request should be performed with normal priority | ||||||||
Summary | true | ||||||||
RequestOrchestration.code | |||||||||
Element Id | RequestOrchestration.code | ||||||||
Definition | A code that identifies what the overall request orchestration is. | ||||||||
Short Display | What's being requested/ordered | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Action Code (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | true | ||||||||
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 Id | RequestOrchestration.subject | ||||||||
Definition | The subject for which the request orchestration was created. | ||||||||
Short Display | Who the request orchestration is about | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||||||||
Summary | false | ||||||||
RequestOrchestration.encounter | |||||||||
Element Id | RequestOrchestration.encounter | ||||||||
Definition | Describes the context of the request orchestration, if any. | ||||||||
Short Display | Created as part of | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Encounter) | ||||||||
Summary | false | ||||||||
RequestOrchestration.authoredOn | |||||||||
Element Id | RequestOrchestration.authoredOn | ||||||||
Definition | Indicates when the request orchestration was created. | ||||||||
Short Display | When the request orchestration was authored | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Summary | false | ||||||||
RequestOrchestration.author | |||||||||
Element Id | RequestOrchestration.author | ||||||||
Definition | Provides a reference to the author of the request orchestration. | ||||||||
Short Display | Device or practitioner that authored the request orchestration | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Device | Practitioner | PractitionerRole) | ||||||||
Summary | false | ||||||||
RequestOrchestration.reason | |||||||||
Element Id | RequestOrchestration.reason | ||||||||
Definition | Describes the reason for the request orchestration in coded or textual form. | ||||||||
Short Display | Why the request orchestration is needed | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Action Reason Code (Example) | ||||||||
Type | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | ||||||||
Summary | false | ||||||||
RequestOrchestration.goal | |||||||||
Element Id | RequestOrchestration.goal | ||||||||
Definition | Goals that are intended to be achieved by following the requests in this RequestOrchestration. | ||||||||
Short Display | What goals | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(Goal) | ||||||||
Summary | false | ||||||||
RequestOrchestration.note | |||||||||
Element Id | RequestOrchestration.note | ||||||||
Definition | Provides a mechanism to communicate additional information about the response. | ||||||||
Short Display | Additional notes about the response | ||||||||
Cardinality | 0..* | ||||||||
Type | Annotation | ||||||||
Summary | false | ||||||||
RequestOrchestration.action | |||||||||
Element Id | RequestOrchestration.action | ||||||||
Definition | The actions, if any, produced by the evaluation of the artifact. | ||||||||
Short Display | Proposed actions, if any | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
RequestOrchestration.action.linkId | |||||||||
Element Id | RequestOrchestration.action.linkId | ||||||||
Definition | The linkId of the action from the PlanDefinition that corresponds to this action in the RequestOrchestration resource. | ||||||||
Short Display | Pointer to specific item from the PlanDefinition | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.prefix | |||||||||
Element Id | RequestOrchestration.action.prefix | ||||||||
Definition | A user-visible prefix for the action. For example a section or item numbering such as 1. or A. | ||||||||
Short Display | User-visible prefix for the action (e.g. 1. or A.) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.title | |||||||||
Element Id | RequestOrchestration.action.title | ||||||||
Definition | The title of the action displayed to a user. | ||||||||
Short Display | User-visible title | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.description | |||||||||
Element Id | RequestOrchestration.action.description | ||||||||
Definition | A short description of the action used to provide a summary to display to the user. | ||||||||
Short Display | Short description of the action | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | true | ||||||||
RequestOrchestration.action.textEquivalent | |||||||||
Element Id | RequestOrchestration.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 Display | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | true | ||||||||
RequestOrchestration.action.priority | |||||||||
Element Id | RequestOrchestration.action.priority | ||||||||
Definition | Indicates how quickly the action should be addressed with respect to other actions. | ||||||||
Short Display | routine | urgent | asap | stat | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | RequestPriority (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.code | |||||||||
Element Id | RequestOrchestration.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 Display | Code representing the meaning of the action or sub-actions | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Action Code (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.documentation | |||||||||
Element Id | RequestOrchestration.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 Display | Supporting documentation for the intended performer of the action | ||||||||
Cardinality | 0..* | ||||||||
Type | RelatedArtifact | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.goal | |||||||||
Element Id | RequestOrchestration.action.goal | ||||||||
Definition | Goals that are intended to be achieved by following the requests in this action. | ||||||||
Short Display | What goals | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(Goal) | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.condition | |||||||||
Element Id | RequestOrchestration.action.condition | ||||||||
Definition | An expression that describes applicability criteria, or start/stop conditions for the action. | ||||||||
Short Display | Whether or not the action is applicable | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.action.condition.kind | ||||||||
Definition | The kind of condition. | ||||||||
Short Display | applicability | start | stop | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | Action Condition Kind (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.action.condition.expression | ||||||||
Definition | An expression that returns true or false, indicating whether or not the condition is satisfied. | ||||||||
Short Display | Boolean-valued expression | ||||||||
Cardinality | 0..1 | ||||||||
Type | Expression | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.action.input | ||||||||
Definition | Defines input data requirements for the action. | ||||||||
Short Display | Input data requirements | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
RequestOrchestration.action.input.title | |||||||||
Element Id | RequestOrchestration.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 Display | User-visible title | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.input.requirement | |||||||||
Element Id | RequestOrchestration.action.input.requirement | ||||||||
Definition | Defines the data that is to be provided as input to the action. | ||||||||
Short Display | What data is provided | ||||||||
Cardinality | 0..1 | ||||||||
Type | DataRequirement | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
RequestOrchestration.action.input.relatedData | |||||||||
Element Id | RequestOrchestration.action.input.relatedData | ||||||||
Definition | Points to an existing input or output element that provides data to this input. | ||||||||
Short Display | What data is provided | ||||||||
Cardinality | 0..1 | ||||||||
Type | id | ||||||||
Summary | false | ||||||||
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 | ||||||||
Invariants |
| ||||||||
RequestOrchestration.action.output | |||||||||
Element Id | RequestOrchestration.action.output | ||||||||
Definition | Defines the outputs of the action, if any. | ||||||||
Short Display | Output data definition | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
RequestOrchestration.action.output.title | |||||||||
Element Id | RequestOrchestration.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 Display | User-visible title | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.output.requirement | |||||||||
Element Id | RequestOrchestration.action.output.requirement | ||||||||
Definition | Defines the data that results as output from the action. | ||||||||
Short Display | What data is provided | ||||||||
Cardinality | 0..1 | ||||||||
Type | DataRequirement | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
RequestOrchestration.action.output.relatedData | |||||||||
Element Id | RequestOrchestration.action.output.relatedData | ||||||||
Definition | Points to an existing input or output element that is results as output from the action. | ||||||||
Short Display | What data is provided | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
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 | ||||||||
Invariants |
| ||||||||
RequestOrchestration.action.relatedAction | |||||||||
Element Id | RequestOrchestration.action.relatedAction | ||||||||
Definition | A relationship to another action such as "before" or "30-60 minutes after start of". | ||||||||
Short Display | Relationship to another action | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.relatedAction.targetId | |||||||||
Element Id | RequestOrchestration.action.relatedAction.targetId | ||||||||
Definition | The element id of the target related action. | ||||||||
Short Display | What action this is related to | ||||||||
Cardinality | 1..1 | ||||||||
Type | id | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.relatedAction.relationship | |||||||||
Element Id | RequestOrchestration.action.relatedAction.relationship | ||||||||
Definition | The relationship of this action to the related action. | ||||||||
Short Display | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | Action Relationship Type (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.relatedAction.endRelationship | |||||||||
Element Id | RequestOrchestration.action.relatedAction.endRelationship | ||||||||
Definition | The relationship of the end of this action to the related action. | ||||||||
Short Display | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Action Relationship Type (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.relatedAction.offset[x] | |||||||||
Element Id | RequestOrchestration.action.relatedAction.offset[x] | ||||||||
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. | ||||||||
Short Display | Time offset for the relationship | ||||||||
Cardinality | 0..1 | ||||||||
Type | Duration|Range | ||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.timing[x] | |||||||||
Element Id | RequestOrchestration.action.timing[x] | ||||||||
Definition | An optional value describing when the action should be performed. | ||||||||
Short Display | When the action should take place | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime|Age|Period|Duration|Range|Timing | ||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
Requirements | Allows prompting for activities and detection of missed planned activities. | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.action.location | ||||||||
Definition | Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. | ||||||||
Short Display | Where it should happen | ||||||||
Cardinality | 0..1 | ||||||||
Type | CodeableReference(Location) | ||||||||
Requirements | Helps in planning of activity. | ||||||||
Alternate Names | facility | ||||||||
Summary | false | ||||||||
Comments | May reference a specific clinical location or may just identify a type of location. | ||||||||
RequestOrchestration.action.participant | |||||||||
Element Id | RequestOrchestration.action.participant | ||||||||
Definition | The participant that should perform or be responsible for this action. | ||||||||
Short Display | Who should perform the action | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.action.participant.type | ||||||||
Definition | The type of participant in the action. | ||||||||
Short Display | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Action Participant Type (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.participant.typeCanonical | |||||||||
Element Id | RequestOrchestration.action.participant.typeCanonical | ||||||||
Definition | The type of participant in the action. | ||||||||
Short Display | Who or what can participate | ||||||||
Cardinality | 0..1 | ||||||||
Type | canonical(CapabilityStatement) | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.participant.typeReference | |||||||||
Element Id | RequestOrchestration.action.participant.typeReference | ||||||||
Definition | The type of participant in the action. | ||||||||
Short Display | Who or what can participate | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.action.participant.role | ||||||||
Definition | The role the participant should play in performing the described action. | ||||||||
Short Display | E.g. Nurse, Surgeon, Parent, etc | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ActionParticipantRole (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.participant.function | |||||||||
Element Id | RequestOrchestration.action.participant.function | ||||||||
Definition | Indicates how the actor will be involved in the action - author, reviewer, witness, etc. | ||||||||
Short Display | E.g. Author, Reviewer, Witness, etc | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Action Participant Function (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.participant.actor[x] | |||||||||
Element Id | RequestOrchestration.action.participant.actor[x] | ||||||||
Definition | A reference to the actual participant. | ||||||||
Short Display | Who/what is participating? | ||||||||
Cardinality | 0..1 | ||||||||
Type | canonical(CapabilityStatement)|Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.type | |||||||||
Element Id | RequestOrchestration.action.type | ||||||||
Definition | The type of action to perform (create, update, remove). | ||||||||
Short Display | create | update | remove | fire-event | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Action Type (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.groupingBehavior | |||||||||
Element Id | RequestOrchestration.action.groupingBehavior | ||||||||
Definition | Defines the grouping behavior for the action and its children. | ||||||||
Short Display | visual-group | logical-group | sentence-group | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Action Grouping Behavior (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.selectionBehavior | |||||||||
Element Id | RequestOrchestration.action.selectionBehavior | ||||||||
Definition | Defines the selection behavior for the action and its children. | ||||||||
Short Display | any | all | all-or-none | exactly-one | at-most-one | one-or-more | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Action Selection Behavior (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.requiredBehavior | |||||||||
Element Id | RequestOrchestration.action.requiredBehavior | ||||||||
Definition | Defines expectations around whether an action is required. | ||||||||
Short Display | must | could | must-unless-documented | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Action Required Behavior (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.precheckBehavior | |||||||||
Element Id | RequestOrchestration.action.precheckBehavior | ||||||||
Definition | Defines whether the action should usually be preselected. | ||||||||
Short Display | yes | no | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Action Precheck Behavior (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.cardinalityBehavior | |||||||||
Element Id | RequestOrchestration.action.cardinalityBehavior | ||||||||
Definition | Defines whether the action can be selected multiple times. | ||||||||
Short Display | single | multiple | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Action Cardinality Behavior (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
RequestOrchestration.action.resource | |||||||||
Element Id | RequestOrchestration.action.resource | ||||||||
Definition | The resource that is the target of the action (e.g. CommunicationRequest). | ||||||||
Short Display | The target of the action | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Any) | ||||||||
Summary | false | ||||||||
Comments | The target resource SHALL be a Request resource with a Request.intent set to "option". | ||||||||
Invariants |
| ||||||||
RequestOrchestration.action.definition[x] | |||||||||
Element Id | RequestOrchestration.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 Display | Description of the activity to be performed | ||||||||
Cardinality | 0..1 | ||||||||
Type | canonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)|uri | ||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.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 Display | Transform to apply the template | ||||||||
Cardinality | 0..1 | ||||||||
Type | canonical(StructureMap) | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.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 Display | Dynamic aspects of the definition | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.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 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). | ||||||||
Short Display | The path to the element to be set dynamically | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.action.dynamicValue.expression | ||||||||
Definition | An expression specifying the value of the customized element. | ||||||||
Short Display | An expression that provides the dynamic value for the customization | ||||||||
Cardinality | 0..1 | ||||||||
Type | Expression | ||||||||
Summary | false | ||||||||
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 Id | RequestOrchestration.action.action | ||||||||
Definition | Sub actions. | ||||||||
Short Display | Sub action | ||||||||
Cardinality | 0..* | ||||||||
Type | See RequestOrchestration.action | ||||||||
Summary | false |