Package org.hl7.fhir.dstu2016may.model

Class Goal

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
    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.
    See Also:
    Serialized Form

    • Field Detail

      • identifier

        protected List<Identifier> identifier
        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).

      • subject

        protected Reference subject
        Identifies the patient, group or organization for whom the goal is being established.

      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (Identifies the patient, group or organization for whom the goal is being established.)

      • start

        protected Type start
        The date or event after which the goal should begin being pursued.

      • target

        protected Type target
        Indicates either the date or the duration after start by which the goal should be met.

      • description

        protected StringType description
        Human-readable description of a specific desired objective of care.

      • statusDate

        protected DateType statusDate
        Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

      • author

        protected Reference author
        Indicates whose goal this is - patient goal, practitioner goal, etc.

      • authorTarget

        protected Resource authorTarget
        The actual object that is the target of the reference (Indicates whose goal this is - patient goal, practitioner goal, etc.)

      • priority

        protected CodeableConcept priority
        Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.

      • addresses

        protected List<Reference> addresses
        The identified conditions and other health record elements that are intended to be addressed by the goal.

      • addressesTarget

        protected List<Resource> addressesTarget
        The actual objects that are the target of the reference (The identified conditions and other health record elements that are intended to be addressed by the goal.)

      • TARGETDATE

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

        Description: Reach goal on or before
        Type: date
        Path: Goal.targetDate

      • SP_CATEGORY

        public static final String SP_CATEGORY
        Search parameter: category

        Description: E.g. Treatment, dietary, behavioral, etc.
        Type: token
        Path: Goal.category

        See Also:
        Constant Field Values

      • CATEGORY

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

        Description: E.g. Treatment, dietary, behavioral, etc.
        Type: token
        Path: Goal.category

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Who this goal is intended for
        Type: reference
        Path: Goal.subject

        See Also:
        Constant Field Values

      • PATIENT

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

        Description: Who this goal is intended for
        Type: reference
        Path: Goal.subject

      • 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".

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
        Type: token
        Path: Goal.status

        See Also:
        Constant Field Values

      • STATUS

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

        Description: proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
        Type: token
        Path: Goal.status

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: Who this goal is intended for
        Type: reference
        Path: Goal.subject

        See Also:
        Constant Field Values

      • SUBJECT

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

        Description: Who this goal is intended for
        Type: reference
        Path: Goal.subject

      • 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".

      • IDENTIFIER

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

        Description: External Ids for this goal
        Type: token
        Path: Goal.identifier

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Returns:
        identifier (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 Identifier addIdentifier()
        Returns:
        identifier (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 Reference getSubject()
        Returns:
        subject (Identifies the patient, group or organization for whom the goal is being established.)

      • setSubject

        public Goal setSubject​(Reference value)
        Parameters:
        value - subject (Identifies the patient, group or organization for whom the goal is being established.)

      • getSubjectTarget

        public Resource getSubjectTarget()
        Returns:
        subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identifies the patient, group or organization for whom the goal is being established.)

      • setSubjectTarget

        public Goal setSubjectTarget​(Resource value)
        Parameters:
        value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identifies the patient, group or organization for whom the goal is being established.)

      • getStart

        public Type getStart()
        Returns:
        start (The date or event after which the goal should begin being pursued.)

      • getStartDateType

        public DateType getStartDateType()
                          throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        start (The date or event after which the goal should begin being pursued.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getStartCodeableConcept

        public CodeableConcept getStartCodeableConcept()
                                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        start (The date or event after which the goal should begin being pursued.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • setStart

        public Goal setStart​(Type value)
        Parameters:
        value - start (The date or event after which the goal should begin being pursued.)

      • getTarget

        public Type getTarget()
        Returns:
        target (Indicates either the date or the duration after start by which the goal should be met.)

      • getTargetDateType

        public DateType getTargetDateType()
                           throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        target (Indicates either the date or the duration after start by which the goal should be met.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getTargetDuration

        public Duration getTargetDuration()
                           throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        target (Indicates either the date or the duration after start by which the goal should be met.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • setTarget

        public Goal setTarget​(Type value)
        Parameters:
        value - target (Indicates either the date or the duration after start by which the goal should be met.)

      • getDescriptionElement

        public StringType getDescriptionElement()
        Returns:
        description (Human-readable description of a specific desired objective of care.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • setDescriptionElement

        public Goal setDescriptionElement​(StringType value)
        Parameters:
        value - description (Human-readable description of a specific desired objective of care.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • getDescription

        public String getDescription()
        Returns:
        Human-readable description of a specific desired objective of care.

      • setDescription

        public Goal setDescription​(String value)
        Parameters:
        value - Human-readable description of a specific desired objective of care.

      • getStatusElement

        public Enumeration<Goal.GoalStatus> getStatusElement()
        Returns:
        status (Indicates whether the goal has been reached and is still considered relevant.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • setStatusElement

        public Goal setStatusElement​(Enumeration<Goal.GoalStatus> value)
        Parameters:
        value - status (Indicates whether the goal has been reached and is still considered relevant.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • getStatus

        public Goal.GoalStatus getStatus()
        Returns:
        Indicates whether the goal has been reached and is still considered relevant.

      • setStatus

        public Goal setStatus​(Goal.GoalStatus value)
        Parameters:
        value - Indicates whether the goal has been reached and is still considered relevant.

      • getStatusDateElement

        public DateType getStatusDateElement()
        Returns:
        statusDate (Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the value

      • setStatusDateElement

        public Goal setStatusDateElement​(DateType value)
        Parameters:
        value - statusDate (Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the value

      • getStatusDate

        public Date getStatusDate()
        Returns:
        Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

      • setStatusDate

        public Goal setStatusDate​(Date value)
        Parameters:
        value - Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

      • getAuthor

        public Reference getAuthor()
        Returns:
        author (Indicates whose goal this is - patient goal, practitioner goal, etc.)

      • setAuthor

        public Goal setAuthor​(Reference value)
        Parameters:
        value - author (Indicates whose goal this is - patient goal, practitioner goal, etc.)

      • getAuthorTarget

        public Resource getAuthorTarget()
        Returns:
        author The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates whose goal this is - patient goal, practitioner goal, etc.)

      • setAuthorTarget

        public Goal setAuthorTarget​(Resource value)
        Parameters:
        value - author The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates whose goal this is - patient goal, practitioner goal, etc.)

      • setPriority

        public Goal setPriority​(CodeableConcept value)
        Parameters:
        value - priority (Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.)

      • getAddresses

        public List<Reference> getAddresses()
        Returns:
        addresses (The identified conditions and other health record elements that are intended to be addressed by the goal.)

      • addAddresses

        public Reference addAddresses()
        Returns:
        addresses (The identified conditions and other health record elements that are intended to be addressed by the goal.)

      • getAddressesTarget

        public List<Resource> getAddressesTarget()
        Returns:
        addresses (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The identified conditions and other health record elements that are intended to be addressed by the goal.)

      • hasNote

        public boolean hasNote()

      • getProperty

        public Base[] getProperty​(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource