Class RequestGroup.Action.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.RequestGroup.Action.Builder
-
- Enclosing class:
- RequestGroup.Action
public static class RequestGroup.Action.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RequestGroup.Action.Builder
action(java.util.Collection<RequestGroup.Action> action)
Sub actions.RequestGroup.Action.Builder
action(RequestGroup.Action... action)
Sub actions.RequestGroup.Action
build()
Build theRequestGroup.Action
RequestGroup.Action.Builder
cardinalityBehavior(ActionCardinalityBehavior cardinalityBehavior)
Defines whether the action can be selected multiple times.RequestGroup.Action.Builder
code(java.util.Collection<CodeableConcept> code)
A code that provides meaning for the action or action group.RequestGroup.Action.Builder
code(CodeableConcept... code)
A code that provides meaning for the action or action group.RequestGroup.Action.Builder
condition(java.util.Collection<RequestGroup.Action.Condition> condition)
An expression that describes applicability criteria, or start/stop conditions for the action.RequestGroup.Action.Builder
condition(RequestGroup.Action.Condition... condition)
An expression that describes applicability criteria, or start/stop conditions for the action.RequestGroup.Action.Builder
description(java.lang.String description)
Convenience method for settingdescription
.RequestGroup.Action.Builder
description(String description)
A short description of the action used to provide a summary to display to the user.RequestGroup.Action.Builder
documentation(java.util.Collection<RelatedArtifact> documentation)
Didactic or other informational resources associated with the action that can be provided to the CDS recipient.RequestGroup.Action.Builder
documentation(RelatedArtifact... documentation)
Didactic or other informational resources associated with the action that can be provided to the CDS recipient.RequestGroup.Action.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.RequestGroup.Action.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected RequestGroup.Action.Builder
from(RequestGroup.Action action)
RequestGroup.Action.Builder
groupingBehavior(ActionGroupingBehavior groupingBehavior)
Defines the grouping behavior for the action and its children.RequestGroup.Action.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).RequestGroup.Action.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.RequestGroup.Action.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.RequestGroup.Action.Builder
participant(java.util.Collection<Reference> participant)
The participant that should perform or be responsible for this action.RequestGroup.Action.Builder
participant(Reference... participant)
The participant that should perform or be responsible for this action.RequestGroup.Action.Builder
precheckBehavior(ActionPrecheckBehavior precheckBehavior)
Defines whether the action should usually be preselected.RequestGroup.Action.Builder
prefix(java.lang.String prefix)
Convenience method for settingprefix
.RequestGroup.Action.Builder
prefix(String prefix)
A user-visible prefix for the action.RequestGroup.Action.Builder
priority(RequestPriority priority)
Indicates how quickly the action should be addressed with respect to other actions.RequestGroup.Action.Builder
relatedAction(java.util.Collection<RequestGroup.Action.RelatedAction> relatedAction)
A relationship to another action such as "before" or "30-60 minutes after start of".RequestGroup.Action.Builder
relatedAction(RequestGroup.Action.RelatedAction... relatedAction)
A relationship to another action such as "before" or "30-60 minutes after start of".RequestGroup.Action.Builder
requiredBehavior(ActionRequiredBehavior requiredBehavior)
Defines expectations around whether an action is required.RequestGroup.Action.Builder
resource(Reference resource)
The resource that is the target of the action (e.g.RequestGroup.Action.Builder
selectionBehavior(ActionSelectionBehavior selectionBehavior)
Defines the selection behavior for the action and its children.RequestGroup.Action.Builder
textEquivalent(java.lang.String textEquivalent)
Convenience method for settingtextEquivalent
.RequestGroup.Action.Builder
textEquivalent(String textEquivalent)
A text equivalent of the action to be performed.RequestGroup.Action.Builder
timing(Element timing)
An optional value describing when the action should be performed.RequestGroup.Action.Builder
title(java.lang.String title)
Convenience method for settingtitle
.RequestGroup.Action.Builder
title(String title)
The title of the action displayed to a user.RequestGroup.Action.Builder
type(CodeableConcept type)
The type of action to perform (create, update, remove).protected void
validate(RequestGroup.Action action)
-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public RequestGroup.Action.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public RequestGroup.Action.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public RequestGroup.Action.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public RequestGroup.Action.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public RequestGroup.Action.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
prefix
public RequestGroup.Action.Builder prefix(java.lang.String prefix)
Convenience method for settingprefix
.- Parameters:
prefix
- User-visible prefix for the action (e.g. 1. or A.)- Returns:
- A reference to this Builder instance
- See Also:
prefix(org.linuxforhealth.fhir.model.type.String)
-
prefix
public RequestGroup.Action.Builder prefix(String prefix)
A user-visible prefix for the action.- Parameters:
prefix
- User-visible prefix for the action (e.g. 1. or A.)- Returns:
- A reference to this Builder instance
-
title
public RequestGroup.Action.Builder title(java.lang.String title)
Convenience method for settingtitle
.- Parameters:
title
- User-visible title- Returns:
- A reference to this Builder instance
- See Also:
title(org.linuxforhealth.fhir.model.type.String)
-
title
public RequestGroup.Action.Builder title(String title)
The title of the action displayed to a user.- Parameters:
title
- User-visible title- Returns:
- A reference to this Builder instance
-
description
public RequestGroup.Action.Builder description(java.lang.String description)
Convenience method for settingdescription
.- Parameters:
description
- Short description of the action- Returns:
- A reference to this Builder instance
- See Also:
description(org.linuxforhealth.fhir.model.type.String)
-
description
public RequestGroup.Action.Builder description(String description)
A short description of the action used to provide a summary to display to the user.- Parameters:
description
- Short description of the action- Returns:
- A reference to this Builder instance
-
textEquivalent
public RequestGroup.Action.Builder textEquivalent(java.lang.String textEquivalent)
Convenience method for settingtextEquivalent
.- Parameters:
textEquivalent
- Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system- Returns:
- A reference to this Builder instance
- See Also:
textEquivalent(org.linuxforhealth.fhir.model.type.String)
-
textEquivalent
public RequestGroup.Action.Builder textEquivalent(String 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 might not be capable of interpreting it dynamically.- Parameters:
textEquivalent
- Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system- Returns:
- A reference to this Builder instance
-
priority
public RequestGroup.Action.Builder priority(RequestPriority priority)
Indicates how quickly the action should be addressed with respect to other actions.- Parameters:
priority
- routine | urgent | asap | stat- Returns:
- A reference to this Builder instance
-
code
public RequestGroup.Action.Builder code(CodeableConcept... code)
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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
code
- Code representing the meaning of the action or sub-actions- Returns:
- A reference to this Builder instance
-
code
public RequestGroup.Action.Builder code(java.util.Collection<CodeableConcept> code)
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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
code
- Code representing the meaning of the action or sub-actions- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
documentation
public RequestGroup.Action.Builder documentation(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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
documentation
- Supporting documentation for the intended performer of the action- Returns:
- A reference to this Builder instance
-
documentation
public RequestGroup.Action.Builder documentation(java.util.Collection<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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
documentation
- Supporting documentation for the intended performer of the action- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
condition
public RequestGroup.Action.Builder condition(RequestGroup.Action.Condition... condition)
An expression that describes applicability criteria, or start/stop conditions for the action.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
condition
- Whether or not the action is applicable- Returns:
- A reference to this Builder instance
-
condition
public RequestGroup.Action.Builder condition(java.util.Collection<RequestGroup.Action.Condition> condition)
An expression that describes applicability criteria, or start/stop conditions for the action.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
condition
- Whether or not the action is applicable- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
relatedAction
public RequestGroup.Action.Builder relatedAction(RequestGroup.Action.RelatedAction... relatedAction)
A relationship to another action such as "before" or "30-60 minutes after start of".Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
relatedAction
- Relationship to another action- Returns:
- A reference to this Builder instance
-
relatedAction
public RequestGroup.Action.Builder relatedAction(java.util.Collection<RequestGroup.Action.RelatedAction> relatedAction)
A relationship to another action such as "before" or "30-60 minutes after start of".Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
relatedAction
- Relationship to another action- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
timing
public RequestGroup.Action.Builder timing(Element timing)
An optional value describing when the action should be performed.This is a choice element with the following allowed types:
- Parameters:
timing
- When the action should take place- Returns:
- A reference to this Builder instance
-
participant
public RequestGroup.Action.Builder participant(Reference... participant)
The participant that should perform or be responsible for this action.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
participant
- Who should perform the action- Returns:
- A reference to this Builder instance
-
participant
public RequestGroup.Action.Builder participant(java.util.Collection<Reference> participant)
The participant that should perform or be responsible for this action.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
participant
- Who should perform the action- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
type
public RequestGroup.Action.Builder type(CodeableConcept type)
The type of action to perform (create, update, remove).- Parameters:
type
- create | update | remove | fire-event- Returns:
- A reference to this Builder instance
-
groupingBehavior
public RequestGroup.Action.Builder groupingBehavior(ActionGroupingBehavior groupingBehavior)
Defines the grouping behavior for the action and its children.- Parameters:
groupingBehavior
- visual-group | logical-group | sentence-group- Returns:
- A reference to this Builder instance
-
selectionBehavior
public RequestGroup.Action.Builder selectionBehavior(ActionSelectionBehavior selectionBehavior)
Defines the selection behavior for the action and its children.- Parameters:
selectionBehavior
- any | all | all-or-none | exactly-one | at-most-one | one-or-more- Returns:
- A reference to this Builder instance
-
requiredBehavior
public RequestGroup.Action.Builder requiredBehavior(ActionRequiredBehavior requiredBehavior)
Defines expectations around whether an action is required.- Parameters:
requiredBehavior
- must | could | must-unless-documented- Returns:
- A reference to this Builder instance
-
precheckBehavior
public RequestGroup.Action.Builder precheckBehavior(ActionPrecheckBehavior precheckBehavior)
Defines whether the action should usually be preselected.- Parameters:
precheckBehavior
- yes | no- Returns:
- A reference to this Builder instance
-
cardinalityBehavior
public RequestGroup.Action.Builder cardinalityBehavior(ActionCardinalityBehavior cardinalityBehavior)
Defines whether the action can be selected multiple times.- Parameters:
cardinalityBehavior
- single | multiple- Returns:
- A reference to this Builder instance
-
resource
public RequestGroup.Action.Builder resource(Reference resource)
The resource that is the target of the action (e.g. CommunicationRequest).- Parameters:
resource
- The target of the action- Returns:
- A reference to this Builder instance
-
action
public RequestGroup.Action.Builder action(RequestGroup.Action... action)
Sub actions.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
action
- Sub action- Returns:
- A reference to this Builder instance
-
action
public RequestGroup.Action.Builder action(java.util.Collection<RequestGroup.Action> action)
Sub actions.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
action
- Sub action- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public RequestGroup.Action build()
Build theRequestGroup.Action
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
RequestGroup.Action
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Action per the base specification
-
validate
protected void validate(RequestGroup.Action action)
-
from
protected RequestGroup.Action.Builder from(RequestGroup.Action action)
-
-