Package com.ibm.fhir.model.resource

Class PlanDefinition.Action.Builder

    • Method Detail

      • id

        public PlanDefinition.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 class BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public PlanDefinition.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 class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public PlanDefinition.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 class BackboneElement.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 PlanDefinition.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 class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public PlanDefinition.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 class BackboneElement.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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.Action.Builder description​(String description)
        A brief description of the action used to provide a summary to display to the user.
        Parameters:
        description - Brief description of the action
        Returns:
        A reference to this Builder instance

      • textEquivalent

        public PlanDefinition.Action.Builder textEquivalent​(java.lang.String textEquivalent)
        Convenience method for setting textEquivalent.
        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(com.ibm.fhir.model.type.String)

      • textEquivalent

        public PlanDefinition.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 PlanDefinition.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 PlanDefinition.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 the 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 PlanDefinition.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 the 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

      • reason

        public PlanDefinition.Action.Builder reason​(CodeableConcept... reason)
        A description of why this action is necessary or appropriate.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        reason - Why the action should be performed
        Returns:
        A reference to this Builder instance

      • reason

        public PlanDefinition.Action.Builder reason​(java.util.Collection<CodeableConcept> reason)
        A description of why this action is necessary or appropriate.

        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:
        reason - Why the action should be performed
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • documentation

        public PlanDefinition.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 PlanDefinition.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

      • goalId

        public PlanDefinition.Action.Builder goalId​(Id... goalId)
        Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        goalId - What goals this action supports
        Returns:
        A reference to this Builder instance

      • goalId

        public PlanDefinition.Action.Builder goalId​(java.util.Collection<Id> goalId)
        Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

        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:
        goalId - What goals this action supports
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • subject

        public PlanDefinition.Action.Builder subject​(Element subject)
        A code or group definition that describes the intended subject of the action and its children, if any.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        Parameters:
        subject - Type of individual the action is focused on
        Returns:
        A reference to this Builder instance

      • trigger

        public PlanDefinition.Action.Builder trigger​(TriggerDefinition... trigger)
        A description of when the action should be triggered.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        trigger - When the action should be triggered
        Returns:
        A reference to this Builder instance

      • trigger

        public PlanDefinition.Action.Builder trigger​(java.util.Collection<TriggerDefinition> trigger)
        A description of when the action should be triggered.

        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:
        trigger - When the action should be triggered
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • condition

        public PlanDefinition.Action.Builder condition​(PlanDefinition.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 PlanDefinition.Action.Builder condition​(java.util.Collection<PlanDefinition.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

      • input

        public PlanDefinition.Action.Builder input​(DataRequirement... input)
        Defines input data requirements for the action.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        input - Input data requirements
        Returns:
        A reference to this Builder instance

      • input

        public PlanDefinition.Action.Builder input​(java.util.Collection<DataRequirement> input)
        Defines input data requirements 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:
        input - Input data requirements
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • output

        public PlanDefinition.Action.Builder output​(DataRequirement... output)
        Defines the outputs of the action, if any.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        output - Output data definition
        Returns:
        A reference to this Builder instance

      • output

        public PlanDefinition.Action.Builder output​(java.util.Collection<DataRequirement> output)
        Defines the outputs of the action, if any.

        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:
        output - Output data definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • relatedAction

        public PlanDefinition.Action.Builder relatedAction​(PlanDefinition.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 PlanDefinition.Action.Builder relatedAction​(java.util.Collection<PlanDefinition.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

      • participant

        public PlanDefinition.Action.Builder participant​(PlanDefinition.Action.Participant... participant)
        Indicates who should participate in performing the action described.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        participant - Who should participate in the action
        Returns:
        A reference to this Builder instance

      • participant

        public PlanDefinition.Action.Builder participant​(java.util.Collection<PlanDefinition.Action.Participant> participant)
        Indicates who should participate in performing the action described.

        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:
        participant - Who should participate in the action
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • type

        public PlanDefinition.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 PlanDefinition.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 PlanDefinition.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 PlanDefinition.Action.Builder requiredBehavior​(ActionRequiredBehavior requiredBehavior)
        Defines the required behavior for the action.
        Parameters:
        requiredBehavior - must | could | must-unless-documented
        Returns:
        A reference to this Builder instance

      • precheckBehavior

        public PlanDefinition.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 PlanDefinition.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

      • definition

        public PlanDefinition.Action.Builder definition​(Element 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.

        This is a choice element with the following allowed types:

        Parameters:
        definition - Description of the activity to be performed
        Returns:
        A reference to this Builder instance

      • transform

        public PlanDefinition.Action.Builder transform​(Canonical 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.
        Parameters:
        transform - Transform to apply the template
        Returns:
        A reference to this Builder instance

      • dynamicValue

        public PlanDefinition.Action.Builder dynamicValue​(PlanDefinition.Action.DynamicValue... 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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        dynamicValue - Dynamic aspects of the definition
        Returns:
        A reference to this Builder instance

      • dynamicValue

        public PlanDefinition.Action.Builder dynamicValue​(java.util.Collection<PlanDefinition.Action.DynamicValue> 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.

        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:
        dynamicValue - Dynamic aspects of the definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • action

        public PlanDefinition.Action.Builder action​(PlanDefinition.Action... 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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        action - A sub-action
        Returns:
        A reference to this Builder instance

      • action

        public PlanDefinition.Action.Builder action​(java.util.Collection<PlanDefinition.Action> 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.

        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 - A sub-action
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null