Package com.ibm.fhir.model.resource

Class PlanDefinition.Goal.Builder

    • Method Detail

      • id

        public PlanDefinition.Goal.Builder id​(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.Goal.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.Goal.Builder extension​(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:
        NullPointerException - If the passed collection is null

      • modifierExtension

        public PlanDefinition.Goal.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.Goal.Builder modifierExtension​(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:
        NullPointerException - If the passed collection is null

      • category

        public PlanDefinition.Goal.Builder category​(CodeableConcept category)
        Indicates a category the goal falls within.
        Parameters:
        category - E.g. Treatment, dietary, behavioral
        Returns:
        A reference to this Builder instance

      • description

        public PlanDefinition.Goal.Builder description​(CodeableConcept description)
        Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".

        This element is required.

        Parameters:
        description - Code or text describing the goal
        Returns:
        A reference to this Builder instance

      • priority

        public PlanDefinition.Goal.Builder priority​(CodeableConcept priority)
        Identifies the expected level of importance associated with reaching/sustaining the defined goal.
        Parameters:
        priority - high-priority | medium-priority | low-priority
        Returns:
        A reference to this Builder instance

      • start

        public PlanDefinition.Goal.Builder start​(CodeableConcept start)
        The event after which the goal should begin being pursued.
        Parameters:
        start - When goal pursuit begins
        Returns:
        A reference to this Builder instance

      • addresses

        public PlanDefinition.Goal.Builder addresses​(CodeableConcept... addresses)
        Identifies problems, conditions, issues, or concerns the goal is intended to address.

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

        Parameters:
        addresses - What does the goal address
        Returns:
        A reference to this Builder instance

      • addresses

        public PlanDefinition.Goal.Builder addresses​(Collection<CodeableConcept> addresses)
        Identifies problems, conditions, issues, or concerns the goal is intended to address.

        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:
        addresses - What does the goal address
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • documentation

        public PlanDefinition.Goal.Builder documentation​(RelatedArtifact... documentation)
        Didactic or other informational resources associated with the goal that provide further supporting information about the goal. 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 goal
        Returns:
        A reference to this Builder instance

      • documentation

        public PlanDefinition.Goal.Builder documentation​(Collection<RelatedArtifact> documentation)
        Didactic or other informational resources associated with the goal that provide further supporting information about the goal. 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 goal
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • target

        public PlanDefinition.Goal.Builder target​(PlanDefinition.Goal.Target... target)
        Indicates what should be done and within what timeframe.

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

        Parameters:
        target - Target outcome for the goal
        Returns:
        A reference to this Builder instance

      • target

        public PlanDefinition.Goal.Builder target​(Collection<PlanDefinition.Goal.Target> target)
        Indicates what should be done and within what timeframe.

        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:
        target - Target outcome for the goal
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null