Package com.ibm.fhir.model.resource

Class Goal

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Goal
extends DomainResource
    Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getLifecycleStatus

        public GoalLifecycleStatus getLifecycleStatus()
        The state of the goal throughout its lifecycle.
        Returns:
        An immutable object of type GoalLifecycleStatus that is non-null.

      • getAchievementStatus

        public CodeableConcept getAchievementStatus()
        Describes the progression, or lack thereof, towards the goal against the target.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getCategory

        public java.util.List<CodeableConcept> getCategory()
        Indicates a category the goal falls within.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPriority

        public CodeableConcept getPriority()
        Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getDescription

        public CodeableConcept getDescription()
        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".
        Returns:
        An immutable object of type CodeableConcept that is non-null.

      • getSubject

        public Reference getSubject()
        Identifies the patient, group or organization for whom the goal is being established.
        Returns:
        An immutable object of type Reference that is non-null.

      • getStart

        public Element getStart()
        The date or event after which the goal should begin being pursued.
        Returns:
        An immutable object of type Date or CodeableConcept that may be null.

      • getTarget

        public java.util.List<Goal.Target> getTarget()
        Indicates what should be done by when.
        Returns:
        An unmodifiable list containing immutable objects of type Goal.Target that may be empty.

      • getStatusDate

        public Date getStatusDate()
        Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
        Returns:
        An immutable object of type Date that may be null.

      • getStatusReason

        public String getStatusReason()
        Captures the reason for the current status.
        Returns:
        An immutable object of type String that may be null.

      • getExpressedBy

        public Reference getExpressedBy()
        Indicates whose goal this is - patient goal, practitioner goal, etc.
        Returns:
        An immutable object of type Reference that may be null.

      • getAddresses

        public java.util.List<Reference> getAddresses()
        The identified conditions and other health record elements that are intended to be addressed by the goal.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getNote

        public java.util.List<Annotation> getNote()
        Any comments related to the goal.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • getOutcomeCode

        public java.util.List<CodeableConcept> getOutcomeCode()
        Identifies the change (or lack of change) at the point when the status of the goal is assessed.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getOutcomeReference

        public java.util.List<Reference> getOutcomeReference()
        Details of what's changed (or not changed).
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • 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 interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object