Package com.ibm.fhir.model.resource
Class RequestGroup.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.RequestGroup.Action
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- RequestGroup
public static class RequestGroup.Action extends BackboneElement
The actions, if any, produced by the evaluation of the artifact.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRequestGroup.Action.Builderstatic classRequestGroup.Action.ConditionAn expression that describes applicability criteria, or start/stop conditions for the action.static classRequestGroup.Action.RelatedActionA 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 voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static RequestGroup.Action.Builderbuilder()booleanequals(Object obj)List<RequestGroup.Action>getAction()Sub actions.ActionCardinalityBehaviorgetCardinalityBehavior()Defines whether the action can be selected multiple times.List<CodeableConcept>getCode()A code that provides meaning for the action or action group.List<RequestGroup.Action.Condition>getCondition()An expression that describes applicability criteria, or start/stop conditions for the action.StringgetDescription()A short 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.ActionGroupingBehaviorgetGroupingBehavior()Defines the grouping behavior for the action and its children.List<Reference>getParticipant()The participant that should perform or be responsible for this action.ActionPrecheckBehaviorgetPrecheckBehavior()Defines whether the action should usually be preselected.StringgetPrefix()A user-visible prefix for the action.RequestPrioritygetPriority()Indicates how quickly the action should be addressed with respect to other actions.List<RequestGroup.Action.RelatedAction>getRelatedAction()A relationship to another action such as "before" or "30-60 minutes after start of".ActionRequiredBehaviorgetRequiredBehavior()Defines expectations around whether an action is required.ReferencegetResource()The resource that is the target of the action (e.g.ActionSelectionBehaviorgetSelectionBehavior()Defines the selection behavior for the action and its children.StringgetTextEquivalent()A text equivalent of the action to be performed.ElementgetTiming()An optional value describing when the action should be performed.StringgetTitle()The title of the action displayed to a user.CodeableConceptgetType()The type of action to perform (create, update, remove).booleanhasChildren()inthashCode()RequestGroup.Action.BuildertoBuilder()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
Stringthat may be null.
-
getTitle
public String getTitle()
The title of the action displayed to a user.- Returns:
- An immutable object of type
Stringthat may be null.
-
getDescription
public String getDescription()
A short description of the action used to provide a summary to display to the user.- Returns:
- An immutable object of type
Stringthat 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
Stringthat 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
RequestPrioritythat 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 a section of a documentation template.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat 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
RelatedArtifactthat may be empty.
-
getCondition
public List<RequestGroup.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
RequestGroup.Action.Conditionthat may be empty.
-
getRelatedAction
public List<RequestGroup.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
RequestGroup.Action.RelatedActionthat may be empty.
-
getTiming
public Element getTiming()
An optional value describing when the action should be performed.
-
getParticipant
public List<Reference> getParticipant()
The participant that should perform or be responsible for this action.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getType
public CodeableConcept getType()
The type of action to perform (create, update, remove).- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getGroupingBehavior
public ActionGroupingBehavior getGroupingBehavior()
Defines the grouping behavior for the action and its children.- Returns:
- An immutable object of type
ActionGroupingBehaviorthat may be null.
-
getSelectionBehavior
public ActionSelectionBehavior getSelectionBehavior()
Defines the selection behavior for the action and its children.- Returns:
- An immutable object of type
ActionSelectionBehaviorthat may be null.
-
getRequiredBehavior
public ActionRequiredBehavior getRequiredBehavior()
Defines expectations around whether an action is required.- Returns:
- An immutable object of type
ActionRequiredBehaviorthat may be null.
-
getPrecheckBehavior
public ActionPrecheckBehavior getPrecheckBehavior()
Defines whether the action should usually be preselected.- Returns:
- An immutable object of type
ActionPrecheckBehaviorthat may be null.
-
getCardinalityBehavior
public ActionCardinalityBehavior getCardinalityBehavior()
Defines whether the action can be selected multiple times.- Returns:
- An immutable object of type
ActionCardinalityBehaviorthat may be null.
-
getResource
public Reference getResource()
The resource that is the target of the action (e.g. CommunicationRequest).- Returns:
- An immutable object of type
Referencethat may be null.
-
getAction
public List<RequestGroup.Action> getAction()
Sub actions.- Returns:
- An unmodifiable list containing immutable objects of type
RequestGroup.Actionthat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept 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:
acceptin interfaceVisitable- Specified by:
acceptin 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 RequestGroup.Action.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static RequestGroup.Action.Builder builder()
-
-