Skip to main content

HS.FHIR.vSTU3.Model.Resource.PlanDefinition.Action

deprecated class HS.FHIR.vSTU3.Model.Resource.PlanDefinition.Action extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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 ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = PlanDefinition.Action;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = PlanDefinition.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 action as list of HS.FHIR.vSTU3.Model.Resource.PlanDefinition.Action (XMLNAME = "action", XMLPROJECTION = "ELEMENT");
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: actionBuildValueArray(), actionCollectionToDisplay(), actionCollectionToOdbc(), actionDisplayToCollection(), actionGet(), actionGetObject(), actionGetObjectId(), actionGetSwizzled(), actionIsValid(), actionOdbcToCollection(), actionSet(), actionSetObject(), actionSetObjectId()
property cardinalityBehavior as HS.FHIR.vSTU3.Model.Base.ActionCardinalityBehavior (XMLNAME = "cardinalityBehavior", XMLPROJECTION = "ELEMENT");
Defines whether the action can be selected multiple times.
Property methods: cardinalityBehaviorGet(), cardinalityBehaviorGetSwizzled(), cardinalityBehaviorIsValid(), cardinalityBehaviorNewObject(), cardinalityBehaviorSet()
property code as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a the section of a documentation template.
Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()
property condition as list of HS.FHIR.vSTU3.Model.Resource.PlanDefinition.Condition (XMLNAME = "condition", XMLPROJECTION = "ELEMENT");
An expression that describes applicability criteria, or start/stop conditions for the action.
Property methods: conditionBuildValueArray(), conditionCollectionToDisplay(), conditionCollectionToOdbc(), conditionDisplayToCollection(), conditionGet(), conditionGetObject(), conditionGetObjectId(), conditionGetSwizzled(), conditionIsValid(), conditionOdbcToCollection(), conditionSet(), conditionSetObject(), conditionSetObjectId()
property definition as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
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: definitionGet(), definitionGetSwizzled(), definitionIsValid(), definitionNewObject(), definitionSet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A short description of the action used to provide a summary to display to the user.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property documentation as list of HS.FHIR.vSTU3.Model.Base.RelatedArtifact (XMLNAME = "documentation", XMLPROJECTION = "ELEMENT");
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: documentationBuildValueArray(), documentationCollectionToDisplay(), documentationCollectionToOdbc(), documentationDisplayToCollection(), documentationGet(), documentationGetObject(), documentationGetObjectId(), documentationGetSwizzled(), documentationIsValid(), documentationOdbcToCollection(), documentationSet(), documentationSetObject(), documentationSetObjectId()
property dynamicValue as list of HS.FHIR.vSTU3.Model.Resource.PlanDefinition.DynamicValue (XMLNAME = "dynamicValue", XMLPROJECTION = "ELEMENT");
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: dynamicValueBuildValueArray(), dynamicValueCollectionToDisplay(), dynamicValueCollectionToOdbc(), dynamicValueDisplayToCollection(), dynamicValueGet(), dynamicValueGetObject(), dynamicValueGetObjectId(), dynamicValueGetSwizzled(), dynamicValueIsValid(), dynamicValueOdbcToCollection(), dynamicValueSet(), dynamicValueSetObject(), dynamicValueSetObjectId()
property goalId as list of HS.FHIR.vSTU3.Model.Datatype.Id (XMLNAME = "goalId", XMLPROJECTION = "ELEMENT");
Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Property methods: goalIdBuildValueArray(), goalIdCollectionToDisplay(), goalIdCollectionToOdbc(), goalIdDisplayToCollection(), goalIdGet(), goalIdGetObject(), goalIdGetObjectId(), goalIdGetSwizzled(), goalIdIsValid(), goalIdOdbcToCollection(), goalIdSet(), goalIdSetObject(), goalIdSetObjectId()
property groupingBehavior as HS.FHIR.vSTU3.Model.Base.ActionGroupingBehavior (XMLNAME = "groupingBehavior", XMLPROJECTION = "ELEMENT");
Defines the grouping behavior for the action and its children.
Property methods: groupingBehaviorGet(), groupingBehaviorGetSwizzled(), groupingBehaviorIsValid(), groupingBehaviorNewObject(), groupingBehaviorSet()
property input as list of HS.FHIR.vSTU3.Model.Base.DataRequirement (XMLNAME = "input", XMLPROJECTION = "ELEMENT");
Defines input data requirements for the action.
Property methods: inputBuildValueArray(), inputCollectionToDisplay(), inputCollectionToOdbc(), inputDisplayToCollection(), inputGet(), inputGetObject(), inputGetObjectId(), inputGetSwizzled(), inputIsValid(), inputOdbcToCollection(), inputSet(), inputSetObject(), inputSetObjectId()
property label as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "label", XMLPROJECTION = "ELEMENT");
A user-visible label for the action.
Property methods: labelGet(), labelGetSwizzled(), labelIsValid(), labelNewObject(), labelSet()
property output as list of HS.FHIR.vSTU3.Model.Base.DataRequirement (XMLNAME = "output", XMLPROJECTION = "ELEMENT");
Defines the outputs of the action, if any.
Property methods: outputBuildValueArray(), outputCollectionToDisplay(), outputCollectionToOdbc(), outputDisplayToCollection(), outputGet(), outputGetObject(), outputGetObjectId(), outputGetSwizzled(), outputIsValid(), outputOdbcToCollection(), outputSet(), outputSetObject(), outputSetObjectId()
property participant as list of HS.FHIR.vSTU3.Model.Resource.PlanDefinition.Participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT");
Indicates who should participate in performing the action described.
Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property precheckBehavior as HS.FHIR.vSTU3.Model.Base.ActionPrecheckBehavior (XMLNAME = "precheckBehavior", XMLPROJECTION = "ELEMENT");
Defines whether the action should usually be preselected.
Property methods: precheckBehaviorGet(), precheckBehaviorGetSwizzled(), precheckBehaviorIsValid(), precheckBehaviorNewObject(), precheckBehaviorSet()
property reason as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
A description of why this action is necessary or appropriate.
Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property relatedAction as list of HS.FHIR.vSTU3.Model.Resource.PlanDefinition.RelatedAction (XMLNAME = "relatedAction", XMLPROJECTION = "ELEMENT");
A relationship to another action such as "before" or "30-60 minutes after start of".
Property methods: relatedActionBuildValueArray(), relatedActionCollectionToDisplay(), relatedActionCollectionToOdbc(), relatedActionDisplayToCollection(), relatedActionGet(), relatedActionGetObject(), relatedActionGetObjectId(), relatedActionGetSwizzled(), relatedActionIsValid(), relatedActionOdbcToCollection(), relatedActionSet(), relatedActionSetObject(), relatedActionSetObjectId()
property requiredBehavior as HS.FHIR.vSTU3.Model.Base.ActionRequiredBehavior (XMLNAME = "requiredBehavior", XMLPROJECTION = "ELEMENT");
Defines the requiredness behavior for the action.
Property methods: requiredBehaviorGet(), requiredBehaviorGetSwizzled(), requiredBehaviorIsValid(), requiredBehaviorNewObject(), requiredBehaviorSet()
property selectionBehavior as HS.FHIR.vSTU3.Model.Base.ActionSelectionBehavior (XMLNAME = "selectionBehavior", XMLPROJECTION = "ELEMENT");
Defines the selection behavior for the action and its children.
Property methods: selectionBehaviorGet(), selectionBehaviorGetSwizzled(), selectionBehaviorIsValid(), selectionBehaviorNewObject(), selectionBehaviorSet()
property textEquivalent as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "textEquivalent", XMLPROJECTION = "ELEMENT");
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 may not be capable of interpreting it dynamically.
Property methods: textEquivalentGet(), textEquivalentGetSwizzled(), textEquivalentIsValid(), textEquivalentNewObject(), textEquivalentSet()
property timingDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "timingDateTime", XMLPROJECTION = "ELEMENT");
Property methods: timingDateTimeGet(), timingDateTimeGetSwizzled(), timingDateTimeIsValid(), timingDateTimeNewObject(), timingDateTimeSet()
property timingDuration as HS.FHIR.vSTU3.Model.Base.Duration (XMLNAME = "timingDuration", XMLPROJECTION = "ELEMENT");
Property methods: timingDurationGet(), timingDurationGetSwizzled(), timingDurationIsValid(), timingDurationNewObject(), timingDurationSet()
property timingPeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "timingPeriod", XMLPROJECTION = "ELEMENT");
Property methods: timingPeriodGet(), timingPeriodGetSwizzled(), timingPeriodIsValid(), timingPeriodNewObject(), timingPeriodSet()
property timingRange as HS.FHIR.vSTU3.Model.Base.Range (XMLNAME = "timingRange", XMLPROJECTION = "ELEMENT");
Property methods: timingRangeGet(), timingRangeGetSwizzled(), timingRangeIsValid(), timingRangeNewObject(), timingRangeSet()
property timingTiming as HS.FHIR.vSTU3.Model.Base.Timing (XMLNAME = "timingTiming", XMLPROJECTION = "ELEMENT");
Property methods: timingTimingGet(), timingTimingGetSwizzled(), timingTimingIsValid(), timingTimingNewObject(), timingTimingSet()
property title as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "title", XMLPROJECTION = "ELEMENT");
The title of the action displayed to a user.
Property methods: titleGet(), titleGetSwizzled(), titleIsValid(), titleNewObject(), titleSet()
property transform as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "transform", XMLPROJECTION = "ELEMENT");
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: transformGet(), transformGetSwizzled(), transformIsValid(), transformNewObject(), transformSet()
property triggerDefinition as list of HS.FHIR.vSTU3.Model.Base.TriggerDefinition (XMLNAME = "triggerDefinition", XMLPROJECTION = "ELEMENT");
A description of when the action should be triggered.
Property methods: triggerDefinitionBuildValueArray(), triggerDefinitionCollectionToDisplay(), triggerDefinitionCollectionToOdbc(), triggerDefinitionDisplayToCollection(), triggerDefinitionGet(), triggerDefinitionGetObject(), triggerDefinitionGetObjectId(), triggerDefinitionGetSwizzled(), triggerDefinitionIsValid(), triggerDefinitionOdbcToCollection(), triggerDefinitionSet(), triggerDefinitionSetObject(), triggerDefinitionSetObjectId()
property type as HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
The type of action to perform (create, update, remove).
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

deprecated method SetCardinalityBehavior(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "cardinalityBehavior" property.
deprecated method SetCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "code" property.
deprecated method SetDefinition(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "definition" property.
deprecated method SetDescription(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
deprecated method SetGoalId(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "goalId" property.
deprecated method SetGroupingBehavior(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "groupingBehavior" property.
deprecated method SetLabel(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "label" property.
deprecated method SetPrecheckBehavior(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "precheckBehavior" property.
deprecated method SetReason(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reason" property.
deprecated method SetRequiredBehavior(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "requiredBehavior" property.
deprecated method SetSelectionBehavior(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "selectionBehavior" property.
deprecated method SetTextEquivalent(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "textEquivalent" property.
deprecated method SetTimingDateTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "timingDateTime" property.
deprecated method SetTimingPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "timingPeriod" property.
deprecated method SetTitle(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "title" property.
deprecated method SetTransform(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "transform" property.
deprecated method SetType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab