Goal (HAPI FHIR Structures - HL7.org DSTU2 1.3 API)

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.Goal

All Implemented Interfaces:

Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, 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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Goal.GoalOutcomeComponent

static class Goal.GoalStatus

static class Goal.GoalStatusEnumFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`Goal.GoalOutcomeComponent`
`static class`	`Goal.GoalStatus`
`static class`	`Goal.GoalStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SP_CATEGORY`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_PATIENT`
`static String`	`SP_STATUS`
`static String`	`SP_SUBJECT`
`static String`	`SP_TARGETDATE`

Constructor Summary

Constructors
Constructor and Description

Goal()

Goal(StringType description, Enumeration<Goal.GoalStatus> status)

Constructors
Constructor and Description
`Goal()`
`Goal(StringType description, Enumeration<Goal.GoalStatus> status)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Reference`	`addAddresses()`
`Goal`	`addAddresses(Reference t)`
`CodeableConcept`	`addCategory()`
`Goal`	`addCategory(CodeableConcept t)`
`Identifier`	`addIdentifier()`
`Goal`	`addIdentifier(Identifier t)`
`Annotation`	`addNote()`
`Goal`	`addNote(Annotation t)`
`Goal.GoalOutcomeComponent`	`addOutcome()`
`Goal`	`addOutcome(Goal.GoalOutcomeComponent t)`
`Goal`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`List<Reference>`	`getAddresses()`
`List<Resource>`	`getAddressesTarget()`
`Reference`	`getAuthor()`
`Resource`	`getAuthorTarget()`
`List<CodeableConcept>`	`getCategory()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`List<Identifier>`	`getIdentifier()`
`List<Annotation>`	`getNote()`
`List<Goal.GoalOutcomeComponent>`	`getOutcome()`
`CodeableConcept`	`getPriority()`
`ResourceType`	`getResourceType()`
`Type`	`getStart()`
`CodeableConcept`	`getStartCodeableConcept()`
`DateType`	`getStartDateType()`
`Goal.GoalStatus`	`getStatus()`
`Date`	`getStatusDate()`
`DateType`	`getStatusDateElement()`
`Enumeration<Goal.GoalStatus>`	`getStatusElement()`
`CodeableConcept`	`getStatusReason()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`Type`	`getTarget()`
`DateType`	`getTargetDateType()`
`Duration`	`getTargetDuration()`
`boolean`	`hasAddresses()`
`boolean`	`hasAuthor()`
`boolean`	`hasCategory()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasNote()`
`boolean`	`hasOutcome()`
`boolean`	`hasPriority()`
`boolean`	`hasStart()`
`boolean`	`hasStartCodeableConcept()`
`boolean`	`hasStartDateType()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusDate()`
`boolean`	`hasStatusDateElement()`
`boolean`	`hasStatusElement()`
`boolean`	`hasStatusReason()`
`boolean`	`hasSubject()`
`boolean`	`hasTarget()`
`boolean`	`hasTargetDateType()`
`boolean`	`hasTargetDuration()`
`boolean`	`isEmpty()`
`Goal`	`setAuthor(Reference value)`
`Goal`	`setAuthorTarget(Resource value)`
`Goal`	`setDescription(String value)`
`Goal`	`setDescriptionElement(StringType value)`
`Goal`	`setPriority(CodeableConcept value)`
`Goal`	`setStart(Type value)`
`Goal`	`setStatus(Goal.GoalStatus value)`
`Goal`	`setStatusDate(Date value)`
`Goal`	`setStatusDateElement(DateType value)`
`Goal`	`setStatusElement(Enumeration<Goal.GoalStatus> value)`
`Goal`	`setStatusReason(CodeableConcept value)`
`Goal`	`setSubject(Reference value)`
`Goal`	`setSubjectTarget(Resource value)`
`Goal`	`setTarget(Type value)`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasUserData, listChildrenByName, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getMeta, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
setId

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    See Also:
    
    Constant Field Values
  - SP_TARGETDATE
```
public static final String SP_TARGETDATE
```
    See Also:
    
    Constant Field Values
  - SP_CATEGORY
```
public static final String SP_CATEGORY
```
    See Also:
    
    Constant Field Values
  - SP_STATUS
```
public static final String SP_STATUS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Goal
```
public Goal()
```
  - Goal
```
public Goal(StringType description,
            Enumeration<Goal.GoalStatus> status)
```
- 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).)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - 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).)
  - addIdentifier
```
public Goal addIdentifier(Identifier t)
```
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (Identifies the patient, group or organization for whom the goal is being established.)
  - hasSubject
```
public boolean hasSubject()
```
  - 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 Exception
```
    Returns:
    
    start (The date or event after which the goal should begin being pursued.)
    
    Throws:
    
    Exception
  - hasStartDateType
```
public boolean hasStartDateType()
                         throws Exception
```
    Throws:
    
    Exception
  - getStartCodeableConcept
```
public CodeableConcept getStartCodeableConcept()
                                        throws Exception
```
    Returns:
    
    start (The date or event after which the goal should begin being pursued.)
    
    Throws:
    
    Exception
  - hasStartCodeableConcept
```
public boolean hasStartCodeableConcept()
                                throws Exception
```
    Throws:
    
    Exception
  - hasStart
```
public boolean hasStart()
```
  - 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 Exception
```
    Returns:
    
    target (Indicates either the date or the duration after start by which the goal should be met.)
    
    Throws:
    
    Exception
  - hasTargetDateType
```
public boolean hasTargetDateType()
                          throws Exception
```
    Throws:
    
    Exception
  - getTargetDuration
```
public Duration getTargetDuration()
                           throws Exception
```
    Returns:
    
    target (Indicates either the date or the duration after start by which the goal should be met.)
    
    Throws:
    
    Exception
  - hasTargetDuration
```
public boolean hasTargetDuration()
                          throws Exception
```
    Throws:
    
    Exception
  - hasTarget
```
public boolean hasTarget()
```
  - 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.)
  - getCategory
```
public List<CodeableConcept> getCategory()
```
    Returns:
    
    category (Indicates a category the goal falls within.)
  - hasCategory
```
public boolean hasCategory()
```
  - addCategory
```
public CodeableConcept addCategory()
```
    Returns:
    
    category (Indicates a category the goal falls within.)
  - addCategory
```
public Goal addCategory(CodeableConcept t)
```
  - 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
  - hasDescriptionElement
```
public boolean hasDescriptionElement()
```
  - hasDescription
```
public boolean hasDescription()
```
  - 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
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - 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
  - hasStatusDateElement
```
public boolean hasStatusDateElement()
```
  - hasStatusDate
```
public boolean hasStatusDate()
```
  - 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.
  - getStatusReason
```
public CodeableConcept getStatusReason()
```
    Returns:
    
    statusReason (Captures the reason for the current status.)
  - hasStatusReason
```
public boolean hasStatusReason()
```
  - setStatusReason
```
public Goal setStatusReason(CodeableConcept value)
```
    Parameters:
    
    value - statusReason (Captures the reason for the current status.)
  - getAuthor
```
public Reference getAuthor()
```
    Returns:
    
    author (Indicates whose goal this is - patient goal, practitioner goal, etc.)
  - hasAuthor
```
public boolean hasAuthor()
```
  - 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.)
  - getPriority
```
public CodeableConcept getPriority()
```
    Returns:
    
    priority (Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.)
  - hasPriority
```
public boolean hasPriority()
```
  - 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.)
  - hasAddresses
```
public boolean hasAddresses()
```
  - addAddresses
```
public Reference addAddresses()
```
    Returns:
    
    addresses (The identified conditions and other health record elements that are intended to be addressed by the goal.)
  - addAddresses
```
public Goal addAddresses(Reference t)
```
  - 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.)
  - getNote
```
public List<Annotation> getNote()
```
    Returns:
    
    note (Any comments related to the goal.)
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
    Returns:
    
    note (Any comments related to the goal.)
  - addNote
```
public Goal addNote(Annotation t)
```
  - getOutcome
```
public List<Goal.GoalOutcomeComponent> getOutcome()
```
    Returns:
    
    outcome (Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.)
  - hasOutcome
```
public boolean hasOutcome()
```
  - addOutcome
```
public Goal.GoalOutcomeComponent addOutcome()
```
    Returns:
    
    outcome (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.GoalOutcomeComponent t)
```
  - copy
```
public Goal copy()
```
    Specified by:
    
    copy in class DomainResource
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Goal

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.instance.model.DomainResource

Methods inherited from class org.hl7.fhir.instance.model.Resource

Methods inherited from class org.hl7.fhir.instance.model.BaseResource

Methods inherited from class org.hl7.fhir.instance.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

SP_IDENTIFIER

SP_PATIENT

SP_SUBJECT

SP_TARGETDATE

SP_CATEGORY

SP_STATUS

Constructor Detail

Goal

Goal

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getSubject

hasSubject

setSubject

getSubjectTarget

setSubjectTarget

getStart

getStartDateType

hasStartDateType

getStartCodeableConcept

hasStartCodeableConcept

hasStart

setStart

getTarget

getTargetDateType

hasTargetDateType

getTargetDuration

hasTargetDuration

hasTarget

setTarget

getCategory

hasCategory

addCategory

addCategory

getDescriptionElement

hasDescriptionElement

hasDescription

setDescriptionElement

getDescription

setDescription

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getStatusDateElement

hasStatusDateElement

hasStatusDate

setStatusDateElement

getStatusDate

setStatusDate

getStatusReason

hasStatusReason

setStatusReason

getAuthor

hasAuthor

setAuthor

getAuthorTarget

setAuthorTarget

getPriority

hasPriority

setPriority

getAddresses