PlanDefinitionAction constructor

const PlanDefinitionAction({ @JsonKey(name: 'id') FhirId? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, String? prefix, @JsonKey(name: '_prefix') Element? prefixElement, String? title, @JsonKey(name: '_title') Element? titleElement, String? description, @JsonKey(name: '_description') Element? descriptionElement, String? textEquivalent, @JsonKey(name: '_textEquivalent') Element? textEquivalentElement, FhirCode? priority, @JsonKey(name: '_priority') Element? priorityElement, List<CodeableConcept>? code, List<CodeableConcept>? reason, List<RelatedArtifact>? documentation, List<FhirId>? goalId, @JsonKey(name: '_goalId') List<Element?>? goalIdElement, CodeableConcept? subjectCodeableConcept, Reference? subjectReference, FhirCanonical? subjectCanonical, @JsonKey(name: '_subjectCanonical') List<Element?>? subjectCanonicalElement, List<TriggerDefinition>? trigger, List<PlanDefinitionCondition>? condition, List<DataRequirement>? input, List<DataRequirement>? output, List<PlanDefinitionRelatedAction>? relatedAction, FhirDateTime? timingDateTime, @JsonKey(name: '_timingDateTime') Element? timingDateTimeElement, Age? timingAge, Period? timingPeriod, FhirDuration? timingDuration, Range? timingRange, Timing? timingTiming, List<PlanDefinitionParticipant>? 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, FhirCanonical? definitionCanonical, @JsonKey(name: '_definitionCanonical') Element? definitionCanonicalElement, FhirUri? definitionUri, @JsonKey(name: '_definitionUri') Element? definitionUriElement, FhirCanonical? transform, List<PlanDefinitionDynamicValue>? dynamicValue, List<PlanDefinitionAction>? action, })

PlanDefinitionAction This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

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

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

prefix A user-visible prefix for the action.

prefixElement Extensions for prefix

title The title of the action displayed to a user.

titleElement Extensions for title

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

descriptionElement 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 Extensions for textEquivalent

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

priorityElement 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 the section of a documentation template.

reason A description of why this action is necessary or appropriate.

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.

goalId Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

goalIdElement Extensions for goalId

subjectCodeableConcept A code or group definition that describes the intended subject of the action and its children, if any.

subjectReference A code or group definition that describes the intended subject of the action and its children, if any.

trigger A description of when the action should be triggered.

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

participant Indicates who should participate in performing the action described.

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

groupingBehavior Defines the grouping behavior for the action and its children.

groupingBehaviorElement Extensions for groupingBehavior

selectionBehavior Defines the selection behavior for the action and its children.

selectionBehaviorElement Extensions for selectionBehavior

requiredBehavior Defines the required behavior for the action.

requiredBehaviorElement Extensions for requiredBehavior

precheckBehavior Defines whether the action should usually be preselected.

precheckBehaviorElement Extensions for precheckBehavior

cardinalityBehavior Defines whether the action can be selected multiple times.

cardinalityBehaviorElement Extensions for cardinalityBehavior

definitionCanonical A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

definitionCanonicalElement Extensions for definitionCanonical

definitionUri A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.

definitionUriElement 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 that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

Implementation

const factory PlanDefinitionAction({
  /// [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') FhirId? fhirId,

  /// [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 manageable, 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 manageable, 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,

  /// [prefix] A user-visible prefix for the action.
  String? prefix,

  /// [prefixElement] Extensions for prefix
  @JsonKey(name: '_prefix') Element? prefixElement,

  /// [title] The title of the action displayed to a user.
  String? title,

  /// [titleElement] Extensions for title
  @JsonKey(name: '_title') Element? titleElement,

  /// [description] A brief description of the action used to provide a summary
  ///  to display to the user.
  String? description,

  /// [descriptionElement] 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.
  String? textEquivalent,

  /// [textEquivalentElement] 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] 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 the section of a
  ///  documentation template.
  List<CodeableConcept>? code,

  /// [reason] A description of why this action is necessary or appropriate.
  List<CodeableConcept>? reason,

  /// [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,

  /// [goalId] Identifies goals that this action supports. The reference must
  ///  be to a goal element defined within this plan definition.
  List<FhirId>? goalId,

  /// [goalIdElement] Extensions for goalId
  @JsonKey(name: '_goalId') List<Element?>? goalIdElement,

  /// [subjectCodeableConcept] A code or group definition that describes the
  ///  intended subject of the action and its children, if any.
  CodeableConcept? subjectCodeableConcept,

  /// [subjectReference] A code or group definition that describes the intended
  ///  subject of the action and its children, if any.
  Reference? subjectReference,
  FhirCanonical? subjectCanonical,
  @JsonKey(name: '_subjectCanonical') List<Element?>? subjectCanonicalElement,

  /// [trigger] A description of when the action should be triggered.
  List<TriggerDefinition>? trigger,

  /// [condition] An expression that describes applicability criteria or
  ///  start/stop conditions for the action.
  List<PlanDefinitionCondition>? condition,

  /// [input] Defines input data requirements for the action.
  List<DataRequirement>? input,

  /// [output] Defines the outputs of the action, if any.
  List<DataRequirement>? output,

  /// [relatedAction] A relationship to another action such as "before" or
  ///  "30-60 minutes after start of".
  List<PlanDefinitionRelatedAction>? relatedAction,

  /// [timingDateTime] An optional value describing when the action should be
  ///  performed.
  FhirDateTime? timingDateTime,

  /// [timingDateTimeElement] 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,

  /// [participant] Indicates who should participate in performing the action
  ///  described.
  List<PlanDefinitionParticipant>? 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] Extensions for groupingBehavior
  @JsonKey(name: '_groupingBehavior') Element? groupingBehaviorElement,

  /// [selectionBehavior] Defines the selection behavior for the action and its
  ///  children.
  FhirCode? selectionBehavior,

  /// [selectionBehaviorElement] Extensions for selectionBehavior
  @JsonKey(name: '_selectionBehavior') Element? selectionBehaviorElement,

  /// [requiredBehavior] Defines the required behavior for the action.
  FhirCode? requiredBehavior,

  /// [requiredBehaviorElement] Extensions for requiredBehavior
  @JsonKey(name: '_requiredBehavior') Element? requiredBehaviorElement,

  /// [precheckBehavior] Defines whether the action should usually be
  ///  preselected.
  FhirCode? precheckBehavior,

  /// [precheckBehaviorElement] Extensions for precheckBehavior
  @JsonKey(name: '_precheckBehavior') Element? precheckBehaviorElement,

  /// [cardinalityBehavior] Defines whether the action can be selected multiple
  ///  times.
  FhirCode? cardinalityBehavior,

  /// [cardinalityBehaviorElement] Extensions for cardinalityBehavior
  @JsonKey(name: '_cardinalityBehavior') Element? cardinalityBehaviorElement,

  /// [definitionCanonical] A reference to an ActivityDefinition that describes
  /// the action to be taken in detail, or a PlanDefinition that describes a
  ///  series of actions to be taken.
  FhirCanonical? definitionCanonical,

  /// [definitionCanonicalElement] Extensions for definitionCanonical
  @JsonKey(name: '_definitionCanonical') Element? definitionCanonicalElement,

  /// [definitionUri] A reference to an ActivityDefinition that describes the
  /// action to be taken in detail, or a PlanDefinition that describes a series
  ///  of actions to be taken.
  FhirUri? definitionUri,

  /// [definitionUriElement] 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<PlanDefinitionDynamicValue>? dynamicValue,

  /// [action] Sub actions that are contained within the action. The behavior
  /// of this action determines the functionality of the sub-actions. For
  /// example, a selection behavior of at-most-one indicates that of the
  /// sub-actions, at most one may be chosen as part of realizing the action
  ///  definition.
  List<PlanDefinitionAction>? action,
}) = _PlanDefinitionAction;