Skip to main content

HS.FHIR.DTL.vR4.Model.Element.PlanDefinition.action

class HS.FHIR.DTL.vR4.Model.Element.PlanDefinition.action extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

Action defined by the plan.

Property 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 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 XMLPROJECTION = ELEMENT;
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.DTL.vR4.Model.Element.PlanDefinition.action (XMLNAME = "action", XMLPROJECTION = "ELEMENT");
PlanDefinition:action

A sub-action.

Property methods: actionBuildValueArray(), actionCollectionToDisplay(), actionCollectionToOdbc(), actionDisplayToCollection(), actionGet(), actionGetObject(), actionGetObjectId(), actionGetSwizzled(), actionIsValid(), actionOdbcToCollection(), actionSet(), actionSetObject(), actionSetObjectId()
property cardinalityBehavior as %String (MAXLEN = 1000000, XMLNAME = "cardinalityBehavior", XMLPROJECTION = "ATTRIBUTE");
code

single | multiple

action-cardinality-behavior|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend action-cardinality-behavior|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: cardinalityBehaviorDisplayToLogical(), cardinalityBehaviorGet(), cardinalityBehaviorIsValid(), cardinalityBehaviorLogicalToDisplay(), cardinalityBehaviorLogicalToOdbc(), cardinalityBehaviorNormalize(), cardinalityBehaviorSet()
property code as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
CodeableConcept

Code representing the meaning of the action or sub-actions.

any FHIR4 code from any ValueSet may be used.

Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()
property condition as list of HS.FHIR.DTL.vR4.Model.Element.PlanDefinition.action.condition (XMLNAME = "condition", XMLPROJECTION = "ELEMENT");
BackboneElement

Whether or not the action is applicable.

Property methods: conditionBuildValueArray(), conditionCollectionToDisplay(), conditionCollectionToOdbc(), conditionDisplayToCollection(), conditionGet(), conditionGetObject(), conditionGetObjectId(), conditionGetSwizzled(), conditionIsValid(), conditionOdbcToCollection(), conditionSet(), conditionSetObject(), conditionSetObjectId()
property definitionCanonical as %String (MAXLEN = 1000000, XMLNAME = "definitionCanonical", XMLPROJECTION = "ATTRIBUTE");
canonical

Description of the activity to be performed.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: definitionCanonicalDisplayToLogical(), definitionCanonicalGet(), definitionCanonicalIsValid(), definitionCanonicalLogicalToDisplay(), definitionCanonicalLogicalToOdbc(), definitionCanonicalNormalize(), definitionCanonicalSet()
property definitionUri as %String (MAXLEN = 1000000, XMLNAME = "definitionUri", XMLPROJECTION = "ATTRIBUTE");
uri

Description of the activity to be performed.

Property methods: definitionUriDisplayToLogical(), definitionUriGet(), definitionUriIsValid(), definitionUriLogicalToDisplay(), definitionUriLogicalToOdbc(), definitionUriNormalize(), definitionUriSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Brief description of the action.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property documentation as list of HS.FHIR.DTL.vR4.Model.Datatype.RelatedArtifact (XMLNAME = "documentation", XMLPROJECTION = "ELEMENT");
RelatedArtifact

Supporting documentation for the intended performer of the action.

Property methods: documentationBuildValueArray(), documentationCollectionToDisplay(), documentationCollectionToOdbc(), documentationDisplayToCollection(), documentationGet(), documentationGetObject(), documentationGetObjectId(), documentationGetSwizzled(), documentationIsValid(), documentationOdbcToCollection(), documentationSet(), documentationSetObject(), documentationSetObjectId()
property dynamicValue as list of HS.FHIR.DTL.vR4.Model.Element.PlanDefinition.action.dynamicValue (XMLNAME = "dynamicValue", XMLPROJECTION = "ELEMENT");
BackboneElement

Dynamic aspects of the definition.

Property methods: dynamicValueBuildValueArray(), dynamicValueCollectionToDisplay(), dynamicValueCollectionToOdbc(), dynamicValueDisplayToCollection(), dynamicValueGet(), dynamicValueGetObject(), dynamicValueGetObjectId(), dynamicValueGetSwizzled(), dynamicValueIsValid(), dynamicValueOdbcToCollection(), dynamicValueSet(), dynamicValueSetObject(), dynamicValueSetObjectId()
property goalId as list of %String (MAXLEN = 1000000, XMLNAME = "goalId", XMLPROJECTION = "ELEMENT");
id

What goals this action supports.

Property methods: goalIdBuildValueArray(), goalIdCollectionToDisplay(), goalIdCollectionToOdbc(), goalIdDisplayToCollection(), goalIdDisplayToLogical(), goalIdGet(), goalIdGetObject(), goalIdGetObjectId(), goalIdGetSwizzled(), goalIdIsValid(), goalIdLogicalToDisplay(), goalIdLogicalToOdbc(), goalIdNormalize(), goalIdOdbcToCollection(), goalIdSet(), goalIdSetObject(), goalIdSetObjectId()
property groupingBehavior as %String (MAXLEN = 1000000, XMLNAME = "groupingBehavior", XMLPROJECTION = "ATTRIBUTE");
code

visual-group | logical-group | sentence-group

action-grouping-behavior|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend action-grouping-behavior|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: groupingBehaviorDisplayToLogical(), groupingBehaviorGet(), groupingBehaviorIsValid(), groupingBehaviorLogicalToDisplay(), groupingBehaviorLogicalToOdbc(), groupingBehaviorNormalize(), groupingBehaviorSet()
property input as list of HS.FHIR.DTL.vR4.Model.Datatype.DataRequirement (XMLNAME = "input", XMLPROJECTION = "ELEMENT");
DataRequirement

Input data requirements.

Property methods: inputBuildValueArray(), inputCollectionToDisplay(), inputCollectionToOdbc(), inputDisplayToCollection(), inputGet(), inputGetObject(), inputGetObjectId(), inputGetSwizzled(), inputIsValid(), inputOdbcToCollection(), inputSet(), inputSetObject(), inputSetObjectId()
property output as list of HS.FHIR.DTL.vR4.Model.Datatype.DataRequirement (XMLNAME = "output", XMLPROJECTION = "ELEMENT");
DataRequirement

Output data definition.

Property methods: outputBuildValueArray(), outputCollectionToDisplay(), outputCollectionToOdbc(), outputDisplayToCollection(), outputGet(), outputGetObject(), outputGetObjectId(), outputGetSwizzled(), outputIsValid(), outputOdbcToCollection(), outputSet(), outputSetObject(), outputSetObjectId()
property participant as list of HS.FHIR.DTL.vR4.Model.Element.PlanDefinition.action.participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT");
BackboneElement

Who should participate in the action.

Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property precheckBehavior as %String (MAXLEN = 1000000, XMLNAME = "precheckBehavior", XMLPROJECTION = "ATTRIBUTE");
code

yes | no

action-precheck-behavior|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend action-precheck-behavior|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: precheckBehaviorDisplayToLogical(), precheckBehaviorGet(), precheckBehaviorIsValid(), precheckBehaviorLogicalToDisplay(), precheckBehaviorLogicalToOdbc(), precheckBehaviorNormalize(), precheckBehaviorSet()
property prefix as %String (MAXLEN = 1000000, XMLNAME = "prefix", XMLPROJECTION = "ATTRIBUTE");
string

User-visible prefix for the action (e.g. 1. or A.)

Property methods: prefixDisplayToLogical(), prefixGet(), prefixIsValid(), prefixLogicalToDisplay(), prefixLogicalToOdbc(), prefixNormalize(), prefixSet()
property priority as %String (MAXLEN = 1000000, XMLNAME = "priority", XMLPROJECTION = "ATTRIBUTE");
code

routine | urgent | asap | stat

request-priority|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend request-priority|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property reason as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why the action should be performed.

any FHIR4 code from any ValueSet may be used.

Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property relatedAction as list of HS.FHIR.DTL.vR4.Model.Element.PlanDefinition.action.relatedAction (XMLNAME = "relatedAction", XMLPROJECTION = "ELEMENT");
BackboneElement

Relationship to another action.

Property methods: relatedActionBuildValueArray(), relatedActionCollectionToDisplay(), relatedActionCollectionToOdbc(), relatedActionDisplayToCollection(), relatedActionGet(), relatedActionGetObject(), relatedActionGetObjectId(), relatedActionGetSwizzled(), relatedActionIsValid(), relatedActionOdbcToCollection(), relatedActionSet(), relatedActionSetObject(), relatedActionSetObjectId()
property requiredBehavior as %String (MAXLEN = 1000000, XMLNAME = "requiredBehavior", XMLPROJECTION = "ATTRIBUTE");
code

must | could | must-unless-documented

action-required-behavior|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend action-required-behavior|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: requiredBehaviorDisplayToLogical(), requiredBehaviorGet(), requiredBehaviorIsValid(), requiredBehaviorLogicalToDisplay(), requiredBehaviorLogicalToOdbc(), requiredBehaviorNormalize(), requiredBehaviorSet()
property selectionBehavior as %String (MAXLEN = 1000000, XMLNAME = "selectionBehavior", XMLPROJECTION = "ATTRIBUTE");
code

any | all | all-or-none | exactly-one | at-most-one | one-or-more

action-selection-behavior|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend action-selection-behavior|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: selectionBehaviorDisplayToLogical(), selectionBehaviorGet(), selectionBehaviorIsValid(), selectionBehaviorLogicalToDisplay(), selectionBehaviorLogicalToOdbc(), selectionBehaviorNormalize(), selectionBehaviorSet()
property subjectCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "subjectCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of individual the action is focused on.

subject-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in subject-type, you may formally EXTEND subject-type to add codes to it.

Property methods: subjectCodeableConceptGet(), subjectCodeableConceptGetSwizzled(), subjectCodeableConceptIsValid(), subjectCodeableConceptNewObject(), subjectCodeableConceptSet()
property subjectReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subjectReference", XMLPROJECTION = "ELEMENT");
Reference

Type of individual the action is focused on.

Group.

Property methods: subjectReferenceGet(), subjectReferenceGetSwizzled(), subjectReferenceIsValid(), subjectReferenceNewObject(), subjectReferenceSet()
property textEquivalent as %String (MAXLEN = 1000000, XMLNAME = "textEquivalent", XMLPROJECTION = "ATTRIBUTE");
string

Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system.

Property methods: textEquivalentDisplayToLogical(), textEquivalentGet(), textEquivalentIsValid(), textEquivalentLogicalToDisplay(), textEquivalentLogicalToOdbc(), textEquivalentNormalize(), textEquivalentSet()
property timingAge as HS.FHIR.DTL.vR4.Model.Datatype.Age (XMLNAME = "timingAge", XMLPROJECTION = "ELEMENT");
Age

When the action should take place.

Property methods: timingAgeGet(), timingAgeGetSwizzled(), timingAgeIsValid(), timingAgeNewObject(), timingAgeSet()
property timingDateTime as %String (MAXLEN = 1000000, XMLNAME = "timingDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the action should take place.

Property methods: timingDateTimeDisplayToLogical(), timingDateTimeGet(), timingDateTimeIsValid(), timingDateTimeLogicalToDisplay(), timingDateTimeLogicalToOdbc(), timingDateTimeNormalize(), timingDateTimeSet()
property timingDuration as HS.FHIR.DTL.vR4.Model.Datatype.Duration (XMLNAME = "timingDuration", XMLPROJECTION = "ELEMENT");
Duration

When the action should take place.

Property methods: timingDurationGet(), timingDurationGetSwizzled(), timingDurationIsValid(), timingDurationNewObject(), timingDurationSet()
property timingPeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "timingPeriod", XMLPROJECTION = "ELEMENT");
Period

When the action should take place.

Property methods: timingPeriodGet(), timingPeriodGetSwizzled(), timingPeriodIsValid(), timingPeriodNewObject(), timingPeriodSet()
property timingRange as HS.FHIR.DTL.vR4.Model.Datatype.Range (XMLNAME = "timingRange", XMLPROJECTION = "ELEMENT");
Range

When the action should take place.

Property methods: timingRangeGet(), timingRangeGetSwizzled(), timingRangeIsValid(), timingRangeNewObject(), timingRangeSet()
property timingTiming as HS.FHIR.DTL.vR4.Model.Datatype.Timing (XMLNAME = "timingTiming", XMLPROJECTION = "ELEMENT");
Timing

When the action should take place.

Property methods: timingTimingGet(), timingTimingGetSwizzled(), timingTimingIsValid(), timingTimingNewObject(), timingTimingSet()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");
string

User-visible title.

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property transform as %String (MAXLEN = 1000000, XMLNAME = "transform", XMLPROJECTION = "ATTRIBUTE");
canonical

Transform to apply the template.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: transformDisplayToLogical(), transformGet(), transformIsValid(), transformLogicalToDisplay(), transformLogicalToOdbc(), transformNormalize(), transformSet()
property trigger as list of HS.FHIR.DTL.vR4.Model.Datatype.TriggerDefinition (XMLNAME = "trigger", XMLPROJECTION = "ELEMENT");
TriggerDefinition

When the action should be triggered.

Property methods: triggerBuildValueArray(), triggerCollectionToDisplay(), triggerCollectionToOdbc(), triggerDisplayToCollection(), triggerGet(), triggerGetObject(), triggerGetObjectId(), triggerGetSwizzled(), triggerIsValid(), triggerOdbcToCollection(), triggerSet(), triggerSetObject(), triggerSetObjectId()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

create | update | remove | fire-event

action-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in action-type, you may formally EXTEND action-type to add codes to it.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab