Package org.linuxforhealth.fhir.model.resource

Class Goal.Builder

    • Method Detail

      • id

        public Goal.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public Goal.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public Goal.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • language

        public Goal.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public Goal.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public Goal.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public Goal.Builder contained​(java.util.Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        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:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public Goal.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. 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 DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public Goal.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. 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 DomainResource.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 Goal.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Goal.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • identifier

        public Goal.Builder identifier​(Identifier... identifier)
        Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

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

        Parameters:
        identifier - External Ids for this goal
        Returns:
        A reference to this Builder instance

      • identifier

        public Goal.Builder identifier​(java.util.Collection<Identifier> identifier)
        Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

        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:
        identifier - External Ids for this goal
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • lifecycleStatus

        public Goal.Builder lifecycleStatus​(GoalLifecycleStatus lifecycleStatus)
        The state of the goal throughout its lifecycle.

        This element is required.

        Parameters:
        lifecycleStatus - proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
        Returns:
        A reference to this Builder instance

      • achievementStatus

        public Goal.Builder achievementStatus​(CodeableConcept achievementStatus)
        Describes the progression, or lack thereof, towards the goal against the target.
        Parameters:
        achievementStatus - in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
        Returns:
        A reference to this Builder instance

      • category

        public Goal.Builder category​(CodeableConcept... category)
        Indicates a category the goal falls within.

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

        Parameters:
        category - E.g. Treatment, dietary, behavioral, etc.
        Returns:
        A reference to this Builder instance

      • category

        public Goal.Builder category​(java.util.Collection<CodeableConcept> category)
        Indicates a category the goal falls within.

        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:
        category - E.g. Treatment, dietary, behavioral, etc.
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • priority

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

      • description

        public 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 goal
        Returns:
        A reference to this Builder instance

      • subject

        public Goal.Builder subject​(Reference subject)
        Identifies the patient, group or organization for whom the goal is being established.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        subject - Who this goal is intended for
        Returns:
        A reference to this Builder instance

      • start

        public Goal.Builder start​(java.time.LocalDate start)
        Convenience method for setting start with choice type Date.
        Parameters:
        start - When goal pursuit begins
        Returns:
        A reference to this Builder instance
        See Also:
        start(Element)

      • start

        public Goal.Builder start​(Element start)
        The date or event after which the goal should begin being pursued.

        This is a choice element with the following allowed types:

        Parameters:
        start - When goal pursuit begins
        Returns:
        A reference to this Builder instance

      • target

        public Goal.Builder target​(Goal.Target... target)
        Indicates what should be done by when.

        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 Goal.Builder target​(java.util.Collection<Goal.Target> target)
        Indicates what should be done by when.

        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:
        java.lang.NullPointerException - If the passed collection is null

      • statusDate

        public Goal.Builder statusDate​(Date statusDate)
        Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
        Parameters:
        statusDate - When goal status took effect
        Returns:
        A reference to this Builder instance

      • statusReason

        public Goal.Builder statusReason​(String statusReason)
        Captures the reason for the current status.
        Parameters:
        statusReason - Reason for current status
        Returns:
        A reference to this Builder instance

      • expressedBy

        public Goal.Builder expressedBy​(Reference expressedBy)
        Indicates whose goal this is - patient goal, practitioner goal, etc.

        Allowed resource types for this reference:

        Parameters:
        expressedBy - Who's responsible for creating Goal?
        Returns:
        A reference to this Builder instance

      • addresses

        public Goal.Builder addresses​(java.util.Collection<Reference> addresses)
        The identified conditions and other health record elements that are intended to be addressed by the goal.

        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:
        addresses - Issues addressed by this goal
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • note

        public Goal.Builder note​(Annotation... note)
        Any comments related to the goal.

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

        Parameters:
        note - Comments about the goal
        Returns:
        A reference to this Builder instance

      • note

        public Goal.Builder note​(java.util.Collection<Annotation> note)
        Any comments related to the goal.

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

      • outcomeCode

        public Goal.Builder outcomeCode​(CodeableConcept... outcomeCode)
        Identifies the change (or lack of change) at the point when the status of the goal is assessed.

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

        Parameters:
        outcomeCode - What result was achieved regarding the goal?
        Returns:
        A reference to this Builder instance

      • outcomeCode

        public Goal.Builder outcomeCode​(java.util.Collection<CodeableConcept> outcomeCode)
        Identifies the change (or lack of change) at the point when the status of the goal is assessed.

        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:
        outcomeCode - What result was achieved regarding the goal?
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • outcomeReference

        public Goal.Builder outcomeReference​(Reference... outcomeReference)
        Details of what's changed (or not changed).

        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:
        outcomeReference - Observation that resulted from goal
        Returns:
        A reference to this Builder instance

      • outcomeReference

        public Goal.Builder outcomeReference​(java.util.Collection<Reference> outcomeReference)
        Details of what's changed (or not changed).

        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:
        outcomeReference - Observation that resulted from goal
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • build

        public Goal build()
        Build the Goal

        Required elements:

        • lifecycleStatus
        • description
        • subject
        Specified by:
        build in interface Builder<Resource>
        Specified by:
        build in class DomainResource.Builder
        Returns:
        An immutable object of type Goal
        Throws:
        java.lang.IllegalStateException - if the current state cannot be built into a valid Goal per the base specification

      • validate

        protected void validate​(Goal goal)