PlanDefinitionAction constructor

const PlanDefinitionAction({ @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, 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') Element? subjectCanonicalElement, List<TriggerDefinition>? trigger, List<PlanDefinitionCondition>? condition, List<PlanDefinitionInput>? input, List<PlanDefinitionOutput>? output, List<PlanDefinitionRelatedAction>? relatedAction, Age? timingAge, FhirDuration? timingDuration, Range? timingRange, Timing? timingTiming, CodeableReference? location, 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 and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

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 An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.

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 textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.

titleElement ("_title") Extensions for title

description A brief 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 a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.

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. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.

goalIdElement ("_goalId") Extensions for goalId

subjectCodeableConcept A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

subjectReference A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

subjectCanonical A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

subjectCanonicalElement ("_subjectCanonical") Extensions for subjectCanonical

trigger A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the 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".

timingAge 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 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 ("_groupingBehavior") Extensions for groupingBehavior

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

selectionBehaviorElement ("_selectionBehavior") Extensions for selectionBehavior

requiredBehavior Defines the required behavior for the action.

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

definitionCanonical A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, 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 MessageDefinition describing a message to be snet, 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 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') 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] An identifier that is unique within the PlanDefinition to
  ///  allow linkage within the realized CarePlan and/or RequestOrchestration.
  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 textual description of the action displayed to a user. For
  ///  example, when the action is a test to be performed, the title would be
  ///  the title of the test such as Assay by HPLC.
  String? title,

  /// [titleElement] ("_title") 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.
  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 a meaning, grouping, or classification for
  ///  the action or action group. For example, a section may have a LOINC
  ///  code for the section of a documentation template. In pharmaceutical
  ///  quality, an action (Test) such as pH could be classified as a physical
  ///  property.
  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. In
  ///  pharmaceutical quality, a goal represents acceptance criteria (Goal)
  ///  for a given action (Test), so the goalId would be the unique id of a
  ///  defined goal element establishing the acceptance criteria for the
  ///  action.
  List<FhirId>? goalId,

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

  /// [subjectCodeableConcept] A code, group definition, or canonical
  ///  reference that describes the intended subject of the action and its
  ///  children, if any. Canonical references are allowed to support the
  ///  definition of protocols for drug and substance quality specifications,
  ///  and is allowed to reference a MedicinalProductDefinition,
  ///  SubstanceDefinition, AdministrableProductDefinition,
  ///  ManufacturedItemDefinition, or PackagedProductDefinition resource.
  CodeableConcept? subjectCodeableConcept,

  /// [subjectReference] A code, group definition, or canonical reference
  ///  that describes the intended subject of the action and its children, if
  ///  any. Canonical references are allowed to support the definition of
  ///  protocols for drug and substance quality specifications, and is
  ///  allowed to reference a MedicinalProductDefinition,
  ///  SubstanceDefinition, AdministrableProductDefinition,
  ///  ManufacturedItemDefinition, or PackagedProductDefinition resource.
  Reference? subjectReference,

  /// [subjectCanonical] A code, group definition, or canonical reference
  ///  that describes the intended subject of the action and its children, if
  ///  any. Canonical references are allowed to support the definition of
  ///  protocols for drug and substance quality specifications, and is
  ///  allowed to reference a MedicinalProductDefinition,
  ///  SubstanceDefinition, AdministrableProductDefinition,
  ///  ManufacturedItemDefinition, or PackagedProductDefinition resource.
  FhirCanonical? subjectCanonical,

  /// [subjectCanonicalElement] ("_subjectCanonical") Extensions for
  ///  subjectCanonical
  @JsonKey(name: '_subjectCanonical') Element? subjectCanonicalElement,

  /// [trigger] A description of when the action should be triggered. When
  ///  multiple triggers are specified on an action, any triggering event
  ///  invokes the action.
  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<PlanDefinitionInput>? input,

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

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

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

  /// [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] 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] ("_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 the required behavior for the action.
  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,

  /// [definitionCanonical] A reference to an ActivityDefinition that
  ///  describes the action to be taken in detail, a MessageDefinition
  ///  describing a message to be snet, 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 MessageDefinition describing a message
  ///  to be snet, 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<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;