Skip to main content

HS.FHIRModel.R4.PlanDefinitionX.Action

class HS.FHIRModel.R4.PlanDefinitionX.Action extends HS.FHIRModel.FHIRClassSuper

*****************************************
** PlanDefinitionX.Action generated class schema
*****************************************
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.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_PLANDEFINITIONX_ACTION;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _cardinalityBehavior as HS.FHIRModel.R4.Element;
Extensions for cardinalityBehavior
Property methods: _cardinalityBehaviorGet(), _cardinalityBehaviorGetSwizzled(), _cardinalityBehaviorIsValid(), _cardinalityBehaviorNewObject(), _cardinalityBehaviorSet()
property _definitionCanonical as HS.FHIRModel.R4.Element;
Extensions for definitionCanonical
Property methods: _definitionCanonicalGet(), _definitionCanonicalGetSwizzled(), _definitionCanonicalIsValid(), _definitionCanonicalNewObject(), _definitionCanonicalSet()
property _definitionUri as HS.FHIRModel.R4.Element;
Extensions for definitionUri
Property methods: _definitionUriGet(), _definitionUriGetSwizzled(), _definitionUriIsValid(), _definitionUriNewObject(), _definitionUriSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _goalId as HS.FHIRModel.R4.SeqOfElement;
Extensions for goalId
Property methods: _goalIdGet(), _goalIdGetSwizzled(), _goalIdIsValid(), _goalIdNewObject(), _goalIdSet()
property _groupingBehavior as HS.FHIRModel.R4.Element;
Extensions for groupingBehavior
Property methods: _groupingBehaviorGet(), _groupingBehaviorGetSwizzled(), _groupingBehaviorIsValid(), _groupingBehaviorNewObject(), _groupingBehaviorSet()
property _precheckBehavior as HS.FHIRModel.R4.Element;
Extensions for precheckBehavior
Property methods: _precheckBehaviorGet(), _precheckBehaviorGetSwizzled(), _precheckBehaviorIsValid(), _precheckBehaviorNewObject(), _precheckBehaviorSet()
property _prefix as HS.FHIRModel.R4.Element;
Extensions for prefix
Property methods: _prefixGet(), _prefixGetSwizzled(), _prefixIsValid(), _prefixNewObject(), _prefixSet()
property _priority as HS.FHIRModel.R4.Element;
Extensions for priority
Property methods: _priorityGet(), _priorityGetSwizzled(), _priorityIsValid(), _priorityNewObject(), _prioritySet()
property _requiredBehavior as HS.FHIRModel.R4.Element;
Extensions for requiredBehavior
Property methods: _requiredBehaviorGet(), _requiredBehaviorGetSwizzled(), _requiredBehaviorIsValid(), _requiredBehaviorNewObject(), _requiredBehaviorSet()
property _selectionBehavior as HS.FHIRModel.R4.Element;
Extensions for selectionBehavior
Property methods: _selectionBehaviorGet(), _selectionBehaviorGetSwizzled(), _selectionBehaviorIsValid(), _selectionBehaviorNewObject(), _selectionBehaviorSet()
property _textEquivalent as HS.FHIRModel.R4.Element;
Extensions for textEquivalent
Property methods: _textEquivalentGet(), _textEquivalentGetSwizzled(), _textEquivalentIsValid(), _textEquivalentNewObject(), _textEquivalentSet()
property _timingDateTime as HS.FHIRModel.R4.Element;
Extensions for timingDateTime
Property methods: _timingDateTimeGet(), _timingDateTimeGetSwizzled(), _timingDateTimeIsValid(), _timingDateTimeNewObject(), _timingDateTimeSet()
property _title as HS.FHIRModel.R4.Element;
Extensions for title
Property methods: _titleGet(), _titleGetSwizzled(), _titleIsValid(), _titleNewObject(), _titleSet()
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.
Property methods: actionGet(), actionGetSwizzled(), actionIsValid(), actionNewObject(), actionSet()
property cardinalityBehavior as %String (VALUELIST = ",single,multiple");
Defines whether the action can be selected multiple times.
Property methods: cardinalityBehaviorDisplayToLogical(), cardinalityBehaviorGet(), cardinalityBehaviorIsValid(), cardinalityBehaviorLogicalToDisplay(), cardinalityBehaviorLogicalToOdbc(), cardinalityBehaviorNormalize(), cardinalityBehaviorSet()
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.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
An expression that describes applicability criteria or start/stop conditions for the action.
Property methods: conditionGet(), conditionGetSwizzled(), conditionIsValid(), conditionNewObject(), conditionSet()
property definitionCanonical as %String;
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.
Property methods: definitionCanonicalDisplayToLogical(), definitionCanonicalGet(), definitionCanonicalIsValid(), definitionCanonicalLogicalToDisplay(), definitionCanonicalLogicalToOdbc(), definitionCanonicalNormalize(), definitionCanonicalSet()
property definitionUri as %String;
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.
Property methods: definitionUriDisplayToLogical(), definitionUriGet(), definitionUriIsValid(), definitionUriLogicalToDisplay(), definitionUriLogicalToOdbc(), definitionUriNormalize(), definitionUriSet()
property description as %String;
A brief description of the action used to provide a summary to display to the user.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property documentation as HS.FHIRModel.R4.SeqOfRelatedArtifact;
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.
Property methods: documentationGet(), documentationGetSwizzled(), documentationIsValid(), documentationNewObject(), documentationSet()
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.
Property methods: dynamicValueGet(), dynamicValueGetSwizzled(), dynamicValueIsValid(), dynamicValueNewObject(), dynamicValueSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property goalId as HS.FHIRModel.R4.SeqOfString;
Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Property methods: goalIdGet(), goalIdGetSwizzled(), goalIdIsValid(), goalIdNewObject(), goalIdSet()
property groupingBehavior as %String (VALUELIST = ",visual-group,logical-group,sentence-group");
Defines the grouping behavior for the action and its children.
Property methods: groupingBehaviorDisplayToLogical(), groupingBehaviorGet(), groupingBehaviorIsValid(), groupingBehaviorLogicalToDisplay(), groupingBehaviorLogicalToOdbc(), groupingBehaviorNormalize(), groupingBehaviorSet()
Defines input data requirements for the action.
Property methods: inputGet(), inputGetSwizzled(), inputIsValid(), inputNewObject(), inputSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Defines the outputs of the action, if any.
Property methods: outputGet(), outputGetSwizzled(), outputIsValid(), outputNewObject(), outputSet()
Indicates who should participate in performing the action described.
Property methods: participantGet(), participantGetSwizzled(), participantIsValid(), participantNewObject(), participantSet()
property precheckBehavior as %String (VALUELIST = ",yes,no");
Defines whether the action should usually be preselected.
Property methods: precheckBehaviorDisplayToLogical(), precheckBehaviorGet(), precheckBehaviorIsValid(), precheckBehaviorLogicalToDisplay(), precheckBehaviorLogicalToOdbc(), precheckBehaviorNormalize(), precheckBehaviorSet()
property prefix as %String;
A user-visible prefix for the action.
Property methods: prefixDisplayToLogical(), prefixGet(), prefixIsValid(), prefixLogicalToDisplay(), prefixLogicalToOdbc(), prefixNormalize(), prefixSet()
property priority as %String;
Indicates how quickly the action should be addressed with respect to other actions.
Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
A description of why this action is necessary or appropriate.
Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
A relationship to another action such as "before" or "30-60 minutes after start of".
Property methods: relatedActionGet(), relatedActionGetSwizzled(), relatedActionIsValid(), relatedActionNewObject(), relatedActionSet()
property requiredBehavior as %String (VALUELIST = ",must,could,must-unless-documented");
Defines the required behavior for the action.
Property methods: requiredBehaviorDisplayToLogical(), requiredBehaviorGet(), requiredBehaviorIsValid(), requiredBehaviorLogicalToDisplay(), requiredBehaviorLogicalToOdbc(), requiredBehaviorNormalize(), requiredBehaviorSet()
property selectionBehavior as %String (VALUELIST = ",any,all,all-or-none,exactly-one,at-most-one,one-or-more");
Defines the selection behavior for the action and its children.
Property methods: selectionBehaviorDisplayToLogical(), selectionBehaviorGet(), selectionBehaviorIsValid(), selectionBehaviorLogicalToDisplay(), selectionBehaviorLogicalToOdbc(), selectionBehaviorNormalize(), selectionBehaviorSet()
property subjectCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
A code or group definition that describes the intended subject of the action and its children, if any.
Property methods: subjectCodeableConceptGet(), subjectCodeableConceptGetSwizzled(), subjectCodeableConceptIsValid(), subjectCodeableConceptNewObject(), subjectCodeableConceptSet()
property subjectReference as HS.FHIRModel.R4.Reference;
A code or group definition that describes the intended subject of the action and its children, if any.
Property methods: subjectReferenceGet(), subjectReferenceGetSwizzled(), subjectReferenceIsValid(), subjectReferenceNewObject(), subjectReferenceSet()
property textEquivalent as %String;
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.
Property methods: textEquivalentDisplayToLogical(), textEquivalentGet(), textEquivalentIsValid(), textEquivalentLogicalToDisplay(), textEquivalentLogicalToOdbc(), textEquivalentNormalize(), textEquivalentSet()
property timingAge as HS.FHIRModel.R4.Age;
An optional value describing when the action should be performed.
Property methods: timingAgeGet(), timingAgeGetSwizzled(), timingAgeIsValid(), timingAgeNewObject(), timingAgeSet()
property timingDateTime as %String;
An optional value describing when the action should be performed.
Property methods: timingDateTimeDisplayToLogical(), timingDateTimeGet(), timingDateTimeIsValid(), timingDateTimeLogicalToDisplay(), timingDateTimeLogicalToOdbc(), timingDateTimeNormalize(), timingDateTimeSet()
property timingDuration as HS.FHIRModel.R4.Duration;
An optional value describing when the action should be performed.
Property methods: timingDurationGet(), timingDurationGetSwizzled(), timingDurationIsValid(), timingDurationNewObject(), timingDurationSet()
property timingPeriod as HS.FHIRModel.R4.Period;
An optional value describing when the action should be performed.
Property methods: timingPeriodGet(), timingPeriodGetSwizzled(), timingPeriodIsValid(), timingPeriodNewObject(), timingPeriodSet()
property timingRange as HS.FHIRModel.R4.Range;
An optional value describing when the action should be performed.
Property methods: timingRangeGet(), timingRangeGetSwizzled(), timingRangeIsValid(), timingRangeNewObject(), timingRangeSet()
property timingTiming as HS.FHIRModel.R4.Timing;
An optional value describing when the action should be performed.
Property methods: timingTimingGet(), timingTimingGetSwizzled(), timingTimingIsValid(), timingTimingNewObject(), timingTimingSet()
property title as %String;
The title of the action displayed to a user.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property transform as %String;
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.
Property methods: transformDisplayToLogical(), transformGet(), transformIsValid(), transformLogicalToDisplay(), transformLogicalToOdbc(), transformNormalize(), transformSet()
A description of when the action should be triggered.
Property methods: triggerGet(), triggerGetSwizzled(), triggerIsValid(), triggerNewObject(), triggerSet()
The type of action to perform (create, update, remove).
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

method IncludeAction()
method IncludeCode()
method IncludeCondition()
method IncludeDocumentation()
method IncludeDynamicValue()
method IncludeExtension()
method IncludeGoalId()
method IncludeInput()
method IncludeModifierExtension()
method IncludeOutput()
method IncludeParticipant()
method IncludeReason()
method IncludeRelatedAction()
method IncludeSubjectCodeableConcept()
method IncludeSubjectReference()
method IncludeTimingAge()
method IncludeTimingDuration()
method IncludeTimingPeriod()
method IncludeTimingRange()
method IncludeTimingTiming()
method IncludeTrigger()
method IncludeType()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab