RequestOrchestrationAction constructor
- @JsonKey(name: 'id') String? fhirId,
- @JsonKey(name: 'extension') List<
FhirExtension> ? extension_, - List<
FhirExtension> ? modifierExtension, - String? linkId,
- @JsonKey(name: '_linkId') Element? linkIdElement,
- String? prefix,
- @JsonKey(name: '_prefix') Element? prefixElement,
- String? title,
- @JsonKey(name: '_title') Element? titleElement,
- FhirMarkdown? description,
- @JsonKey(name: '_description') Element? descriptionElement,
- FhirMarkdown? textEquivalent,
- @JsonKey(name: '_textEquivalent') Element? textEquivalentElement,
- FhirCode? priority,
- @JsonKey(name: '_priority') Element? priorityElement,
- List<
CodeableConcept> ? code, - List<
RelatedArtifact> ? documentation, - List<
Reference> ? goal, - List<
RequestOrchestrationCondition> ? condition, - List<
RequestOrchestrationInput> ? input, - List<
RequestOrchestrationOutput> ? output, - FhirDateTime? timingDateTime,
- @JsonKey(name: '_timingDateTime') Element? timingDateTimeElement,
- Age? timingAge,
- Period? timingPeriod,
- FhirDuration? timingDuration,
- Range? timingRange,
- Timing? timingTiming,
- CodeableReference? location,
- List<
RequestOrchestrationParticipant> ? participant, - CodeableConcept? type,
- FhirCode? groupingBehavior,
- @JsonKey(name: '_groupingBehavior') Element? groupingBehaviorElement,
- FhirCode? selectionBehavior,
- @JsonKey(name: '_selectionBehavior') Element? selectionBehaviorElement,
- FhirCode? requiredBehavior,
- @JsonKey(name: '_requiredBehavior') Element? requiredBehaviorElement,
- FhirCode? precheckBehavior,
- @JsonKey(name: '_precheckBehavior') Element? precheckBehaviorElement,
- FhirCode? cardinalityBehavior,
- @JsonKey(name: '_cardinalityBehavior') Element? cardinalityBehaviorElement,
- Reference? resource,
- FhirCanonical? definitionCanonical,
- @JsonKey(name: '_definitionCanonical') Element? definitionCanonicalElement,
- FhirUri? definitionUri,
- @JsonKey(name: '_definitionUri') Element? definitionUriElement,
- FhirCanonical? transform,
- List<
RequestOrchestrationDynamicValue> ? dynamicValue, - List<
RequestOrchestrationAction> ? action,
RequestOrchestrationAction 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".
id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension_
("extension") 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.
modifierExtension
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).
linkId
The linkId of the action from the PlanDefinition that
corresponds to this action in the RequestOrchestration resource.
linkIdElement
("_linkId") Extensions for linkId
prefix
A user-visible prefix for the action. For example a section or
item numbering such as 1. or A.
prefixElement
("_prefix") Extensions for prefix
title
The title of the action displayed to a user.
titleElement
("_title") Extensions for title
description
A short description of the action used to provide a summary
to display to the user.
descriptionElement
("_description") Extensions for description
textEquivalent
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.
textEquivalentElement
("_textEquivalent") Extensions for textEquivalent
priority
Indicates how quickly the action should be addressed with
respect to other actions.
priorityElement
("_priority") Extensions for priority
code
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.
documentation
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.
goal
Goals that are intended to be achieved by following the requests
in this action.
condition
An expression that describes applicability criteria, or
start/stop conditions for the action.
input
Defines input data requirements for the action.
output
Defines the outputs of the action, if any.
relatedAction
A relationship to another action such as "before" or
"30-60 minutes after start of".
timingDateTime
An optional value describing when the action should be
performed.
timingDateTimeElement
("_timingDateTime") Extensions for timingDateTime
timingAge
An optional value describing when the action should be
performed.
timingPeriod
An optional value describing when the action should be
performed.
timingDuration
An optional value describing when the action should be
performed.
timingRange
An optional value describing when the action should be
performed.
timingTiming
An optional value describing when the action should be
performed.
location
Identifies the facility where the action will occur; e.g.
home, hospital, specific clinic, etc.
participant
The participant that should perform or be responsible for
this action.
type
The type of action to perform (create, update, remove).
groupingBehavior
Defines the grouping behavior for the action and its
children.
groupingBehaviorElement
("_groupingBehavior") Extensions for
groupingBehavior
selectionBehavior
Defines the selection behavior for the action and its
children.
selectionBehaviorElement
("_selectionBehavior") Extensions for
selectionBehavior
requiredBehavior
Defines expectations around whether an action is
required.
requiredBehaviorElement
("_requiredBehavior") Extensions for
requiredBehavior
precheckBehavior
Defines whether the action should usually be
preselected.
precheckBehaviorElement
("_precheckBehavior") Extensions for
precheckBehavior
cardinalityBehavior
Defines whether the action can be selected multiple
times.
cardinalityBehaviorElement
("_cardinalityBehavior") Extensions for
cardinalityBehavior
resource
The resource that is the target of the action (e.g.
CommunicationRequest).
definitionCanonical
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.
definitionCanonicalElement
("_definitionCanonical") Extensions for
definitionCanonical
definitionUri
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.
definitionUriElement
("_definitionUri") Extensions for definitionUri
transform
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.
dynamicValue
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.
action
Sub actions.
Implementation
const factory RequestOrchestrationAction({
/// [id] Unique id for the element within a resource (for internal
/// references). This may be any string value that does not contain spaces.
@JsonKey(name: 'id') String? fhirId,
/// [extension_] ("extension") 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.
@JsonKey(name: 'extension') List<FhirExtension>? extension_,
/// [modifierExtension] 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).
List<FhirExtension>? modifierExtension,
/// [linkId] The linkId of the action from the PlanDefinition that
/// corresponds to this action in the RequestOrchestration resource.
String? linkId,
/// [linkIdElement] ("_linkId") Extensions for linkId
@JsonKey(name: '_linkId') Element? linkIdElement,
/// [prefix] A user-visible prefix for the action. For example a section or
/// item numbering such as 1. or A.
String? prefix,
/// [prefixElement] ("_prefix") Extensions for prefix
@JsonKey(name: '_prefix') Element? prefixElement,
/// [title] The title of the action displayed to a user.
String? title,
/// [titleElement] ("_title") Extensions for title
@JsonKey(name: '_title') Element? titleElement,
/// [description] A short description of the action used to provide a
/// summary to display to the user.
FhirMarkdown? description,
/// [descriptionElement] ("_description") Extensions for description
@JsonKey(name: '_description') Element? descriptionElement,
/// [textEquivalent] 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.
FhirMarkdown? textEquivalent,
/// [textEquivalentElement] ("_textEquivalent") Extensions for
/// textEquivalent
@JsonKey(name: '_textEquivalent') Element? textEquivalentElement,
/// [priority] Indicates how quickly the action should be addressed with
/// respect to other actions.
FhirCode? priority,
/// [priorityElement] ("_priority") Extensions for priority
@JsonKey(name: '_priority') Element? priorityElement,
/// [code] 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.
List<CodeableConcept>? code,
/// [documentation] 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.
List<RelatedArtifact>? documentation,
/// [goal] Goals that are intended to be achieved by following the requests
/// in this action.
List<Reference>? goal,
/// [condition] An expression that describes applicability criteria, or
/// start/stop conditions for the action.
List<RequestOrchestrationCondition>? condition,
/// [input] Defines input data requirements for the action.
List<RequestOrchestrationInput>? input,
/// [output] Defines the outputs of the action, if any.
List<RequestOrchestrationOutput>? output,
/// [relatedAction] A relationship to another action such as "before" or
/// "30-60 minutes after start of".
List<RequestOrchestrationRelatedAction>? relatedAction,
/// [timingDateTime] An optional value describing when the action should be
/// performed.
FhirDateTime? timingDateTime,
/// [timingDateTimeElement] ("_timingDateTime") Extensions for
/// timingDateTime
@JsonKey(name: '_timingDateTime') Element? timingDateTimeElement,
/// [timingAge] An optional value describing when the action should be
/// performed.
Age? timingAge,
/// [timingPeriod] An optional value describing when the action should be
/// performed.
Period? timingPeriod,
/// [timingDuration] An optional value describing when the action should be
/// performed.
FhirDuration? timingDuration,
/// [timingRange] An optional value describing when the action should be
/// performed.
Range? timingRange,
/// [timingTiming] An optional value describing when the action should be
/// performed.
Timing? timingTiming,
/// [location] Identifies the facility where the action will occur; e.g.
/// home, hospital, specific clinic, etc.
CodeableReference? location,
/// [participant] The participant that should perform or be responsible for
/// this action.
List<RequestOrchestrationParticipant>? participant,
/// [type] The type of action to perform (create, update, remove).
CodeableConcept? type,
/// [groupingBehavior] Defines the grouping behavior for the action and its
/// children.
FhirCode? groupingBehavior,
/// [groupingBehaviorElement] ("_groupingBehavior") Extensions for
/// groupingBehavior
@JsonKey(name: '_groupingBehavior') Element? groupingBehaviorElement,
/// [selectionBehavior] Defines the selection behavior for the action and
/// its children.
FhirCode? selectionBehavior,
/// [selectionBehaviorElement] ("_selectionBehavior") Extensions for
/// selectionBehavior
@JsonKey(name: '_selectionBehavior') Element? selectionBehaviorElement,
/// [requiredBehavior] Defines expectations around whether an action is
/// required.
FhirCode? requiredBehavior,
/// [requiredBehaviorElement] ("_requiredBehavior") Extensions for
/// requiredBehavior
@JsonKey(name: '_requiredBehavior') Element? requiredBehaviorElement,
/// [precheckBehavior] Defines whether the action should usually be
/// preselected.
FhirCode? precheckBehavior,
/// [precheckBehaviorElement] ("_precheckBehavior") Extensions for
/// precheckBehavior
@JsonKey(name: '_precheckBehavior') Element? precheckBehaviorElement,
/// [cardinalityBehavior] Defines whether the action can be selected
/// multiple times.
FhirCode? cardinalityBehavior,
/// [cardinalityBehaviorElement] ("_cardinalityBehavior") Extensions for
/// cardinalityBehavior
@JsonKey(name: '_cardinalityBehavior') Element? cardinalityBehaviorElement,
/// [resource] The resource that is the target of the action (e.g.
/// CommunicationRequest).
Reference? resource,
/// [definitionCanonical] 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.
FhirCanonical? definitionCanonical,
/// [definitionCanonicalElement] ("_definitionCanonical") Extensions for
/// definitionCanonical
@JsonKey(name: '_definitionCanonical') Element? definitionCanonicalElement,
/// [definitionUri] 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.
FhirUri? definitionUri,
/// [definitionUriElement] ("_definitionUri") Extensions for definitionUri
@JsonKey(name: '_definitionUri') Element? definitionUriElement,
/// [transform] 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.
FhirCanonical? transform,
/// [dynamicValue] 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.
List<RequestOrchestrationDynamicValue>? dynamicValue,
/// [action] Sub actions.
List<RequestOrchestrationAction>? action,
}) = _RequestOrchestrationAction;