Class Goal

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class Goal
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Goal Resource (clinical.careprovision)

    Definition: 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.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/Goal

    See Also:
    Serialized Form
    • Field Detail

      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description:
        Type: reference
        Path: Goal.subject

      • SUBJECT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
        Fluent Client search parameter constant for subject

        Description:
        Type: reference
        Path: Goal.subject

      • CATEGORY

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
        Fluent Client search parameter constant for category

        Description:
        Type: token
        Path: Goal.category

      • TARGETDATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam TARGETDATE
        Fluent Client search parameter constant for targetdate

        Description:
        Type: date
        Path: Goal.targetDate

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description:
        Type: token
        Path: Goal.identifier

      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description:
        Type: token
        Path: Goal.status

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Goal:patient".
      • INCLUDE_SUBJECT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Goal:subject".
    • Constructor Detail

      • Goal

        public Goal()
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

      • setIdentifier

        public Goal setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier (id)

        Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

      • addIdentifier

        public Goal addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

      • getSubject

        public ResourceReferenceDt getSubject()
        Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.

        Definition: Identifies the patient, group or organization for whom the goal is being established.

      • setSubject

        public Goal setSubject​(ResourceReferenceDt theValue)
        Sets the value(s) for subject (who.focus)

        Definition: Identifies the patient, group or organization for whom the goal is being established.

      • getStart

        public ca.uhn.fhir.model.api.IDatatype getStart()
        Gets the value(s) for start[x] (). creating it if it does not exist. Will not return null.

        Definition: The date or event after which the goal should begin being pursued

      • setStart

        public Goal setStart​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for start[x] ()

        Definition: The date or event after which the goal should begin being pursued

      • getTarget

        public ca.uhn.fhir.model.api.IDatatype getTarget()
        Gets the value(s) for target[x] (). creating it if it does not exist. Will not return null.

        Definition: Indicates either the date or the duration after start by which the goal should be met

      • setTarget

        public Goal setTarget​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for target[x] ()

        Definition: Indicates either the date or the duration after start by which the goal should be met

      • getCategory

        public List<CodeableConceptDtgetCategory()
        Gets the value(s) for category (). creating it if it does not exist. Will not return null.

        Definition: Indicates a category the goal falls within

      • addCategory

        public CodeableConceptDt addCategory()
        Adds and returns a new value for category ()

        Definition: Indicates a category the goal falls within

      • addCategory

        public Goal addCategory​(CodeableConceptDt theValue)
        Adds a given new value for category ()

        Definition: Indicates a category the goal falls within

        Parameters:
        theValue - The category to add (must not be null)
      • getCategoryFirstRep

        public CodeableConceptDt getCategoryFirstRep()
        Gets the first repetition for category (), creating it if it does not already exist.

        Definition: Indicates a category the goal falls within

      • getDescriptionElement

        public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
        Gets the value(s) for description (). creating it if it does not exist. Will not return null.

        Definition: Human-readable description of a specific desired objective of care.

      • getDescription

        public String getDescription()
        Gets the value(s) for description (). creating it if it does not exist. This method may return null.

        Definition: Human-readable description of a specific desired objective of care.

      • setDescription

        public Goal setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

        Definition: Human-readable description of a specific desired objective of care.

      • setDescription

        public Goal setDescription​(String theString)
        Sets the value for description ()

        Definition: Human-readable description of a specific desired objective of care.

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<GoalStatusEnumgetStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: Indicates whether the goal has been reached and is still considered relevant

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: Indicates whether the goal has been reached and is still considered relevant

      • setStatus

        public Goal setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<GoalStatusEnum> theValue)
        Sets the value(s) for status (status)

        Definition: Indicates whether the goal has been reached and is still considered relevant

      • setStatus

        public Goal setStatus​(GoalStatusEnum theValue)
        Sets the value(s) for status (status)

        Definition: Indicates whether the goal has been reached and is still considered relevant

      • getStatusDateElement

        public ca.uhn.fhir.model.primitive.DateDt getStatusDateElement()
        Gets the value(s) for statusDate (when.recorded). creating it if it does not exist. Will not return null.

        Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

      • getStatusDate

        public Date getStatusDate()
        Gets the value(s) for statusDate (when.recorded). creating it if it does not exist. This method may return null.

        Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

      • setStatusDate

        public Goal setStatusDate​(ca.uhn.fhir.model.primitive.DateDt theValue)
        Sets the value(s) for statusDate (when.recorded)

        Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

      • setStatusDateWithDayPrecision

        public Goal setStatusDateWithDayPrecision​(Date theDate)
        Sets the value for statusDate (when.recorded)

        Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

      • setStatusDate

        public Goal setStatusDate​(Date theDate,
                                  ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for statusDate (when.recorded)

        Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

      • getStatusReason

        public CodeableConceptDt getStatusReason()
        Gets the value(s) for statusReason (). creating it if it does not exist. Will not return null.

        Definition: Captures the reason for the current status.

      • getAuthor

        public ResourceReferenceDt getAuthor()
        Gets the value(s) for author (who.actor). creating it if it does not exist. Will not return null.

        Definition: Indicates whose goal this is - patient goal, practitioner goal, etc.

      • setAuthor

        public Goal setAuthor​(ResourceReferenceDt theValue)
        Sets the value(s) for author (who.actor)

        Definition: Indicates whose goal this is - patient goal, practitioner goal, etc.

      • getPriority

        public BoundCodeableConceptDt<GoalPriorityEnumgetPriority()
        Gets the value(s) for priority (). creating it if it does not exist. Will not return null.

        Definition: Identifies the mutually agreed level of importance associated with reaching/sustaining the goal

      • setPriority

        public Goal setPriority​(GoalPriorityEnum theValue)
        Sets the value(s) for priority ()

        Definition: Identifies the mutually agreed level of importance associated with reaching/sustaining the goal

      • getAddresses

        public List<ResourceReferenceDtgetAddresses()
        Gets the value(s) for addresses (). creating it if it does not exist. Will not return null.

        Definition: The identified conditions and other health record elements that are intended to be addressed by the goal

      • setAddresses

        public Goal setAddresses​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for addresses ()

        Definition: The identified conditions and other health record elements that are intended to be addressed by the goal

      • addAddresses

        public ResourceReferenceDt addAddresses()
        Adds and returns a new value for addresses ()

        Definition: The identified conditions and other health record elements that are intended to be addressed by the goal

      • getNote

        public List<AnnotationDtgetNote()
        Gets the value(s) for note (). creating it if it does not exist. Will not return null.

        Definition: Any comments related to the goal

      • setNote

        public Goal setNote​(List<AnnotationDt> theValue)
        Sets the value(s) for note ()

        Definition: Any comments related to the goal

      • addNote

        public AnnotationDt addNote()
        Adds and returns a new value for note ()

        Definition: Any comments related to the goal

      • addNote

        public Goal addNote​(AnnotationDt theValue)
        Adds a given new value for note ()

        Definition: Any comments related to the goal

        Parameters:
        theValue - The note to add (must not be null)
      • getNoteFirstRep

        public AnnotationDt getNoteFirstRep()
        Gets the first repetition for note (), creating it if it does not already exist.

        Definition: Any comments related to the goal

      • getOutcome

        public List<Goal.OutcomegetOutcome()
        Gets the value(s) for outcome (). creating it if it does not exist. Will not return null.

        Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.

      • setOutcome

        public Goal setOutcome​(List<Goal.Outcome> theValue)
        Sets the value(s) for outcome ()

        Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.

      • addOutcome

        public Goal.Outcome addOutcome()
        Adds and returns a new value for outcome ()

        Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.

      • addOutcome

        public Goal addOutcome​(Goal.Outcome theValue)
        Adds a given new value for outcome ()

        Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.

        Parameters:
        theValue - The outcome to add (must not be null)
      • getOutcomeFirstRep

        public Goal.Outcome getOutcomeFirstRep()
        Gets the first repetition for outcome (), creating it if it does not already exist.

        Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource