Class RequestGroup.Action
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.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 class
RequestGroup.Action.Builder
static class
RequestGroup.Action.Condition
An expression that describes applicability criteria, or start/stop conditions for the action.static class
RequestGroup.Action.RelatedAction
A relationship to another action such as "before" or "30-60 minutes after start of".
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static RequestGroup.Action.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<RequestGroup.Action>
getAction()
Sub actions.ActionCardinalityBehavior
getCardinalityBehavior()
Defines whether the action can be selected multiple times.java.util.List<CodeableConcept>
getCode()
A code that provides meaning for the action or action group.java.util.List<RequestGroup.Action.Condition>
getCondition()
An expression that describes applicability criteria, or start/stop conditions for the action.String
getDescription()
A short description of the action used to provide a summary to display to the user.java.util.List<RelatedArtifact>
getDocumentation()
Didactic or other informational resources associated with the action that can be provided to the CDS recipient.ActionGroupingBehavior
getGroupingBehavior()
Defines the grouping behavior for the action and its children.java.util.List<Reference>
getParticipant()
The participant that should perform or be responsible for this action.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.java.util.List<RequestGroup.Action.RelatedAction>
getRelatedAction()
A relationship to another action such as "before" or "30-60 minutes after start of".ActionRequiredBehavior
getRequiredBehavior()
Defines expectations around whether an action is required.Reference
getResource()
The resource that is the target of the action (e.g.ActionSelectionBehavior
getSelectionBehavior()
Defines the selection behavior for the action and its children.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.CodeableConcept
getType()
The type of action to perform (create, update, remove).boolean
hasChildren()
int
hashCode()
RequestGroup.Action.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
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 short 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 java.util.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
CodeableConcept
that may be empty.
-
getDocumentation
public java.util.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.
-
getCondition
public java.util.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.Condition
that may be empty.
-
getRelatedAction
public java.util.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.RelatedAction
that may be empty.
-
getTiming
public Element getTiming()
An optional value describing when the action should be performed.
-
getParticipant
public java.util.List<Reference> getParticipant()
The participant that should perform or be responsible for this action.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
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 expectations around whether an action is required.- 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.
-
getResource
public Reference getResource()
The resource that is the target of the action (e.g. CommunicationRequest).- Returns:
- An immutable object of type
Reference
that may be null.
-
getAction
public java.util.List<RequestGroup.Action> getAction()
Sub actions.- Returns:
- An unmodifiable list containing immutable objects of type
RequestGroup.Action
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.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
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public RequestGroup.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 RequestGroup.Action.Builder builder()
-
-