Struct RequestOrchestrationActionBuilder 

pub struct RequestOrchestrationActionBuilder { /* private fields */ }

Builder for RequestOrchestrationAction.

Implementations

impl RequestOrchestrationActionBuilder

pub fn id(self, value: String) -> RequestOrchestrationActionBuilder

Unique id for inter-element referencing

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

pub fn extension( self, value: Vec<Extension>, ) -> RequestOrchestrationActionBuilder

Additional content defined by implementations

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.

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.

pub fn modifier_extension( self, value: Vec<Extension>, ) -> RequestOrchestrationActionBuilder

Extensions that cannot be ignored even if unrecognized

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

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.

pub fn link_id(self, value: String) -> RequestOrchestrationActionBuilder

Pointer to specific item from the PlanDefinition

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

pub fn link_id_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn prefix(self, value: String) -> RequestOrchestrationActionBuilder

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

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

pub fn prefix_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn title(self, value: String) -> RequestOrchestrationActionBuilder

User-visible title

The title of the action displayed to a user.

pub fn title_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn description(self, value: String) -> RequestOrchestrationActionBuilder

Short description of the action

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

pub fn description_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn text_equivalent(self, value: String) -> RequestOrchestrationActionBuilder

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

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.

pub fn text_equivalent_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn priority( self, value: RequestPriority, ) -> RequestOrchestrationActionBuilder

RequestPriority; routine | urgent | asap | stat

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

pub fn priority_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn code( self, value: Vec<Option<CodeableConcept>>, ) -> RequestOrchestrationActionBuilder

ActionCode; Code representing the meaning of the action or sub-actions

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.

pub fn code_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn documentation( self, value: Vec<Option<RelatedArtifact>>, ) -> RequestOrchestrationActionBuilder

Supporting documentation for the intended performer of the action

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.

pub fn documentation_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn goal( self, value: Vec<Option<Reference>>, ) -> RequestOrchestrationActionBuilder

What goals

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

pub fn goal_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn condition( self, value: Vec<Option<RequestOrchestrationActionCondition>>, ) -> RequestOrchestrationActionBuilder

Whether or not the action is applicable

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

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.

pub fn condition_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn input( self, value: Vec<Option<RequestOrchestrationActionInput>>, ) -> RequestOrchestrationActionBuilder

Input data requirements

Defines input data requirements for the action.

pub fn input_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn output( self, value: Vec<Option<RequestOrchestrationActionOutput>>, ) -> RequestOrchestrationActionBuilder

Output data definition

Defines the outputs of the action, if any.

pub fn output_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn related_action( self, value: Vec<Option<RequestOrchestrationActionRelatedAction>>, ) -> RequestOrchestrationActionBuilder

Relationship to another action

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

pub fn related_action_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn timing( self, value: RequestOrchestrationActionTiming, ) -> RequestOrchestrationActionBuilder

When the action should take place

An optional value describing when the action should be performed.

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.

pub fn timing_ext( self, value: RequestOrchestrationActionTimingExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn location( self, value: CodeableReference, ) -> RequestOrchestrationActionBuilder

Where it should happen

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

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

pub fn location_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn participant( self, value: Vec<Option<RequestOrchestrationActionParticipant>>, ) -> RequestOrchestrationActionBuilder

Who should perform the action

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

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.

pub fn participant_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn type(self, value: CodeableConcept) -> RequestOrchestrationActionBuilder

ActionType; create | update | remove | fire-event

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

pub fn type_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn grouping_behavior( self, value: ActionGroupingBehavior, ) -> RequestOrchestrationActionBuilder

ActionGroupingBehavior; visual-group | logical-group | sentence-group

Defines the grouping behavior for the action and its children.

pub fn grouping_behavior_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn selection_behavior( self, value: ActionSelectionBehavior, ) -> RequestOrchestrationActionBuilder

ActionSelectionBehavior; any | all | all-or-none | exactly-one | at-most-one | one-or-more

Defines the selection behavior for the action and its children.

pub fn selection_behavior_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn required_behavior( self, value: ActionRequiredBehavior, ) -> RequestOrchestrationActionBuilder

ActionRequiredBehavior; must | could | must-unless-documented

Defines expectations around whether an action is required.

pub fn required_behavior_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn precheck_behavior( self, value: ActionPrecheckBehavior, ) -> RequestOrchestrationActionBuilder

ActionPrecheckBehavior; yes | no

Defines whether the action should usually be preselected.

pub fn precheck_behavior_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn cardinality_behavior( self, value: ActionCardinalityBehavior, ) -> RequestOrchestrationActionBuilder

ActionCardinalityBehavior; single | multiple

Defines whether the action can be selected multiple times.

pub fn cardinality_behavior_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn resource(self, value: Reference) -> RequestOrchestrationActionBuilder

The target of the action

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

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

pub fn resource_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn definition( self, value: RequestOrchestrationActionDefinition, ) -> RequestOrchestrationActionBuilder

Description of the activity to be performed

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.

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.

pub fn definition_ext( self, value: RequestOrchestrationActionDefinitionExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn transform(self, value: String) -> RequestOrchestrationActionBuilder

Transform to apply the template

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.

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.

pub fn transform_ext( self, value: FieldExtension, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn dynamic_value( self, value: Vec<Option<RequestOrchestrationActionDynamicValue>>, ) -> RequestOrchestrationActionBuilder

Dynamic aspects of the 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.

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.

pub fn dynamic_value_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn action( self, value: Vec<Option<RequestOrchestrationAction>>, ) -> RequestOrchestrationActionBuilder

Sub action

Sub actions.

pub fn action_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequestOrchestrationActionBuilder

Extension field.

pub fn build(self) -> Result<RequestOrchestrationAction, BuilderError>

Builds a new RequestOrchestrationAction.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for RequestOrchestrationActionBuilder

fn default() -> RequestOrchestrationActionBuilder

Returns the “default value” for a type.