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 Group Maturity Level: 0Trial Use Use Context: Any

Definitions for the cdshooksrequestorchestration Profile.

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
Cardinality1..1
Invariants
Inherited by this element
dom-2RuleIf the resource is contained in another resource, it SHALL NOT contain nested Resourcescontained.contained.empty()
dom-3RuleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resourcecontained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4RuleIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdatedcontained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5RuleIf a resource is contained in another resource, it SHALL NOT have a security labelcontained.meta.security.empty()
dom-6GuidelineA resource should have narrative for robust managementtext.`div`.exists()
This is (only) a best practice guideline because:

When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

RequestOrchestration.id
Element IdRequestOrchestration.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short DisplayLogical id of this artifact
Cardinality0..1
Typeid
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

RequestOrchestration.meta
Element IdRequestOrchestration.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short DisplayMetadata about the resource
Cardinality0..1
TypeMeta
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.implicitRules
Element IdRequestOrchestration.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short DisplayA set of rules under which this content was created
Cardinality0..1
Typeuri
Is Modifiertrue (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation)
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.language
Element IdRequestOrchestration.language
Definition

The base language in which the resource is written.

Short DisplayLanguage of the resource content
Cardinality0..1
Terminology BindingIETF language tag for a human language
The codes SHALL be taken from All Languages
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.text
Element IdRequestOrchestration.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short DisplayText summary of the resource, for human interpretation
Cardinality0..1 This element is affected by the following invariants: dom-6
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.contained
Element IdRequestOrchestration.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Short DisplayContained, inline Resources
Cardinality0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

RequestOrchestration.extension
Element IdRequestOrchestration.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.modifierExtension
Element IdRequestOrchestration.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.identifier
Element IdRequestOrchestration.identifier
Definition

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

Short DisplayBusiness identifier
Cardinality1..1
TypeIdentifier
Requirements

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Cardinality1..1
Typeuri
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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(Resource)
Requirements

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

Alternate Namesfulfills
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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(Resource)
Requirements

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

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.groupIdentifier
Element IdRequestOrchestration.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 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
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 BindingCodes identifying the lifecycle stage of a request.
The codes SHALL be taken from RequestStatus
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)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 BindingCodes indicating the degree of authority/intentionality associated with a request.
The codes SHALL be taken from RequestIntent
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
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 BindingIdentifies the level of importance to be assigned to actioning the request.
The codes SHALL be taken from RequestPriority
Typecode
Must Supporttrue
Meaning if MissingIf missing, this request should be performed with normal priority
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 Bindingnull
For example codes, see Action Code
TypeCodeableConcept
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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(CareTeam)
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.encounter
Element IdRequestOrchestration.encounter
Definition

Describes the context of the request orchestration, if any.

Short DisplayCreated as part of
Cardinality0..1
TypeReference(Encounter)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.authoredOn
Element IdRequestOrchestration.authoredOn
Definition

Indicates when the request orchestration was created.

Short DisplayWhen the request orchestration was authored
Cardinality0..1
TypedateTime
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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)
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 Bindingnull
For example codes, see Action Reason Code
TypeCodeableReference(Condition)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.note
Element IdRequestOrchestration.note
Definition

Provides a mechanism to communicate additional information about the response.

Short DisplayAdditional notes about the response
Cardinality0..*
TypeAnnotation
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action
Element IdRequestOrchestration.action
Definition

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

Short DisplayProposed actions, if any
Cardinality0..*
TypeBackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
rqg-1RuleMust have resource or action but not bothresource.exists() != action.exists()
RequestOrchestration.action.id
Element IdRequestOrchestration.action.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
RequestOrchestration.action.extension
Element IdRequestOrchestration.action.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.modifierExtension
Element IdRequestOrchestration.action.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.title
Element IdRequestOrchestration.action.title
Definition

The title of the action displayed to a user.

Short DisplayUser-visible title
Cardinality0..1
Typestring
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Typemarkdown
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Typemarkdown
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 BindingIdentifies the level of importance to be assigned to actioning the request.
The codes SHALL be taken from RequestPriority
Typecode
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 Bindingnull
For example codes, see Action Code
TypeCodeableConcept
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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..*
TypeBackboneElement
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.condition.id
Element IdRequestOrchestration.action.condition.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
RequestOrchestration.action.condition.extension
Element IdRequestOrchestration.action.condition.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.condition.modifierExtension
Element IdRequestOrchestration.action.condition.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.condition.kind
Element IdRequestOrchestration.action.condition.kind
Definition

The kind of condition.

Short Displayapplicability | start | stop
Cardinality1..1
Terminology BindingThe kind of condition for the action.
The codes SHALL be taken from Action Condition Kind
Typecode
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.input
Element IdRequestOrchestration.action.input
Definition

Defines input data requirements for the action.

Short DisplayInput data requirements
Cardinality0..*
TypeBackboneElement
Invariants
Inherited by this element
pld-0RuleInput data elements must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.input.id
Element IdRequestOrchestration.action.input.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
RequestOrchestration.action.input.extension
Element IdRequestOrchestration.action.input.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.input.modifierExtension
Element IdRequestOrchestration.action.input.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 This element is affected by the following invariants: pld-0
TypeDataRequirement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 This element is affected by the following invariants: pld-0
Typeid
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
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.output
Element IdRequestOrchestration.action.output
Definition

Defines the outputs of the action, if any.

Short DisplayOutput data definition
Cardinality0..*
TypeBackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
pld-1RuleOutput data element must have a requirement or a relatedData, but not bothrequirement.exists() xor relatedData.exists()
RequestOrchestration.action.output.id
Element IdRequestOrchestration.action.output.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
RequestOrchestration.action.output.extension
Element IdRequestOrchestration.action.output.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.output.modifierExtension
Element IdRequestOrchestration.action.output.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 This element is affected by the following invariants: pld-1
TypeDataRequirement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 This element is affected by the following invariants: pld-1
Typestring
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
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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..*
TypeBackboneElement
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.relatedAction.id
Element IdRequestOrchestration.action.relatedAction.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
RequestOrchestration.action.relatedAction.extension
Element IdRequestOrchestration.action.relatedAction.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.relatedAction.modifierExtension
Element IdRequestOrchestration.action.relatedAction.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.relatedAction.relationship
Element IdRequestOrchestration.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Short Displaybefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Cardinality1..1
Terminology BindingDefines the types of relationships between actions.
The codes SHALL be taken from Action Relationship Type
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.relatedAction.endRelationship
Element IdRequestOrchestration.action.relatedAction.endRelationship
Definition

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

Short Displaybefore | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Cardinality0..1
Terminology BindingDefines the types of relationships between actions.
The codes SHALL be taken from Action Relationship Type
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
TypeChoice of: Duration, Range
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Must Supporttrue
Requirements

Allows prompting for activities and detection of missed planned activities.

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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..*
TypeBackboneElement
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.participant.id
Element IdRequestOrchestration.action.participant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
RequestOrchestration.action.participant.extension
Element IdRequestOrchestration.action.participant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.participant.modifierExtension
Element IdRequestOrchestration.action.participant.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 BindingThe type of participant in the activity.
The codes SHALL be taken from Action Participant Type
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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)
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).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 BindingDefines roles played by participants for the action.
For example codes, see Action Participant Role icon
TypeCodeableConcept
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 Bindingnull
For example codes, see Action Participant Function
TypeCodeableConcept
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
TypeChoice of: canonical(CapabilityStatement), Reference(CareTeam)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 BindingThe type of action to be performed.
The codes SHALL be taken from Action Type; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 BindingDefines organization behavior of a group.
The codes SHALL be taken from Action Grouping Behavior
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 BindingDefines selection behavior of a group.
The codes SHALL be taken from Action Selection Behavior
Typecode
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 BindingDefines expectations around whether an action or action group is required.
The codes SHALL be taken from Action Required Behavior
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.precheckBehavior
Element IdRequestOrchestration.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Short Displayyes | no
Cardinality0..1
Terminology BindingDefines selection frequency behavior for an action or group.
The codes SHALL be taken from Action Precheck Behavior
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.cardinalityBehavior
Element IdRequestOrchestration.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Short Displaysingle | multiple
Cardinality0..1
Terminology BindingDefines behavior for an action or a group for how many times that item may be repeated.
The codes SHALL be taken from Action Cardinality Behavior
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 This element is affected by the following invariants: rqg-1
TypeReference(Resource)
Must Supporttrue
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
TypeChoice of: canonical(ActivityDefinition), uri
[x] NoteSee Choice of Datatypes for further information about how to use [x]
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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)
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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..*
TypeBackboneElement
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.dynamicValue.id
Element IdRequestOrchestration.action.dynamicValue.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
RequestOrchestration.action.dynamicValue.extension
Element IdRequestOrchestration.action.dynamicValue.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.dynamicValue.modifierExtension
Element IdRequestOrchestration.action.dynamicValue.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 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 DisplayThe path to the element to be set dynamically
Cardinality0..1
Typestring
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
RequestOrchestration.action.action
Element IdRequestOrchestration.action.action
Definition

Sub actions.

Short DisplaySub action
Cardinality0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/RequestOrchestration#RequestOrchestration.action
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())