Package com.ibm.fhir.model.resource
Class PlanDefinition.Action
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.type.Element
-
- com.ibm.fhir.model.type.BackboneElement
-
- com.ibm.fhir.model.resource.PlanDefinition.Action
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- PlanDefinition
public static class PlanDefinition.Action extends BackboneElement
An action or group of actions to be taken as part of the plan.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PlanDefinition.Action.Builder
static class
PlanDefinition.Action.Condition
An expression that describes applicability criteria or start/stop conditions for the action.static class
PlanDefinition.Action.DynamicValue
Customizations that should be applied to the statically defined resource.static class
PlanDefinition.Action.Participant
Indicates who should participate in performing the action described.static class
PlanDefinition.Action.RelatedAction
A relationship to another action such as "before" or "30-60 minutes after start of".
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static PlanDefinition.Action.Builder
builder()
boolean
equals(Object obj)
List<PlanDefinition.Action>
getAction()
Sub actions that are contained within the action.ActionCardinalityBehavior
getCardinalityBehavior()
Defines whether the action can be selected multiple times.List<CodeableConcept>
getCode()
A code that provides meaning for the action or action group.List<PlanDefinition.Action.Condition>
getCondition()
An expression that describes applicability criteria or start/stop conditions for the action.Element
getDefinition()
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.String
getDescription()
A brief description of the action used to provide a summary to display to the user.List<RelatedArtifact>
getDocumentation()
Didactic or other informational resources associated with the action that can be provided to the CDS recipient.List<PlanDefinition.Action.DynamicValue>
getDynamicValue()
Customizations that should be applied to the statically defined resource.List<Id>
getGoalId()
Identifies goals that this action supports.ActionGroupingBehavior
getGroupingBehavior()
Defines the grouping behavior for the action and its children.List<DataRequirement>
getInput()
Defines input data requirements for the action.List<DataRequirement>
getOutput()
Defines the outputs of the action, if any.List<PlanDefinition.Action.Participant>
getParticipant()
Indicates who should participate in performing the action described.ActionPrecheckBehavior
getPrecheckBehavior()
Defines whether the action should usually be preselected.String
getPrefix()
A user-visible prefix for the action.RequestPriority
getPriority()
Indicates how quickly the action should be addressed with respect to other actions.List<CodeableConcept>
getReason()
A description of why this action is necessary or appropriate.List<PlanDefinition.Action.RelatedAction>
getRelatedAction()
A relationship to another action such as "before" or "30-60 minutes after start of".ActionRequiredBehavior
getRequiredBehavior()
Defines the required behavior for the action.ActionSelectionBehavior
getSelectionBehavior()
Defines the selection behavior for the action and its children.Element
getSubject()
A code or group definition that describes the intended subject of the action and its children, if any.String
getTextEquivalent()
A text equivalent of the action to be performed.Element
getTiming()
An optional value describing when the action should be performed.String
getTitle()
The title of the action displayed to a user.Canonical
getTransform()
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.List<TriggerDefinition>
getTrigger()
A description of when the action should be triggered.CodeableConcept
getType()
The type of action to perform (create, update, remove).boolean
hasChildren()
int
hashCode()
PlanDefinition.Action.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement
getModifierExtension
-
-
-
-
Method Detail
-
getPrefix
public String getPrefix()
A user-visible prefix for the action.- Returns:
- An immutable object of type
String
that may be null.
-
getTitle
public String getTitle()
The title of the action displayed to a user.- Returns:
- An immutable object of type
String
that may be null.
-
getDescription
public String getDescription()
A brief description of the action used to provide a summary to display to the user.- Returns:
- An immutable object of type
String
that may be null.
-
getTextEquivalent
public String getTextEquivalent()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getPriority
public RequestPriority getPriority()
Indicates how quickly the action should be addressed with respect to other actions.- Returns:
- An immutable object of type
RequestPriority
that may be null.
-
getCode
public List<CodeableConcept> getCode()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getReason
public List<CodeableConcept> getReason()
A description of why this action is necessary or appropriate.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getDocumentation
public List<RelatedArtifact> getDocumentation()
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.- Returns:
- An unmodifiable list containing immutable objects of type
RelatedArtifact
that may be empty.
-
getGoalId
public List<Id> getGoalId()
Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.- Returns:
- An unmodifiable list containing immutable objects of type
Id
that may be empty.
-
getSubject
public Element getSubject()
A code or group definition that describes the intended subject of the action and its children, if any.- Returns:
- An immutable object of type
CodeableConcept
orReference
that may be null.
-
getTrigger
public List<TriggerDefinition> getTrigger()
A description of when the action should be triggered.- Returns:
- An unmodifiable list containing immutable objects of type
TriggerDefinition
that may be empty.
-
getCondition
public List<PlanDefinition.Action.Condition> getCondition()
An expression that describes applicability criteria or start/stop conditions for the action.- Returns:
- An unmodifiable list containing immutable objects of type
PlanDefinition.Action.Condition
that may be empty.
-
getInput
public List<DataRequirement> getInput()
Defines input data requirements for the action.- Returns:
- An unmodifiable list containing immutable objects of type
DataRequirement
that may be empty.
-
getOutput
public List<DataRequirement> getOutput()
Defines the outputs of the action, if any.- Returns:
- An unmodifiable list containing immutable objects of type
DataRequirement
that may be empty.
-
getRelatedAction
public List<PlanDefinition.Action.RelatedAction> getRelatedAction()
A relationship to another action such as "before" or "30-60 minutes after start of".- Returns:
- An unmodifiable list containing immutable objects of type
PlanDefinition.Action.RelatedAction
that may be empty.
-
getTiming
public Element getTiming()
An optional value describing when the action should be performed.
-
getParticipant
public List<PlanDefinition.Action.Participant> getParticipant()
Indicates who should participate in performing the action described.- Returns:
- An unmodifiable list containing immutable objects of type
PlanDefinition.Action.Participant
that may be empty.
-
getType
public CodeableConcept getType()
The type of action to perform (create, update, remove).- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getGroupingBehavior
public ActionGroupingBehavior getGroupingBehavior()
Defines the grouping behavior for the action and its children.- Returns:
- An immutable object of type
ActionGroupingBehavior
that may be null.
-
getSelectionBehavior
public ActionSelectionBehavior getSelectionBehavior()
Defines the selection behavior for the action and its children.- Returns:
- An immutable object of type
ActionSelectionBehavior
that may be null.
-
getRequiredBehavior
public ActionRequiredBehavior getRequiredBehavior()
Defines the required behavior for the action.- Returns:
- An immutable object of type
ActionRequiredBehavior
that may be null.
-
getPrecheckBehavior
public ActionPrecheckBehavior getPrecheckBehavior()
Defines whether the action should usually be preselected.- Returns:
- An immutable object of type
ActionPrecheckBehavior
that may be null.
-
getCardinalityBehavior
public ActionCardinalityBehavior getCardinalityBehavior()
Defines whether the action can be selected multiple times.- Returns:
- An immutable object of type
ActionCardinalityBehavior
that may be null.
-
getDefinition
public Element getDefinition()
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 Canonical getTransform()
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.- Returns:
- An immutable object of type
Canonical
that may be null.
-
getDynamicValue
public List<PlanDefinition.Action.DynamicValue> getDynamicValue()
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.- Returns:
- An unmodifiable list containing immutable objects of type
PlanDefinition.Action.DynamicValue
that may be empty.
-
getAction
public List<PlanDefinition.Action> getAction()
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.- Returns:
- An unmodifiable list containing immutable objects of type
PlanDefinition.Action
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
toBuilder
public PlanDefinition.Action.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static PlanDefinition.Action.Builder builder()
-
-