public class Goal extends BaseResource implements IResource
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
| Modifier and Type | Class and Description |
|---|---|
static class |
Goal.Outcome
Block class for child element: Goal.outcome ()
|
| Modifier and Type | Field and Description |
|---|---|
static TokenClientParam |
CATEGORY
Fluent Client search parameter constant for category
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static String |
SP_CATEGORY
Search parameter constant for category
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static String |
SP_TARGETDATE
Search parameter constant for targetdate
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
static DateClientParam |
TARGETDATE
Fluent Client search parameter constant for targetdate
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
Goal() |
| Modifier and Type | Method and Description |
|---|---|
ResourceReferenceDt |
addAddresses()
Adds and returns a new value for addresses ()
|
BoundCodeableConceptDt<GoalCategoryEnum> |
addCategory()
Add a value for category ()
|
BoundCodeableConceptDt<GoalCategoryEnum> |
addCategory(GoalCategoryEnum theValue)
Add a value for category () using an enumerated type.
|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (id)
|
Goal |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier (id)
|
AnnotationDt |
addNote()
Adds and returns a new value for note ()
|
Goal |
addNote(AnnotationDt theValue)
Adds a given new value for note ()
|
Goal.Outcome |
addOutcome()
Adds and returns a new value for outcome ()
|
Goal |
addOutcome(Goal.Outcome theValue)
Adds a given new value for outcome ()
|
List<ResourceReferenceDt> |
getAddresses()
Gets the value(s) for addresses ().
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
ResourceReferenceDt |
getAuthor()
Gets the value(s) for author (who.actor).
|
List<BoundCodeableConceptDt<GoalCategoryEnum>> |
getCategory()
Gets the value(s) for category ().
|
BoundCodeableConceptDt<GoalCategoryEnum> |
getCategoryFirstRep()
Gets the first repetition for category (),
creating it if it does not already exist.
|
String |
getDescription()
Gets the value(s) for description ().
|
StringDt |
getDescriptionElement()
Gets the value(s) for description ().
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (id).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (id),
creating it if it does not already exist.
|
List<AnnotationDt> |
getNote()
Gets the value(s) for note ().
|
AnnotationDt |
getNoteFirstRep()
Gets the first repetition for note (),
creating it if it does not already exist.
|
List<Goal.Outcome> |
getOutcome()
Gets the value(s) for outcome ().
|
Goal.Outcome |
getOutcomeFirstRep()
Gets the first repetition for outcome (),
creating it if it does not already exist.
|
BoundCodeableConceptDt<GoalPriorityEnum> |
getPriority()
Gets the value(s) for priority ().
|
String |
getResourceName() |
IDatatype |
getStart()
Gets the value(s) for start[x] ().
|
String |
getStatus()
Gets the value(s) for status (status).
|
Date |
getStatusDate()
Gets the value(s) for statusDate (when.recorded).
|
DateDt |
getStatusDateElement()
Gets the value(s) for statusDate (when.recorded).
|
BoundCodeDt<GoalStatusEnum> |
getStatusElement()
Gets the value(s) for status (status).
|
BoundCodeableConceptDt<GoalStatusReasonEnum> |
getStatusReason()
Gets the value(s) for statusReason ().
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
ResourceReferenceDt |
getSubject()
Gets the value(s) for subject (who.focus).
|
IDatatype |
getTarget()
Gets the value(s) for target[x] ().
|
boolean |
isEmpty() |
Goal |
setAddresses(List<ResourceReferenceDt> theValue)
Sets the value(s) for addresses ()
|
Goal |
setAuthor(ResourceReferenceDt theValue)
Sets the value(s) for author (who.actor)
|
Goal |
setCategory(GoalCategoryEnum theValue)
Sets the value(s), and clears any existing value(s) for category ()
|
Goal |
setCategory(List<BoundCodeableConceptDt<GoalCategoryEnum>> theValue)
Sets the value(s) for category ()
|
Goal |
setDescription(String theString)
Sets the value for description ()
|
Goal |
setDescription(StringDt theValue)
Sets the value(s) for description ()
|
Goal |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (id)
|
Goal |
setNote(List<AnnotationDt> theValue)
Sets the value(s) for note ()
|
Goal |
setOutcome(List<Goal.Outcome> theValue)
Sets the value(s) for outcome ()
|
Goal |
setPriority(BoundCodeableConceptDt<GoalPriorityEnum> theValue)
Sets the value(s) for priority ()
|
Goal |
setPriority(GoalPriorityEnum theValue)
Sets the value(s) for priority ()
|
Goal |
setStart(IDatatype theValue)
Sets the value(s) for start[x] ()
|
Goal |
setStatus(BoundCodeDt<GoalStatusEnum> theValue)
Sets the value(s) for status (status)
|
Goal |
setStatus(GoalStatusEnum theValue)
Sets the value(s) for status (status)
|
Goal |
setStatusDate(DateDt theValue)
Sets the value(s) for statusDate (when.recorded)
|
Goal |
setStatusDate(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for statusDate (when.recorded)
|
Goal |
setStatusDateWithDayPrecision(Date theDate)
Sets the value for statusDate (when.recorded)
|
Goal |
setStatusReason(BoundCodeableConceptDt<GoalStatusReasonEnum> theValue)
Sets the value(s) for statusReason ()
|
Goal |
setStatusReason(GoalStatusReasonEnum theValue)
Sets the value(s) for statusReason ()
|
Goal |
setSubject(ResourceReferenceDt theValue)
Sets the value(s) for subject (who.focus)
|
Goal |
setTarget(IDatatype theValue)
Sets the value(s) for target[x] ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_PATIENT
Description:
Type: reference
Path: Goal.subject
public static final ReferenceClientParam PATIENT
Description:
Type: reference
Path: Goal.subject
public static final String SP_SUBJECT
Description:
Type: reference
Path: Goal.subject
public static final ReferenceClientParam SUBJECT
Description:
Type: reference
Path: Goal.subject
public static final String SP_CATEGORY
Description:
Type: token
Path: Goal.category
public static final TokenClientParam CATEGORY
Description:
Type: token
Path: Goal.category
public static final String SP_TARGETDATE
Description:
Type: date
Path: Goal.targetDate
public static final DateClientParam TARGETDATE
Description:
Type: date
Path: Goal.targetDate
public static final String SP_IDENTIFIER
Description:
Type: token
Path: Goal.identifier
public static final TokenClientParam IDENTIFIER
Description:
Type: token
Path: Goal.identifier
public static final String SP_STATUS
Description:
Type: token
Path: Goal.status
public static final TokenClientParam STATUS
Description:
Type: token
Path: Goal.status
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_SUBJECT
public Goal()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic List<IdentifierDt> getIdentifier()
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)
public Goal setIdentifier(List<IdentifierDt> theValue)
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)
public IdentifierDt addIdentifier()
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)
public Goal addIdentifier(IdentifierDt theValue)
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)
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
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)
public ResourceReferenceDt getSubject()
null.
Definition: Identifies the patient, group or organization for whom the goal is being established.
public Goal setSubject(ResourceReferenceDt theValue)
Definition: Identifies the patient, group or organization for whom the goal is being established.
public IDatatype getStart()
null.
Definition: The date or event after which the goal should begin being pursued
public Goal setStart(IDatatype theValue)
Definition: The date or event after which the goal should begin being pursued
public IDatatype getTarget()
null.
Definition: Indicates either the date or the duration after start by which the goal should be met
public Goal setTarget(IDatatype theValue)
Definition: Indicates either the date or the duration after start by which the goal should be met
public List<BoundCodeableConceptDt<GoalCategoryEnum>> getCategory()
null.
Definition: Indicates a category the goal falls within
public Goal setCategory(List<BoundCodeableConceptDt<GoalCategoryEnum>> theValue)
Definition: Indicates a category the goal falls within
public BoundCodeableConceptDt<GoalCategoryEnum> addCategory(GoalCategoryEnum theValue)
addCategory() method.
Definition: Indicates a category the goal falls within
public BoundCodeableConceptDt<GoalCategoryEnum> getCategoryFirstRep()
Definition: Indicates a category the goal falls within
public BoundCodeableConceptDt<GoalCategoryEnum> addCategory()
Definition: Indicates a category the goal falls within
public Goal setCategory(GoalCategoryEnum theValue)
Definition: Indicates a category the goal falls within
public StringDt getDescriptionElement()
null.
Definition: Human-readable description of a specific desired objective of care.
public String getDescription()
null.
Definition: Human-readable description of a specific desired objective of care.
public Goal setDescription(StringDt theValue)
Definition: Human-readable description of a specific desired objective of care.
public Goal setDescription(String theString)
Definition: Human-readable description of a specific desired objective of care.
public BoundCodeDt<GoalStatusEnum> getStatusElement()
null.
Definition: Indicates whether the goal has been reached and is still considered relevant
public String getStatus()
null.
Definition: Indicates whether the goal has been reached and is still considered relevant
public Goal setStatus(BoundCodeDt<GoalStatusEnum> theValue)
Definition: Indicates whether the goal has been reached and is still considered relevant
public Goal setStatus(GoalStatusEnum theValue)
Definition: Indicates whether the goal has been reached and is still considered relevant
public DateDt getStatusDateElement()
null.
Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
public Date getStatusDate()
null.
Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
public Goal setStatusDate(DateDt theValue)
Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
public Goal setStatusDate(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
public Goal setStatusDateWithDayPrecision(Date theDate)
Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
public BoundCodeableConceptDt<GoalStatusReasonEnum> getStatusReason()
null.
Definition: Captures the reason for the current status.
public Goal setStatusReason(BoundCodeableConceptDt<GoalStatusReasonEnum> theValue)
Definition: Captures the reason for the current status.
public Goal setStatusReason(GoalStatusReasonEnum theValue)
Definition: Captures the reason for the current status.
public ResourceReferenceDt getAuthor()
null.
Definition: Indicates whose goal this is - patient goal, practitioner goal, etc.
public Goal setAuthor(ResourceReferenceDt theValue)
Definition: Indicates whose goal this is - patient goal, practitioner goal, etc.
public BoundCodeableConceptDt<GoalPriorityEnum> getPriority()
null.
Definition: Identifies the mutually agreed level of importance associated with reaching/sustaining the goal
public Goal setPriority(BoundCodeableConceptDt<GoalPriorityEnum> theValue)
Definition: Identifies the mutually agreed level of importance associated with reaching/sustaining the goal
public Goal setPriority(GoalPriorityEnum theValue)
Definition: Identifies the mutually agreed level of importance associated with reaching/sustaining the goal
public List<ResourceReferenceDt> getAddresses()
null.
Definition: The identified conditions and other health record elements that are intended to be addressed by the goal
public Goal setAddresses(List<ResourceReferenceDt> theValue)
Definition: The identified conditions and other health record elements that are intended to be addressed by the goal
public ResourceReferenceDt addAddresses()
Definition: The identified conditions and other health record elements that are intended to be addressed by the goal
public List<AnnotationDt> getNote()
null.
Definition: Any comments related to the goal
public Goal setNote(List<AnnotationDt> theValue)
Definition: Any comments related to the goal
public AnnotationDt addNote()
Definition: Any comments related to the goal
public Goal addNote(AnnotationDt theValue)
Definition: Any comments related to the goal
theValue - The note to add (must not be null)public AnnotationDt getNoteFirstRep()
Definition: Any comments related to the goal
public List<Goal.Outcome> getOutcome()
null.
Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
public Goal setOutcome(List<Goal.Outcome> theValue)
Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
public Goal.Outcome addOutcome()
Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
public Goal addOutcome(Goal.Outcome theValue)
Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
theValue - The outcome to add (must not be null)public Goal.Outcome getOutcomeFirstRep()
Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.