Goal (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.BaseResource
  - - org.hl7.fhir.r4.model.Resource
    - - org.hl7.fhir.r4.model.DomainResource
      - org.hl7.fhir.r4.model.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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Goal.GoalLifecycleStatus`
`static class`	`Goal.GoalLifecycleStatusEnumFactory`
`static class`	`Goal.GoalTargetComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ACHIEVEMENT_STATUS` Fluent Client search parameter constant for achievement-status
`protected CodeableConcept`	`achievementStatus` Describes the progression, or lack thereof, towards the goal against the target.
`protected List<Reference>`	`addresses` The identified conditions and other health record elements that are intended to be addressed by the goal.
`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.)
`protected List<CodeableConcept>`	`category` Indicates a category the goal falls within.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CATEGORY` Fluent Client search parameter constant for category
`protected 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".
`protected Reference`	`expressedBy` Indicates whose goal this is - patient goal, practitioner goal, etc.
`protected Resource`	`expressedByTarget` The actual object that is the target of the reference (Indicates whose goal this is - patient goal, practitioner goal, etc.)
`protected List<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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`LIFECYCLE_STATUS` Fluent Client search parameter constant for lifecycle-status
`protected Enumeration<Goal.GoalLifecycleStatus>`	`lifecycleStatus` The state of the goal throughout its lifecycle.
`protected List<Annotation>`	`note` Any comments related to the goal.
`protected List<CodeableConcept>`	`outcomeCode` Identifies the change (or lack of change) at the point when the status of the goal is assessed.
`protected List<Reference>`	`outcomeReference` Details of what's changed (or not changed).
`protected List<Observation>`	`outcomeReferenceTarget` The actual objects that are the target of the reference (Details of what's changed (or not changed).)
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected CodeableConcept`	`priority` Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
`static String`	`SP_ACHIEVEMENT_STATUS` Search parameter: achievement-status
`static String`	`SP_CATEGORY` Search parameter: category
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_LIFECYCLE_STATUS` Search parameter: lifecycle-status
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_START_DATE` Search parameter: start-date
`static String`	`SP_SUBJECT` Search parameter: subject
`static String`	`SP_TARGET_DATE` Search parameter: target-date
`protected Type`	`start` The date or event after which the goal should begin being pursued.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`START_DATE` Fluent Client search parameter constant for start-date
`protected DateType`	`statusDate` Identifies when the current status.
`protected StringType`	`statusReason` Captures the reason for the current status.
`protected Reference`	`subject` Identifies the patient, group or organization for whom the goal is being established.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`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.)
`protected List<Goal.GoalTargetComponent>`	`target` Indicates what should be done by when.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`TARGET_DATE` Fluent Client search parameter constant for target-date

Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description
`Goal()` Constructor
`Goal(Enumeration<Goal.GoalLifecycleStatus> lifecycleStatus, CodeableConcept description, Reference subject)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Reference`	`addAddresses()`
`Goal`	`addAddresses(Reference t)`
`CodeableConcept`	`addCategory()`
`Goal`	`addCategory(CodeableConcept t)`
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Goal`	`addIdentifier(Identifier t)`
`Annotation`	`addNote()`
`Goal`	`addNote(Annotation t)`
`CodeableConcept`	`addOutcomeCode()`
`Goal`	`addOutcomeCode(CodeableConcept t)`
`Reference`	`addOutcomeReference()`
`Goal`	`addOutcomeReference(Reference t)`
`Observation`	`addOutcomeReferenceTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Goal.GoalTargetComponent`	`addTarget()`
`Goal`	`addTarget(Goal.GoalTargetComponent t)`
`Goal`	`copy()`
`void`	`copyValues(Goal dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`CodeableConcept`	`getAchievementStatus()`
`List<Reference>`	`getAddresses()`
`Reference`	`getAddressesFirstRep()`
`List<Resource>`	`getAddressesTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`List<CodeableConcept>`	`getCategory()`
`CodeableConcept`	`getCategoryFirstRep()`
`CodeableConcept`	`getDescription()`
`Reference`	`getExpressedBy()`
`Resource`	`getExpressedByTarget()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`Goal.GoalLifecycleStatus`	`getLifecycleStatus()`
`Enumeration<Goal.GoalLifecycleStatus>`	`getLifecycleStatusElement()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<Annotation>`	`getNote()`
`Annotation`	`getNoteFirstRep()`
`List<CodeableConcept>`	`getOutcomeCode()`
`CodeableConcept`	`getOutcomeCodeFirstRep()`
`List<Reference>`	`getOutcomeReference()`
`Reference`	`getOutcomeReferenceFirstRep()`
`List<Observation>`	`getOutcomeReferenceTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`CodeableConcept`	`getPriority()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`ResourceType`	`getResourceType()`
`Type`	`getStart()`
`CodeableConcept`	`getStartCodeableConcept()`
`DateType`	`getStartDateType()`
`Date`	`getStatusDate()`
`DateType`	`getStatusDateElement()`
`String`	`getStatusReason()`
`StringType`	`getStatusReasonElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`List<Goal.GoalTargetComponent>`	`getTarget()`
`Goal.GoalTargetComponent`	`getTargetFirstRep()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAchievementStatus()`
`boolean`	`hasAddresses()`
`boolean`	`hasCategory()`
`boolean`	`hasDescription()`
`boolean`	`hasExpressedBy()`
`boolean`	`hasIdentifier()`
`boolean`	`hasLifecycleStatus()`
`boolean`	`hasLifecycleStatusElement()`
`boolean`	`hasNote()`
`boolean`	`hasOutcomeCode()`
`boolean`	`hasOutcomeReference()`
`boolean`	`hasPriority()`
`boolean`	`hasStart()`
`boolean`	`hasStartCodeableConcept()`
`boolean`	`hasStartDateType()`
`boolean`	`hasStatusDate()`
`boolean`	`hasStatusDateElement()`
`boolean`	`hasStatusReason()`
`boolean`	`hasStatusReasonElement()`
`boolean`	`hasSubject()`
`boolean`	`hasTarget()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Goal`	`setAchievementStatus(CodeableConcept value)`
`Goal`	`setAddresses(List<Reference> theAddresses)`
`Goal`	`setCategory(List<CodeableConcept> theCategory)`
`Goal`	`setDescription(CodeableConcept value)`
`Goal`	`setExpressedBy(Reference value)`
`Goal`	`setExpressedByTarget(Resource value)`
`Goal`	`setIdentifier(List<Identifier> theIdentifier)`
`Goal`	`setLifecycleStatus(Goal.GoalLifecycleStatus value)`
`Goal`	`setLifecycleStatusElement(Enumeration<Goal.GoalLifecycleStatus> value)`
`Goal`	`setNote(List<Annotation> theNote)`
`Goal`	`setOutcomeCode(List<CodeableConcept> theOutcomeCode)`
`Goal`	`setOutcomeReference(List<Reference> theOutcomeReference)`
`Goal`	`setPriority(CodeableConcept value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Goal`	`setStart(Type value)`
`Goal`	`setStatusDate(Date value)`
`Goal`	`setStatusDateElement(DateType value)`
`Goal`	`setStatusReason(String value)`
`Goal`	`setStatusReasonElement(StringType value)`
`Goal`	`setSubject(Reference value)`
`Goal`	`setSubjectTarget(Resource value)`
`Goal`	`setTarget(List<Goal.GoalTargetComponent> theTarget)`
`protected Goal`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

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

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<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.
  - lifecycleStatus
```
protected Enumeration<Goal.GoalLifecycleStatus> lifecycleStatus
```
    The state of the goal throughout its lifecycle.
  - achievementStatus
```
protected CodeableConcept achievementStatus
```
    Describes the progression, or lack thereof, towards the goal against the target.
  - category
```
protected List<CodeableConcept> category
```
    Indicates a category the goal falls within.
  - priority
```
protected CodeableConcept priority
```
    Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
  - description
```
protected 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".
  - 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 List<Goal.GoalTargetComponent> target
```
    Indicates what should be done by when.
  - statusDate
```
protected DateType statusDate
```
    Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
  - statusReason
```
protected StringType statusReason
```
    Captures the reason for the current status.
  - expressedBy
```
protected Reference expressedBy
```
    Indicates whose goal this is - patient goal, practitioner goal, etc.
  - expressedByTarget
```
protected Resource expressedByTarget
```
    The actual object that is the target of the reference (Indicates whose goal this is - patient goal, practitioner goal, etc.)
  - 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.)
  - note
```
protected List<Annotation> note
```
    Any comments related to the goal.
  - outcomeCode
```
protected List<CodeableConcept> outcomeCode
```
    Identifies the change (or lack of change) at the point when the status of the goal is assessed.
  - outcomeReference
```
protected List<Reference> outcomeReference
```
    Details of what's changed (or not changed).
  - outcomeReferenceTarget
```
protected List<Observation> outcomeReferenceTarget
```
    The actual objects that are the target of the reference (Details of what's changed (or not changed).)
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: External Ids for this goal
    Type: token
    Path: Goal.identifier
    
    See Also:
    
    Constant Field Values
  - 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
  - SP_LIFECYCLE_STATUS
```
public static final String SP_LIFECYCLE_STATUS
```
    Search parameter: lifecycle-status
    Description: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
    Type: token
    Path: Goal.lifecycleStatus
    
    See Also:
    
    Constant Field Values
  - LIFECYCLE_STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam LIFECYCLE_STATUS
```
    Fluent Client search parameter constant for lifecycle-status
    Description: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
    Type: token
    Path: Goal.lifecycleStatus
  - SP_ACHIEVEMENT_STATUS
```
public static final String SP_ACHIEVEMENT_STATUS
```
    Search parameter: achievement-status
    Description: in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
    Type: token
    Path: Goal.achievementStatus
    
    See Also:
    
    Constant Field Values
  - ACHIEVEMENT_STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACHIEVEMENT_STATUS
```
    Fluent Client search parameter constant for achievement-status
    Description: in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
    Type: token
    Path: Goal.achievementStatus
  - 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_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".
  - SP_START_DATE
```
public static final String SP_START_DATE
```
    Search parameter: start-date
    Description: When goal pursuit begins
    Type: date
    Path: Goal.startDate
    
    See Also:
    
    Constant Field Values
  - START_DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam START_DATE
```
    Fluent Client search parameter constant for start-date
    Description: When goal pursuit begins
    Type: date
    Path: Goal.startDate
  - 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_TARGET_DATE
```
public static final String SP_TARGET_DATE
```
    Search parameter: target-date
    Description: Reach goal on or before
    Type: date
    Path: Goal.target.dueDate
    
    See Also:
    
    Constant Field Values
  - TARGET_DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam TARGET_DATE
```
    Fluent Client search parameter constant for target-date
    Description: Reach goal on or before
    Type: date
    Path: Goal.target.dueDate
- Constructor Detail
  - Goal
```
public Goal()
```
    Constructor
  - Goal
```
public Goal(Enumeration<Goal.GoalLifecycleStatus> lifecycleStatus,
            CodeableConcept description,
            Reference subject)
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    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.)
  - setIdentifier
```
public Goal setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public Goal addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getLifecycleStatusElement
```
public Enumeration<Goal.GoalLifecycleStatus> getLifecycleStatusElement()
```
    Returns:
    
    lifecycleStatus (The state of the goal throughout its lifecycle.). This is the underlying object with id, value and extensions. The accessor "getLifecycleStatus" gives direct access to the value
  - hasLifecycleStatusElement
```
public boolean hasLifecycleStatusElement()
```
  - hasLifecycleStatus
```
public boolean hasLifecycleStatus()
```
  - setLifecycleStatusElement
```
public Goal setLifecycleStatusElement(Enumeration<Goal.GoalLifecycleStatus> value)
```
    Parameters:
    
    value - lifecycleStatus (The state of the goal throughout its lifecycle.). This is the underlying object with id, value and extensions. The accessor "getLifecycleStatus" gives direct access to the value
  - getLifecycleStatus
```
public Goal.GoalLifecycleStatus getLifecycleStatus()
```
    Returns:
    
    The state of the goal throughout its lifecycle.
  - setLifecycleStatus
```
public Goal setLifecycleStatus(Goal.GoalLifecycleStatus value)
```
    Parameters:
    
    value - The state of the goal throughout its lifecycle.
  - getAchievementStatus
```
public CodeableConcept getAchievementStatus()
```
    Returns:
    
    achievementStatus (Describes the progression, or lack thereof, towards the goal against the target.)
  - hasAchievementStatus
```
public boolean hasAchievementStatus()
```
  - setAchievementStatus
```
public Goal setAchievementStatus(CodeableConcept value)
```
    Parameters:
    
    value - achievementStatus (Describes the progression, or lack thereof, towards the goal against the target.)
  - getCategory
```
public List<CodeableConcept> getCategory()
```
    Returns:
    
    category (Indicates a category the goal falls within.)
  - setCategory
```
public Goal setCategory(List<CodeableConcept> theCategory)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasCategory
```
public boolean hasCategory()
```
  - addCategory
```
public CodeableConcept addCategory()
```
  - addCategory
```
public Goal addCategory(CodeableConcept t)
```
  - getCategoryFirstRep
```
public CodeableConcept getCategoryFirstRep()
```
    Returns:
    
    The first repetition of repeating field category, creating it if it does not already exist
  - 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.)
  - getDescription
```
public CodeableConcept getDescription()
```
    Returns:
    
    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".)
  - hasDescription
```
public boolean hasDescription()
```
  - setDescription
```
public Goal setDescription(CodeableConcept value)
```
    Parameters:
    
    value - 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".)
  - 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 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
  - hasStartDateType
```
public boolean hasStartDateType()
```
  - 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
  - hasStartCodeableConcept
```
public boolean hasStartCodeableConcept()
```
  - 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 List<Goal.GoalTargetComponent> getTarget()
```
    Returns:
    
    target (Indicates what should be done by when.)
  - setTarget
```
public Goal setTarget(List<Goal.GoalTargetComponent> theTarget)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasTarget
```
public boolean hasTarget()
```
  - addTarget
```
public Goal.GoalTargetComponent addTarget()
```
  - addTarget
```
public Goal addTarget(Goal.GoalTargetComponent t)
```
  - getTargetFirstRep
```
public Goal.GoalTargetComponent getTargetFirstRep()
```
    Returns:
    
    The first repetition of repeating field target, creating it if it does not already exist
  - 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.
  - getStatusReasonElement
```
public StringType getStatusReasonElement()
```
    Returns:
    
    statusReason (Captures the reason for the current status.). This is the underlying object with id, value and extensions. The accessor "getStatusReason" gives direct access to the value
  - hasStatusReasonElement
```
public boolean hasStatusReasonElement()
```
  - hasStatusReason
```
public boolean hasStatusReason()
```
  - setStatusReasonElement
```
public Goal setStatusReasonElement(StringType value)
```
    Parameters:
    
    value - statusReason (Captures the reason for the current status.). This is the underlying object with id, value and extensions. The accessor "getStatusReason" gives direct access to the value
  - getStatusReason
```
public String getStatusReason()
```
    Returns:
    
    Captures the reason for the current status.
  - setStatusReason
```
public Goal setStatusReason(String value)
```
    Parameters:
    
    value - Captures the reason for the current status.
  - getExpressedBy
```
public Reference getExpressedBy()
```
    Returns:
    
    expressedBy (Indicates whose goal this is - patient goal, practitioner goal, etc.)
  - hasExpressedBy
```
public boolean hasExpressedBy()
```
  - setExpressedBy
```
public Goal setExpressedBy(Reference value)
```
    Parameters:
    
    value - expressedBy (Indicates whose goal this is - patient goal, practitioner goal, etc.)
  - getExpressedByTarget
```
public Resource getExpressedByTarget()
```
    Returns:
    
    expressedBy 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.)
  - setExpressedByTarget
```
public Goal setExpressedByTarget(Resource value)
```
    Parameters:
    
    value - expressedBy 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.)
  - getAddresses
```
public List<Reference> getAddresses()
```
    Returns:
    
    addresses (The identified conditions and other health record elements that are intended to be addressed by the goal.)
  - setAddresses
```
public Goal setAddresses(List<Reference> theAddresses)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAddresses
```
public boolean hasAddresses()
```
  - addAddresses
```
public Reference addAddresses()
```
  - addAddresses
```
public Goal addAddresses(Reference t)
```
  - getAddressesFirstRep
```
public Reference getAddressesFirstRep()
```
    Returns:
    
    The first repetition of repeating field addresses, creating it if it does not already exist
  - getAddressesTarget
```
@Deprecated
public List<Resource> getAddressesTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getNote
```
public List<Annotation> getNote()
```
    Returns:
    
    note (Any comments related to the goal.)
  - setNote
```
public Goal setNote(List<Annotation> theNote)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
  - addNote
```
public Goal addNote(Annotation t)
```
  - getNoteFirstRep
```
public Annotation getNoteFirstRep()
```
    Returns:
    
    The first repetition of repeating field note, creating it if it does not already exist
  - getOutcomeCode
```
public List<CodeableConcept> getOutcomeCode()
```
    Returns:
    
    outcomeCode (Identifies the change (or lack of change) at the point when the status of the goal is assessed.)
  - setOutcomeCode
```
public Goal setOutcomeCode(List<CodeableConcept> theOutcomeCode)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasOutcomeCode
```
public boolean hasOutcomeCode()
```
  - addOutcomeCode
```
public CodeableConcept addOutcomeCode()
```
  - addOutcomeCode
```
public Goal addOutcomeCode(CodeableConcept t)
```
  - getOutcomeCodeFirstRep
```
public CodeableConcept getOutcomeCodeFirstRep()
```
    Returns:
    
    The first repetition of repeating field outcomeCode, creating it if it does not already exist
  - getOutcomeReference
```
public List<Reference> getOutcomeReference()
```
    Returns:
    
    outcomeReference (Details of what's changed (or not changed).)
  - setOutcomeReference
```
public Goal setOutcomeReference(List<Reference> theOutcomeReference)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasOutcomeReference
```
public boolean hasOutcomeReference()
```
  - addOutcomeReference
```
public Reference addOutcomeReference()
```
  - addOutcomeReference
```
public Goal addOutcomeReference(Reference t)
```
  - getOutcomeReferenceFirstRep
```
public Reference getOutcomeReferenceFirstRep()
```
    Returns:
    
    The first repetition of repeating field outcomeReference, creating it if it does not already exist
  - getOutcomeReferenceTarget
```
@Deprecated
public List<Observation> getOutcomeReferenceTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addOutcomeReferenceTarget
```
@Deprecated
public Observation addOutcomeReferenceTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - 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
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Goal copy()
```
    Specified by:
    
    copy in class DomainResource
  - copyValues
```
public void copyValues(Goal dst)
```
  - typedCopy
```
protected Goal typedCopy()
```
  - 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 org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Goal

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

Fields inherited from class org.hl7.fhir.r4.model.Resource

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class org.hl7.fhir.r4.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

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

Field Detail

identifier

lifecycleStatus

achievementStatus

category

priority

description

subject

subjectTarget

start

target

statusDate

statusReason

expressedBy

expressedByTarget

addresses

addressesTarget

note

outcomeCode

outcomeReference

outcomeReferenceTarget

SP_IDENTIFIER

IDENTIFIER

SP_LIFECYCLE_STATUS

LIFECYCLE_STATUS

SP_ACHIEVEMENT_STATUS

ACHIEVEMENT_STATUS

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_START_DATE

START_DATE

SP_CATEGORY

CATEGORY

SP_TARGET_DATE

TARGET_DATE

Constructor Detail

Goal

Goal

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getLifecycleStatusElement

hasLifecycleStatusElement

hasLifecycleStatus

setLifecycleStatusElement

getLifecycleStatus

setLifecycleStatus

getAchievementStatus

hasAchievementStatus

setAchievementStatus

getCategory

setCategory

hasCategory

addCategory

addCategory