PlanDefinitionAction class

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.

Annotations
  • @freezed

Constructors

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.
const
factory
PlanDefinitionAction.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
PlanDefinitionAction.fromJsonString(String source)
Acts like a constructor, returns a PlanDefinitionAction, accepts a String as an argument, mostly because I got tired of typing it out
factory
PlanDefinitionAction.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

action → List<PlanDefinitionAction>?
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.
no setterinherited
cardinalityBehavior → FhirCode?
cardinalityBehavior Defines whether the action can be selected multiple times.
no setterinherited
cardinalityBehaviorElement → Element?
cardinalityBehaviorElement ("_cardinalityBehavior") Extensions for cardinalityBehavior
no setterinherited
code → CodeableConcept?
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.
no setterinherited
condition → List<PlanDefinitionCondition>?
condition An expression that describes applicability criteria or start/stop conditions for the action.
no setterinherited
copyWith → $PlanDefinitionActionCopyWith<PlanDefinitionAction>
no setterinherited
definitionCanonical → FhirCanonical?
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.
no setterinherited
definitionCanonicalElement → Element?
definitionCanonicalElement ("_definitionCanonical") Extensions for definitionCanonical
no setterinherited
definitionUri → FhirUri?
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.
no setterinherited
definitionUriElement → Element?
definitionUriElement ("_definitionUri") Extensions for definitionUri
no setterinherited
description → FhirMarkdown?
description A brief description of the action used to provide a summary to display to the user.
no setterinherited
descriptionElement → Element?
descriptionElement ("_description") Extensions for description
no setterinherited
documentation → List<RelatedArtifact>?
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.
no setterinherited
dynamicValue → List<PlanDefinitionDynamicValue>?
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.
no setterinherited
extension_ → List<FhirExtension>?
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.
no setterinherited
fhirId → String?
id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
no setterinherited
goalId → List<FhirId>?
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.
no setterinherited
goalIdElement → List<Element>?
goalIdElement ("_goalId") Extensions for goalId
no setterinherited
groupingBehavior → FhirCode?
groupingBehavior Defines the grouping behavior for the action and its children.
no setterinherited
groupingBehaviorElement → Element?
groupingBehaviorElement ("_groupingBehavior") Extensions for groupingBehavior
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
input → List<PlanDefinitionInput>?
input Defines input data requirements for the action.
no setterinherited
linkId → String?
linkId An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.
no setterinherited
linkIdElement → Element?
linkIdElement ("_linkId") Extensions for linkId
no setterinherited
location → CodeableReference?
location Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.
no setterinherited
modifierExtension → List<FhirExtension>?
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).
no setterinherited
output → List<PlanDefinitionOutput>?
output Defines the outputs of the action, if any.
no setterinherited
participant → List<PlanDefinitionParticipant>?
participant Indicates who should participate in performing the action described.
no setterinherited
precheckBehavior → FhirCode?
precheckBehavior Defines whether the action should usually be preselected.
no setterinherited
precheckBehaviorElement → Element?
precheckBehaviorElement ("_precheckBehavior") Extensions for precheckBehavior
no setterinherited
prefix → String?
prefix A user-visible prefix for the action. For example a section or item numbering such as 1. or A.
no setterinherited
prefixElement → Element?
prefixElement ("_prefix") Extensions for prefix
no setterinherited
priority → FhirCode?
priority Indicates how quickly the action should be addressed with respect to other actions.
no setterinherited
priorityElement → Element?
priorityElement ("_priority") Extensions for priority
no setterinherited
reason → List<CodeableConcept>?
reason A description of why this action is necessary or appropriate.
no setterinherited
relatedAction → List<PlanDefinitionRelatedAction>?
relatedAction A relationship to another action such as "before" or "30-60 minutes after start of".
no setterinherited
requiredBehavior → FhirCode?
requiredBehavior Defines the required behavior for the action.
no setterinherited
requiredBehaviorElement → Element?
requiredBehaviorElement ("_requiredBehavior") Extensions for requiredBehavior
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectionBehavior → FhirCode?
selectionBehavior Defines the selection behavior for the action and its children.
no setterinherited
selectionBehaviorElement → Element?
selectionBehaviorElement ("_selectionBehavior") Extensions for selectionBehavior
no setterinherited
subjectCanonical → FhirCanonical?
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.
no setterinherited
subjectCanonicalElement → Element?
subjectCanonicalElement ("_subjectCanonical") Extensions for subjectCanonical
no setterinherited
subjectCodeableConcept → CodeableConcept?
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.
no setterinherited
subjectReference → Reference?
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.
no setterinherited
textEquivalent → FhirMarkdown?
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.
no setterinherited
textEquivalentElement → Element?
textEquivalentElement ("_textEquivalent") Extensions for textEquivalent
no setterinherited
timingAge → Age?
timingAge An optional value describing when the action should be performed.
no setterinherited
timingDuration → FhirDuration?
timingDuration An optional value describing when the action should be performed.
no setterinherited
timingRange → Range?
timingRange An optional value describing when the action should be performed.
no setterinherited
timingTiming → Timing?
timingTiming An optional value describing when the action should be performed.
no setterinherited
title → String?
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.
no setterinherited
titleElement → Element?
titleElement ("_title") Extensions for title
no setterinherited
transform → FhirCanonical?
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.
no setterinherited
trigger → List<TriggerDefinition>?
trigger A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.
no setterinherited
type → CodeableConcept?
type The type of action to perform (create, update, remove).
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
inherited
toJsonString() → String
Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map
toString() → String
A string representation of this object.
inherited
toYaml() → String
Produces a Yaml formatted String version of the object

Operators

operator ==(Object other) → bool
The equality operator.
inherited