Package org.hl7.fhir.dstu3.model

Class PlanDefinition.PlanDefinitionActionComponent

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.Element

org.hl7.fhir.dstu3.model.BackboneElement

org.hl7.fhir.dstu3.model.PlanDefinition.PlanDefinitionActionComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

PlanDefinition

public static class PlanDefinition.PlanDefinitionActionComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<PlanDefinition.PlanDefinitionActionComponent>	action	Sub actions that are contained within the action.
protected Enumeration<PlanDefinition.ActionCardinalityBehavior>	cardinalityBehavior	Defines whether the action can be selected multiple times.
protected List<CodeableConcept>	code	A code that provides meaning for the action or action group.
protected List<PlanDefinition.PlanDefinitionActionConditionComponent>	condition	An expression that describes applicability criteria, or start/stop conditions for the action.
protected Reference	definition	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.
protected Resource	definitionTarget	The actual object that is the target of the reference (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.)
protected StringType	description	A short description of the action used to provide a summary to display to the user.
protected List<RelatedArtifact>	documentation	Didactic or other informational resources associated with the action that can be provided to the CDS recipient.
protected List<PlanDefinition.PlanDefinitionActionDynamicValueComponent>	dynamicValue	Customizations that should be applied to the statically defined resource.
protected List<IdType>	goalId	Identifies goals that this action supports.
protected Enumeration<PlanDefinition.ActionGroupingBehavior>	groupingBehavior	Defines the grouping behavior for the action and its children.
protected List<DataRequirement>	input	Defines input data requirements for the action.
protected StringType	label	A user-visible label for the action.
protected List<DataRequirement>	output	Defines the outputs of the action, if any.
protected List<PlanDefinition.PlanDefinitionActionParticipantComponent>	participant	Indicates who should participate in performing the action described.
protected Enumeration<PlanDefinition.ActionPrecheckBehavior>	precheckBehavior	Defines whether the action should usually be preselected.
protected List<CodeableConcept>	reason	A description of why this action is necessary or appropriate.
protected List<PlanDefinition.PlanDefinitionActionRelatedActionComponent>	relatedAction	A relationship to another action such as "before" or "30-60 minutes after start of".
protected Enumeration<PlanDefinition.ActionRequiredBehavior>	requiredBehavior	Defines the requiredness behavior for the action.
protected Enumeration<PlanDefinition.ActionSelectionBehavior>	selectionBehavior	Defines the selection behavior for the action and its children.
protected StringType	textEquivalent	A text equivalent of the action to be performed.
protected Type	timing	An optional value describing when the action should be performed.
protected StringType	title	The title of the action displayed to a user.
protected Reference	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.
protected StructureMap	transformTarget	The actual object that is the target of the reference (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.)
protected List<TriggerDefinition>	triggerDefinition	A description of when the action should be triggered.
protected Coding	type	The type of action to perform (create, update, remove).

Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.dstu3.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
PlanDefinitionActionComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
PlanDefinition.PlanDefinitionActionComponent	addAction()
PlanDefinition.PlanDefinitionActionComponent	addAction(PlanDefinition.PlanDefinitionActionComponent t)
Base	addChild(String name)
CodeableConcept	addCode()
PlanDefinition.PlanDefinitionActionComponent	addCode(CodeableConcept t)
PlanDefinition.PlanDefinitionActionConditionComponent	addCondition()
PlanDefinition.PlanDefinitionActionComponent	addCondition(PlanDefinition.PlanDefinitionActionConditionComponent t)
RelatedArtifact	addDocumentation()
PlanDefinition.PlanDefinitionActionComponent	addDocumentation(RelatedArtifact t)
PlanDefinition.PlanDefinitionActionDynamicValueComponent	addDynamicValue()
PlanDefinition.PlanDefinitionActionComponent	addDynamicValue(PlanDefinition.PlanDefinitionActionDynamicValueComponent t)
PlanDefinition.PlanDefinitionActionComponent	addGoalId(String value)
IdType	addGoalIdElement()
DataRequirement	addInput()
PlanDefinition.PlanDefinitionActionComponent	addInput(DataRequirement t)
DataRequirement	addOutput()
PlanDefinition.PlanDefinitionActionComponent	addOutput(DataRequirement t)
PlanDefinition.PlanDefinitionActionParticipantComponent	addParticipant()
PlanDefinition.PlanDefinitionActionComponent	addParticipant(PlanDefinition.PlanDefinitionActionParticipantComponent t)
CodeableConcept	addReason()
PlanDefinition.PlanDefinitionActionComponent	addReason(CodeableConcept t)
PlanDefinition.PlanDefinitionActionRelatedActionComponent	addRelatedAction()
PlanDefinition.PlanDefinitionActionComponent	addRelatedAction(PlanDefinition.PlanDefinitionActionRelatedActionComponent t)
TriggerDefinition	addTriggerDefinition()
PlanDefinition.PlanDefinitionActionComponent	addTriggerDefinition(TriggerDefinition t)
PlanDefinition.PlanDefinitionActionComponent	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<PlanDefinition.PlanDefinitionActionComponent>	getAction()
PlanDefinition.PlanDefinitionActionComponent	getActionFirstRep()
PlanDefinition.ActionCardinalityBehavior	getCardinalityBehavior()
Enumeration<PlanDefinition.ActionCardinalityBehavior>	getCardinalityBehaviorElement()
List<CodeableConcept>	getCode()
CodeableConcept	getCodeFirstRep()
List<PlanDefinition.PlanDefinitionActionConditionComponent>	getCondition()
PlanDefinition.PlanDefinitionActionConditionComponent	getConditionFirstRep()
Reference	getDefinition()
Resource	getDefinitionTarget()
String	getDescription()
StringType	getDescriptionElement()
List<RelatedArtifact>	getDocumentation()
RelatedArtifact	getDocumentationFirstRep()
List<PlanDefinition.PlanDefinitionActionDynamicValueComponent>	getDynamicValue()
PlanDefinition.PlanDefinitionActionDynamicValueComponent	getDynamicValueFirstRep()
List<IdType>	getGoalId()
PlanDefinition.ActionGroupingBehavior	getGroupingBehavior()
Enumeration<PlanDefinition.ActionGroupingBehavior>	getGroupingBehaviorElement()
List<DataRequirement>	getInput()
DataRequirement	getInputFirstRep()
String	getLabel()
StringType	getLabelElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<DataRequirement>	getOutput()
DataRequirement	getOutputFirstRep()
List<PlanDefinition.PlanDefinitionActionParticipantComponent>	getParticipant()
PlanDefinition.PlanDefinitionActionParticipantComponent	getParticipantFirstRep()
PlanDefinition.ActionPrecheckBehavior	getPrecheckBehavior()
Enumeration<PlanDefinition.ActionPrecheckBehavior>	getPrecheckBehaviorElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableConcept>	getReason()
CodeableConcept	getReasonFirstRep()
List<PlanDefinition.PlanDefinitionActionRelatedActionComponent>	getRelatedAction()
PlanDefinition.PlanDefinitionActionRelatedActionComponent	getRelatedActionFirstRep()
PlanDefinition.ActionRequiredBehavior	getRequiredBehavior()
Enumeration<PlanDefinition.ActionRequiredBehavior>	getRequiredBehaviorElement()
PlanDefinition.ActionSelectionBehavior	getSelectionBehavior()
Enumeration<PlanDefinition.ActionSelectionBehavior>	getSelectionBehaviorElement()
String	getTextEquivalent()
StringType	getTextEquivalentElement()
Type	getTiming()
DateTimeType	getTimingDateTimeType()
Duration	getTimingDuration()
Period	getTimingPeriod()
Range	getTimingRange()
Timing	getTimingTiming()
String	getTitle()
StringType	getTitleElement()
Reference	getTransform()
StructureMap	getTransformTarget()
List<TriggerDefinition>	getTriggerDefinition()
TriggerDefinition	getTriggerDefinitionFirstRep()
Coding	getType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAction()
boolean	hasCardinalityBehavior()
boolean	hasCardinalityBehaviorElement()
boolean	hasCode()
boolean	hasCondition()
boolean	hasDefinition()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDocumentation()
boolean	hasDynamicValue()
boolean	hasGoalId()
boolean	hasGoalId(String value)
boolean	hasGroupingBehavior()
boolean	hasGroupingBehaviorElement()
boolean	hasInput()
boolean	hasLabel()
boolean	hasLabelElement()
boolean	hasOutput()
boolean	hasParticipant()
boolean	hasPrecheckBehavior()
boolean	hasPrecheckBehaviorElement()
boolean	hasReason()
boolean	hasRelatedAction()
boolean	hasRequiredBehavior()
boolean	hasRequiredBehaviorElement()
boolean	hasSelectionBehavior()
boolean	hasSelectionBehaviorElement()
boolean	hasTextEquivalent()
boolean	hasTextEquivalentElement()
boolean	hasTiming()
boolean	hasTimingDateTimeType()
boolean	hasTimingDuration()
boolean	hasTimingPeriod()
boolean	hasTimingRange()
boolean	hasTimingTiming()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	hasTransform()
boolean	hasTriggerDefinition()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
PlanDefinition.PlanDefinitionActionComponent	setAction(List<PlanDefinition.PlanDefinitionActionComponent> theAction)
PlanDefinition.PlanDefinitionActionComponent	setCardinalityBehavior(PlanDefinition.ActionCardinalityBehavior value)
PlanDefinition.PlanDefinitionActionComponent	setCardinalityBehaviorElement(Enumeration<PlanDefinition.ActionCardinalityBehavior> value)
PlanDefinition.PlanDefinitionActionComponent	setCode(List<CodeableConcept> theCode)
PlanDefinition.PlanDefinitionActionComponent	setCondition(List<PlanDefinition.PlanDefinitionActionConditionComponent> theCondition)
PlanDefinition.PlanDefinitionActionComponent	setDefinition(Reference value)
PlanDefinition.PlanDefinitionActionComponent	setDefinitionTarget(Resource value)
PlanDefinition.PlanDefinitionActionComponent	setDescription(String value)
PlanDefinition.PlanDefinitionActionComponent	setDescriptionElement(StringType value)
PlanDefinition.PlanDefinitionActionComponent	setDocumentation(List<RelatedArtifact> theDocumentation)
PlanDefinition.PlanDefinitionActionComponent	setDynamicValue(List<PlanDefinition.PlanDefinitionActionDynamicValueComponent> theDynamicValue)
PlanDefinition.PlanDefinitionActionComponent	setGoalId(List<IdType> theGoalId)
PlanDefinition.PlanDefinitionActionComponent	setGroupingBehavior(PlanDefinition.ActionGroupingBehavior value)
PlanDefinition.PlanDefinitionActionComponent	setGroupingBehaviorElement(Enumeration<PlanDefinition.ActionGroupingBehavior> value)
PlanDefinition.PlanDefinitionActionComponent	setInput(List<DataRequirement> theInput)
PlanDefinition.PlanDefinitionActionComponent	setLabel(String value)
PlanDefinition.PlanDefinitionActionComponent	setLabelElement(StringType value)
PlanDefinition.PlanDefinitionActionComponent	setOutput(List<DataRequirement> theOutput)
PlanDefinition.PlanDefinitionActionComponent	setParticipant(List<PlanDefinition.PlanDefinitionActionParticipantComponent> theParticipant)
PlanDefinition.PlanDefinitionActionComponent	setPrecheckBehavior(PlanDefinition.ActionPrecheckBehavior value)
PlanDefinition.PlanDefinitionActionComponent	setPrecheckBehaviorElement(Enumeration<PlanDefinition.ActionPrecheckBehavior> value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
PlanDefinition.PlanDefinitionActionComponent	setReason(List<CodeableConcept> theReason)
PlanDefinition.PlanDefinitionActionComponent	setRelatedAction(List<PlanDefinition.PlanDefinitionActionRelatedActionComponent> theRelatedAction)
PlanDefinition.PlanDefinitionActionComponent	setRequiredBehavior(PlanDefinition.ActionRequiredBehavior value)
PlanDefinition.PlanDefinitionActionComponent	setRequiredBehaviorElement(Enumeration<PlanDefinition.ActionRequiredBehavior> value)
PlanDefinition.PlanDefinitionActionComponent	setSelectionBehavior(PlanDefinition.ActionSelectionBehavior value)
PlanDefinition.PlanDefinitionActionComponent	setSelectionBehaviorElement(Enumeration<PlanDefinition.ActionSelectionBehavior> value)
PlanDefinition.PlanDefinitionActionComponent	setTextEquivalent(String value)
PlanDefinition.PlanDefinitionActionComponent	setTextEquivalentElement(StringType value)
PlanDefinition.PlanDefinitionActionComponent	setTiming(Type value)
PlanDefinition.PlanDefinitionActionComponent	setTitle(String value)
PlanDefinition.PlanDefinitionActionComponent	setTitleElement(StringType value)
PlanDefinition.PlanDefinitionActionComponent	setTransform(Reference value)
PlanDefinition.PlanDefinitionActionComponent	setTransformTarget(StructureMap value)
PlanDefinition.PlanDefinitionActionComponent	setTriggerDefinition(List<TriggerDefinition> theTriggerDefinition)
PlanDefinition.PlanDefinitionActionComponent	setType(Coding value)

Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.dstu3.model.Element

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

label

protected StringType label

A user-visible label for the action.

title

protected StringType title

The title of the action displayed to a user.

description

protected StringType description

A short description of the action used to provide a summary to display to the user.

textEquivalent

protected StringType 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 may not be capable of interpreting it dynamically.

code

protected List<CodeableConcept> code

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.

reason

protected List<CodeableConcept> reason

A description of why this action is necessary or appropriate.

documentation

protected 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.

goalId

protected List<IdType> goalId

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

triggerDefinition

protected List<TriggerDefinition> triggerDefinition

A description of when the action should be triggered.

condition

protected List<PlanDefinition.PlanDefinitionActionConditionComponent> condition

An expression that describes applicability criteria, or start/stop conditions for the action.

input

protected List<DataRequirement> input

Defines input data requirements for the action.

output

protected List<DataRequirement> output

Defines the outputs of the action, if any.

relatedAction

protected List<PlanDefinition.PlanDefinitionActionRelatedActionComponent> relatedAction

A relationship to another action such as "before" or "30-60 minutes after start of".

timing

protected Type timing

An optional value describing when the action should be performed.

participant

protected List<PlanDefinition.PlanDefinitionActionParticipantComponent> participant

Indicates who should participate in performing the action described.

type

protected Coding type

The type of action to perform (create, update, remove).

groupingBehavior

protected Enumeration<PlanDefinition.ActionGroupingBehavior> groupingBehavior

Defines the grouping behavior for the action and its children.

selectionBehavior

protected Enumeration<PlanDefinition.ActionSelectionBehavior> selectionBehavior

Defines the selection behavior for the action and its children.

requiredBehavior

protected Enumeration<PlanDefinition.ActionRequiredBehavior> requiredBehavior

Defines the requiredness behavior for the action.

precheckBehavior

protected Enumeration<PlanDefinition.ActionPrecheckBehavior> precheckBehavior

Defines whether the action should usually be preselected.

cardinalityBehavior

protected Enumeration<PlanDefinition.ActionCardinalityBehavior> cardinalityBehavior

Defines whether the action can be selected multiple times.

definition

protected Reference definition

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.

definitionTarget

protected Resource definitionTarget

The actual object that is the target of the reference (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.)

transform

protected Reference 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.

transformTarget

protected StructureMap transformTarget

The actual object that is the target of the reference (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

protected List<PlanDefinition.PlanDefinitionActionDynamicValueComponent> 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

protected List<PlanDefinition.PlanDefinitionActionComponent> 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.

Constructor Details

PlanDefinitionActionComponent

public PlanDefinitionActionComponent()

Constructor

Method Details

getLabelElement

public StringType getLabelElement()

Returns:

label (A user-visible label for the action.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

hasLabelElement

public boolean hasLabelElement()

hasLabel

public boolean hasLabel()

setLabelElement

public PlanDefinition.PlanDefinitionActionComponent setLabelElement(StringType value)

Parameters:

value - label (A user-visible label for the action.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

getLabel

public String getLabel()

Returns:

A user-visible label for the action.

setLabel

public PlanDefinition.PlanDefinitionActionComponent setLabel(String value)

Parameters:

value - A user-visible label for the action.

getTitleElement

public StringType getTitleElement()

Returns:

title (The title of the action displayed to a user.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

hasTitleElement

public boolean hasTitleElement()

hasTitle

public boolean hasTitle()

setTitleElement

public PlanDefinition.PlanDefinitionActionComponent setTitleElement(StringType value)

Parameters:

value - title (The title of the action displayed to a user.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

getTitle

public String getTitle()

Returns:

The title of the action displayed to a user.

setTitle

public PlanDefinition.PlanDefinitionActionComponent setTitle(String value)

Parameters:

value - The title of the action displayed to a user.

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (A short description of the action used to provide a summary to display to the user.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public PlanDefinition.PlanDefinitionActionComponent setDescriptionElement(StringType value)

Parameters:

value - description (A short description of the action used to provide a summary to display to the user.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

A short description of the action used to provide a summary to display to the user.

setDescription

public PlanDefinition.PlanDefinitionActionComponent setDescription(String value)

Parameters:

value - A short description of the action used to provide a summary to display to the user.

getTextEquivalentElement

public StringType getTextEquivalentElement()

Returns:

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 may not be capable of interpreting it dynamically.). This is the underlying object with id, value and extensions. The accessor "getTextEquivalent" gives direct access to the value

hasTextEquivalentElement

public boolean hasTextEquivalentElement()

hasTextEquivalent

public boolean hasTextEquivalent()

setTextEquivalentElement

public PlanDefinition.PlanDefinitionActionComponent setTextEquivalentElement(StringType value)

Parameters:

value - 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 may not be capable of interpreting it dynamically.). This is the underlying object with id, value and extensions. The accessor "getTextEquivalent" gives direct access to the value

getTextEquivalent

public String getTextEquivalent()

Returns:

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.

setTextEquivalent

public PlanDefinition.PlanDefinitionActionComponent setTextEquivalent(String value)

Parameters:

value - 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.

getCode

public List<CodeableConcept> getCode()

Returns:

code (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.)

setCode

public PlanDefinition.PlanDefinitionActionComponent setCode(List<CodeableConcept> theCode)

Returns:

Returns a reference to this for easy method chaining

hasCode

public boolean hasCode()

addCode

public CodeableConcept addCode()

addCode

public PlanDefinition.PlanDefinitionActionComponent addCode(CodeableConcept t)

getCodeFirstRep

public CodeableConcept getCodeFirstRep()

Returns:

The first repetition of repeating field code, creating it if it does not already exist

getReason

public List<CodeableConcept> getReason()

Returns:

reason (A description of why this action is necessary or appropriate.)

setReason

public PlanDefinition.PlanDefinitionActionComponent setReason(List<CodeableConcept> theReason)

Returns:

Returns a reference to this for easy method chaining

hasReason

public boolean hasReason()

addReason

public CodeableConcept addReason()

addReason

public PlanDefinition.PlanDefinitionActionComponent addReason(CodeableConcept t)

getReasonFirstRep

public CodeableConcept getReasonFirstRep()

Returns:

The first repetition of repeating field reason, creating it if it does not already exist

getDocumentation

public List<RelatedArtifact> getDocumentation()

Returns:

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.)

setDocumentation

public PlanDefinition.PlanDefinitionActionComponent setDocumentation(List<RelatedArtifact> theDocumentation)

Returns:

Returns a reference to this for easy method chaining

hasDocumentation

public boolean hasDocumentation()

addDocumentation

public RelatedArtifact addDocumentation()

addDocumentation

public PlanDefinition.PlanDefinitionActionComponent addDocumentation(RelatedArtifact t)

getDocumentationFirstRep

public RelatedArtifact getDocumentationFirstRep()

Returns:

The first repetition of repeating field documentation, creating it if it does not already exist

getGoalId

public List<IdType> getGoalId()

Returns:

goalId (Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.)

setGoalId

public PlanDefinition.PlanDefinitionActionComponent setGoalId(List<IdType> theGoalId)

Returns:

Returns a reference to this for easy method chaining

hasGoalId

public boolean hasGoalId()

addGoalIdElement

public IdType addGoalIdElement()

Returns:

goalId (Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.)

addGoalId

public PlanDefinition.PlanDefinitionActionComponent addGoalId(String value)

Parameters:

value - goalId (Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.)

hasGoalId

public boolean hasGoalId(String value)

Parameters:

value - goalId (Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.)

getTriggerDefinition

public List<TriggerDefinition> getTriggerDefinition()

Returns:

triggerDefinition (A description of when the action should be triggered.)

setTriggerDefinition

public PlanDefinition.PlanDefinitionActionComponent setTriggerDefinition(List<TriggerDefinition> theTriggerDefinition)

Returns:

Returns a reference to this for easy method chaining

hasTriggerDefinition

public boolean hasTriggerDefinition()

addTriggerDefinition

public TriggerDefinition addTriggerDefinition()

addTriggerDefinition

public PlanDefinition.PlanDefinitionActionComponent addTriggerDefinition(TriggerDefinition t)

getTriggerDefinitionFirstRep

public TriggerDefinition getTriggerDefinitionFirstRep()

Returns:

The first repetition of repeating field triggerDefinition, creating it if it does not already exist

getCondition

public List<PlanDefinition.PlanDefinitionActionConditionComponent> getCondition()

Returns:

condition (An expression that describes applicability criteria, or start/stop conditions for the action.)

setCondition

public PlanDefinition.PlanDefinitionActionComponent setCondition(List<PlanDefinition.PlanDefinitionActionConditionComponent> theCondition)

Returns:

Returns a reference to this for easy method chaining

hasCondition

public boolean hasCondition()

addCondition

public PlanDefinition.PlanDefinitionActionConditionComponent addCondition()

addCondition

public PlanDefinition.PlanDefinitionActionComponent addCondition(PlanDefinition.PlanDefinitionActionConditionComponent t)

getConditionFirstRep

public PlanDefinition.PlanDefinitionActionConditionComponent getConditionFirstRep()

Returns:

The first repetition of repeating field condition, creating it if it does not already exist

getInput

public List<DataRequirement> getInput()

Returns:

input (Defines input data requirements for the action.)

setInput

public PlanDefinition.PlanDefinitionActionComponent setInput(List<DataRequirement> theInput)

Returns:

Returns a reference to this for easy method chaining

hasInput

public boolean hasInput()

addInput

public DataRequirement addInput()

addInput

public PlanDefinition.PlanDefinitionActionComponent addInput(DataRequirement t)

getInputFirstRep

public DataRequirement getInputFirstRep()

Returns:

The first repetition of repeating field input, creating it if it does not already exist

getOutput

public List<DataRequirement> getOutput()

Returns:

output (Defines the outputs of the action, if any.)

setOutput

public PlanDefinition.PlanDefinitionActionComponent setOutput(List<DataRequirement> theOutput)

Returns:

Returns a reference to this for easy method chaining

hasOutput

public boolean hasOutput()

addOutput

public DataRequirement addOutput()

addOutput

public PlanDefinition.PlanDefinitionActionComponent addOutput(DataRequirement t)

getOutputFirstRep

public DataRequirement getOutputFirstRep()

Returns:

The first repetition of repeating field output, creating it if it does not already exist

getRelatedAction

public List<PlanDefinition.PlanDefinitionActionRelatedActionComponent> getRelatedAction()

Returns:

relatedAction (A relationship to another action such as "before" or "30-60 minutes after start of".)

setRelatedAction

public PlanDefinition.PlanDefinitionActionComponent setRelatedAction(List<PlanDefinition.PlanDefinitionActionRelatedActionComponent> theRelatedAction)

Returns:

Returns a reference to this for easy method chaining

hasRelatedAction

public boolean hasRelatedAction()

addRelatedAction

public PlanDefinition.PlanDefinitionActionRelatedActionComponent addRelatedAction()

addRelatedAction

public PlanDefinition.PlanDefinitionActionComponent addRelatedAction(PlanDefinition.PlanDefinitionActionRelatedActionComponent t)

getRelatedActionFirstRep

public PlanDefinition.PlanDefinitionActionRelatedActionComponent getRelatedActionFirstRep()

Returns:

The first repetition of repeating field relatedAction, creating it if it does not already exist

getTiming

public Type getTiming()

Returns:

timing (An optional value describing when the action should be performed.)

getTimingDateTimeType

public DateTimeType getTimingDateTimeType()
                                   throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (An optional value describing when the action should be performed.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingDateTimeType

public boolean hasTimingDateTimeType()

getTimingPeriod

public Period getTimingPeriod()
                       throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (An optional value describing when the action should be performed.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingPeriod

public boolean hasTimingPeriod()

getTimingDuration

public Duration getTimingDuration()
                           throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (An optional value describing when the action should be performed.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingDuration

public boolean hasTimingDuration()

getTimingRange

public Range getTimingRange()
                     throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (An optional value describing when the action should be performed.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingRange

public boolean hasTimingRange()

getTimingTiming

public Timing getTimingTiming()
                       throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (An optional value describing when the action should be performed.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingTiming

public boolean hasTimingTiming()

hasTiming

public boolean hasTiming()

setTiming

public PlanDefinition.PlanDefinitionActionComponent setTiming(Type value)
                                                       throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

value - timing (An optional value describing when the action should be performed.)

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getParticipant

public List<PlanDefinition.PlanDefinitionActionParticipantComponent> getParticipant()

Returns:

participant (Indicates who should participate in performing the action described.)

setParticipant

public PlanDefinition.PlanDefinitionActionComponent setParticipant(List<PlanDefinition.PlanDefinitionActionParticipantComponent> theParticipant)

Returns:

Returns a reference to this for easy method chaining

hasParticipant

public boolean hasParticipant()

addParticipant

public PlanDefinition.PlanDefinitionActionParticipantComponent addParticipant()

addParticipant

public PlanDefinition.PlanDefinitionActionComponent addParticipant(PlanDefinition.PlanDefinitionActionParticipantComponent t)

getParticipantFirstRep

public PlanDefinition.PlanDefinitionActionParticipantComponent getParticipantFirstRep()

Returns:

The first repetition of repeating field participant, creating it if it does not already exist

getType

public Coding getType()

Returns:

type (The type of action to perform (create, update, remove).)

hasType

public boolean hasType()

setType

public PlanDefinition.PlanDefinitionActionComponent setType(Coding value)

Parameters:

value - type (The type of action to perform (create, update, remove).)

getGroupingBehaviorElement

public Enumeration<PlanDefinition.ActionGroupingBehavior> getGroupingBehaviorElement()

Returns:

groupingBehavior (Defines the grouping behavior for the action and its children.). This is the underlying object with id, value and extensions. The accessor "getGroupingBehavior" gives direct access to the value

hasGroupingBehaviorElement

public boolean hasGroupingBehaviorElement()

hasGroupingBehavior

public boolean hasGroupingBehavior()

setGroupingBehaviorElement

public PlanDefinition.PlanDefinitionActionComponent setGroupingBehaviorElement(Enumeration<PlanDefinition.ActionGroupingBehavior> value)

Parameters:

value - groupingBehavior (Defines the grouping behavior for the action and its children.). This is the underlying object with id, value and extensions. The accessor "getGroupingBehavior" gives direct access to the value

getGroupingBehavior

public PlanDefinition.ActionGroupingBehavior getGroupingBehavior()

Returns:

Defines the grouping behavior for the action and its children.

setGroupingBehavior

public PlanDefinition.PlanDefinitionActionComponent setGroupingBehavior(PlanDefinition.ActionGroupingBehavior value)

Parameters:

value - Defines the grouping behavior for the action and its children.

getSelectionBehaviorElement

public Enumeration<PlanDefinition.ActionSelectionBehavior> getSelectionBehaviorElement()

Returns:

selectionBehavior (Defines the selection behavior for the action and its children.). This is the underlying object with id, value and extensions. The accessor "getSelectionBehavior" gives direct access to the value

hasSelectionBehaviorElement

public boolean hasSelectionBehaviorElement()

hasSelectionBehavior

public boolean hasSelectionBehavior()

setSelectionBehaviorElement

public PlanDefinition.PlanDefinitionActionComponent setSelectionBehaviorElement(Enumeration<PlanDefinition.ActionSelectionBehavior> value)

Parameters:

value - selectionBehavior (Defines the selection behavior for the action and its children.). This is the underlying object with id, value and extensions. The accessor "getSelectionBehavior" gives direct access to the value

getSelectionBehavior

public PlanDefinition.ActionSelectionBehavior getSelectionBehavior()

Returns:

Defines the selection behavior for the action and its children.

setSelectionBehavior

public PlanDefinition.PlanDefinitionActionComponent setSelectionBehavior(PlanDefinition.ActionSelectionBehavior value)

Parameters:

value - Defines the selection behavior for the action and its children.

getRequiredBehaviorElement

public Enumeration<PlanDefinition.ActionRequiredBehavior> getRequiredBehaviorElement()

Returns:

requiredBehavior (Defines the requiredness behavior for the action.). This is the underlying object with id, value and extensions. The accessor "getRequiredBehavior" gives direct access to the value

hasRequiredBehaviorElement

public boolean hasRequiredBehaviorElement()

hasRequiredBehavior

public boolean hasRequiredBehavior()

setRequiredBehaviorElement

public PlanDefinition.PlanDefinitionActionComponent setRequiredBehaviorElement(Enumeration<PlanDefinition.ActionRequiredBehavior> value)

Parameters:

value - requiredBehavior (Defines the requiredness behavior for the action.). This is the underlying object with id, value and extensions. The accessor "getRequiredBehavior" gives direct access to the value

getRequiredBehavior

public PlanDefinition.ActionRequiredBehavior getRequiredBehavior()

Returns:

Defines the requiredness behavior for the action.

setRequiredBehavior

public PlanDefinition.PlanDefinitionActionComponent setRequiredBehavior(PlanDefinition.ActionRequiredBehavior value)

Parameters:

value - Defines the requiredness behavior for the action.

getPrecheckBehaviorElement

public Enumeration<PlanDefinition.ActionPrecheckBehavior> getPrecheckBehaviorElement()

Returns:

precheckBehavior (Defines whether the action should usually be preselected.). This is the underlying object with id, value and extensions. The accessor "getPrecheckBehavior" gives direct access to the value

hasPrecheckBehaviorElement

public boolean hasPrecheckBehaviorElement()

hasPrecheckBehavior

public boolean hasPrecheckBehavior()

setPrecheckBehaviorElement

public PlanDefinition.PlanDefinitionActionComponent setPrecheckBehaviorElement(Enumeration<PlanDefinition.ActionPrecheckBehavior> value)

Parameters:

value - precheckBehavior (Defines whether the action should usually be preselected.). This is the underlying object with id, value and extensions. The accessor "getPrecheckBehavior" gives direct access to the value

getPrecheckBehavior

public PlanDefinition.ActionPrecheckBehavior getPrecheckBehavior()

Returns:

Defines whether the action should usually be preselected.

setPrecheckBehavior

public PlanDefinition.PlanDefinitionActionComponent setPrecheckBehavior(PlanDefinition.ActionPrecheckBehavior value)

Parameters:

value - Defines whether the action should usually be preselected.

getCardinalityBehaviorElement

public Enumeration<PlanDefinition.ActionCardinalityBehavior> getCardinalityBehaviorElement()

Returns:

cardinalityBehavior (Defines whether the action can be selected multiple times.). This is the underlying object with id, value and extensions. The accessor "getCardinalityBehavior" gives direct access to the value

hasCardinalityBehaviorElement

public boolean hasCardinalityBehaviorElement()

hasCardinalityBehavior

public boolean hasCardinalityBehavior()

setCardinalityBehaviorElement

public PlanDefinition.PlanDefinitionActionComponent setCardinalityBehaviorElement(Enumeration<PlanDefinition.ActionCardinalityBehavior> value)

Parameters:

value - cardinalityBehavior (Defines whether the action can be selected multiple times.). This is the underlying object with id, value and extensions. The accessor "getCardinalityBehavior" gives direct access to the value

getCardinalityBehavior

public PlanDefinition.ActionCardinalityBehavior getCardinalityBehavior()

Returns:

Defines whether the action can be selected multiple times.

setCardinalityBehavior

public PlanDefinition.PlanDefinitionActionComponent setCardinalityBehavior(PlanDefinition.ActionCardinalityBehavior value)

Parameters:

value - Defines whether the action can be selected multiple times.

getDefinition

public Reference getDefinition()

Returns:

definition (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.)

hasDefinition

public boolean hasDefinition()

setDefinition

public PlanDefinition.PlanDefinitionActionComponent setDefinition(Reference value)

Parameters:

value - definition (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.)

getDefinitionTarget

public Resource getDefinitionTarget()

Returns:

definition The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)

setDefinitionTarget

public PlanDefinition.PlanDefinitionActionComponent setDefinitionTarget(Resource value)

Parameters:

value - definition The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)

getTransform

public Reference getTransform()

Returns:

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.)

hasTransform

public boolean hasTransform()

setTransform

public PlanDefinition.PlanDefinitionActionComponent setTransform(Reference value)

Parameters:

value - 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.)

getTransformTarget

public StructureMap getTransformTarget()

Returns:

transform The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)

setTransformTarget

public PlanDefinition.PlanDefinitionActionComponent setTransformTarget(StructureMap value)

Parameters:

value - transform The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)

getDynamicValue

public List<PlanDefinition.PlanDefinitionActionDynamicValueComponent> getDynamicValue()

Returns:

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.)

setDynamicValue

public PlanDefinition.PlanDefinitionActionComponent setDynamicValue(List<PlanDefinition.PlanDefinitionActionDynamicValueComponent> theDynamicValue)

Returns:

Returns a reference to this for easy method chaining

hasDynamicValue

public boolean hasDynamicValue()

addDynamicValue

public PlanDefinition.PlanDefinitionActionDynamicValueComponent addDynamicValue()

addDynamicValue

public PlanDefinition.PlanDefinitionActionComponent addDynamicValue(PlanDefinition.PlanDefinitionActionDynamicValueComponent t)

getDynamicValueFirstRep

public PlanDefinition.PlanDefinitionActionDynamicValueComponent getDynamicValueFirstRep()

Returns:

The first repetition of repeating field dynamicValue, creating it if it does not already exist

getAction

public List<PlanDefinition.PlanDefinitionActionComponent> getAction()

Returns:

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.)

setAction

public PlanDefinition.PlanDefinitionActionComponent setAction(List<PlanDefinition.PlanDefinitionActionComponent> theAction)

Returns:

Returns a reference to this for easy method chaining

hasAction

public boolean hasAction()

addAction

public PlanDefinition.PlanDefinitionActionComponent addAction()

addAction

public PlanDefinition.PlanDefinitionActionComponent addAction(PlanDefinition.PlanDefinitionActionComponent t)

getActionFirstRep

public PlanDefinition.PlanDefinitionActionComponent getActionFirstRep()

Returns:

The first repetition of repeating field action, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public PlanDefinition.PlanDefinitionActionComponent copy()

Specified by:

copy in class BackboneElement

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement