
Class Goal
- All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement
,ca.uhn.fhir.model.api.IElement
,ca.uhn.fhir.model.api.IResource
,ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseResource
public class Goal extends BaseResource implements ca.uhn.fhir.model.api.IResource
Definition: Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/Goal
- See Also:
- Serialized Form
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Goal.Outcome
Block class for child element: Goal.outcome () -
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParam
CATEGORY
Fluent Client search parameter constant for categorystatic ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic 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.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientstatic String
SP_CATEGORY
Search parameter constant for categorystatic String
SP_IDENTIFIER
Search parameter constant for identifierstatic String
SP_PATIENT
Search parameter constant for patientstatic String
SP_STATUS
Search parameter constant for statusstatic String
SP_SUBJECT
Search parameter constant for subjectstatic String
SP_TARGETDATE
Search parameter constant for targetdatestatic ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUBJECT
Fluent Client search parameter constant for subjectstatic ca.uhn.fhir.rest.gclient.DateClientParam
TARGETDATE
Fluent Client search parameter constant for targetdateFields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
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 Description Goal()
-
Method Summary
Modifier and Type Method Description ResourceReferenceDt
addAddresses()
Adds and returns a new value for addresses ()CodeableConceptDt
addCategory()
Adds and returns a new value for category ()Goal
addCategory(CodeableConceptDt theValue)
Adds a given new value for category ()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 ca.uhn.fhir.model.api.IElement>
List<T>getAllPopulatedChildElementsOfType(Class<T> theType)
ResourceReferenceDt
getAuthor()
Gets the value(s) for author (who.actor).List<CodeableConceptDt>
getCategory()
Gets the value(s) for category ().CodeableConceptDt
getCategoryFirstRep()
Gets the first repetition for category (), creating it if it does not already exist.String
getDescription()
Gets the value(s) for description ().ca.uhn.fhir.model.primitive.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()
ca.uhn.fhir.model.api.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).ca.uhn.fhir.model.primitive.DateDt
getStatusDateElement()
Gets the value(s) for statusDate (when.recorded).ca.uhn.fhir.model.primitive.BoundCodeDt<GoalStatusEnum>
getStatusElement()
Gets the value(s) for status (status).CodeableConceptDt
getStatusReason()
Gets the value(s) for statusReason ().ca.uhn.fhir.context.FhirVersionEnum
getStructureFhirVersionEnum()
ResourceReferenceDt
getSubject()
Gets the value(s) for subject (who.focus).ca.uhn.fhir.model.api.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(List<CodeableConceptDt> theValue)
Sets the value(s) for category ()Goal
setDescription(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for description ()Goal
setDescription(String theString)
Sets the value 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(ca.uhn.fhir.model.api.IDatatype theValue)
Sets the value(s) for start[x] ()Goal
setStatus(GoalStatusEnum theValue)
Sets the value(s) for status (status)Goal
setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<GoalStatusEnum> theValue)
Sets the value(s) for status (status)Goal
setStatusDate(ca.uhn.fhir.model.primitive.DateDt theValue)
Sets the value(s) for statusDate (when.recorded)Goal
setStatusDate(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value for statusDate (when.recorded)Goal
setStatusDateWithDayPrecision(Date theDate)
Sets the value for statusDate (when.recorded)Goal
setStatusReason(CodeableConceptDt theValue)
Sets the value(s) for statusReason ()Goal
setSubject(ResourceReferenceDt theValue)
Sets the value(s) for subject (who.focus)Goal
setTarget(ca.uhn.fhir.model.api.IDatatype theValue)
Sets the value(s) for target[x] ()Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString
Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId
Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
-
Field Details
-
SP_PATIENT
Search parameter constant for patientDescription:
Type: reference
Path: Goal.subject
- See Also:
- Constant Field Values
-
PATIENT
Fluent Client search parameter constant for patientDescription:
Type: reference
Path: Goal.subject
-
SP_SUBJECT
Search parameter constant for subjectDescription:
Type: reference
Path: Goal.subject
- See Also:
- Constant Field Values
-
SUBJECT
Fluent Client search parameter constant for subjectDescription:
Type: reference
Path: Goal.subject
-
SP_CATEGORY
Search parameter constant for categoryDescription:
Type: token
Path: Goal.category
- See Also:
- Constant Field Values
-
CATEGORY
Fluent Client search parameter constant for categoryDescription:
Type: token
Path: Goal.category
-
SP_TARGETDATE
Search parameter constant for targetdateDescription:
Type: date
Path: Goal.targetDate
- See Also:
- Constant Field Values
-
TARGETDATE
Fluent Client search parameter constant for targetdateDescription:
Type: date
Path: Goal.targetDate
-
SP_IDENTIFIER
Search parameter constant for identifierDescription:
Type: token
Path: Goal.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription:
Type: token
Path: Goal.identifier
-
SP_STATUS
Search parameter constant for statusDescription:
Type: token
Path: Goal.status
- See Also:
- Constant Field Values
-
STATUS
Fluent Client search parameter constant for statusDescription:
Type: token
Path: Goal.status
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Goal:patient". -
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Goal:subject".
-
-
Constructor Details
-
Goal
public Goal()
-
-
Method Details
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
-
getAllPopulatedChildElementsOfType
public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)- Specified by:
getAllPopulatedChildElementsOfType
in interfaceca.uhn.fhir.model.api.ICompositeElement
-
getIdentifier
Gets the value(s) for identifier (id). creating it if it does not exist. Will not returnnull
.Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
-
setIdentifier
Sets the value(s) for identifier (id)Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
-
addIdentifier
Adds and returns a new value for identifier (id)Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
-
addIdentifier
Adds a given new value for identifier (id)Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
- Parameters:
theValue
- The identifier to add (must not benull
)
-
getIdentifierFirstRep
Gets the first repetition for identifier (id), creating it if it does not already exist.Definition: This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
-
getSubject
Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not returnnull
.Definition: Identifies the patient, group or organization for whom the goal is being established.
-
setSubject
Sets the value(s) for subject (who.focus)Definition: Identifies the patient, group or organization for whom the goal is being established.
-
getStart
Gets the value(s) for start[x] (). creating it if it does not exist. Will not returnnull
.Definition: The date or event after which the goal should begin being pursued
-
setStart
Sets the value(s) for start[x] ()Definition: The date or event after which the goal should begin being pursued
-
getTarget
Gets the value(s) for target[x] (). creating it if it does not exist. Will not returnnull
.Definition: Indicates either the date or the duration after start by which the goal should be met
-
setTarget
Sets the value(s) for target[x] ()Definition: Indicates either the date or the duration after start by which the goal should be met
-
getCategory
Gets the value(s) for category (). creating it if it does not exist. Will not returnnull
.Definition: Indicates a category the goal falls within
-
setCategory
Sets the value(s) for category ()Definition: Indicates a category the goal falls within
-
addCategory
Adds and returns a new value for category ()Definition: Indicates a category the goal falls within
-
addCategory
Adds a given new value for category ()Definition: Indicates a category the goal falls within
- Parameters:
theValue
- The category to add (must not benull
)
-
getCategoryFirstRep
Gets the first repetition for category (), creating it if it does not already exist.Definition: Indicates a category the goal falls within
-
getDescriptionElement
Gets the value(s) for description (). creating it if it does not exist. Will not returnnull
.Definition: Human-readable description of a specific desired objective of care.
-
getDescription
Gets the value(s) for description (). creating it if it does not exist. This method may returnnull
.Definition: Human-readable description of a specific desired objective of care.
-
setDescription
Sets the value(s) for description ()Definition: Human-readable description of a specific desired objective of care.
-
setDescription
Sets the value for description ()Definition: Human-readable description of a specific desired objective of care.
-
getStatusElement
Gets the value(s) for status (status). creating it if it does not exist. Will not returnnull
.Definition: Indicates whether the goal has been reached and is still considered relevant
-
getStatus
Gets the value(s) for status (status). creating it if it does not exist. This method may returnnull
.Definition: Indicates whether the goal has been reached and is still considered relevant
-
setStatus
Sets the value(s) for status (status)Definition: Indicates whether the goal has been reached and is still considered relevant
-
setStatus
Sets the value(s) for status (status)Definition: Indicates whether the goal has been reached and is still considered relevant
-
getStatusDateElement
Gets the value(s) for statusDate (when.recorded). creating it if it does not exist. Will not returnnull
.Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
-
getStatusDate
Gets the value(s) for statusDate (when.recorded). creating it if it does not exist. This method may returnnull
.Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
-
setStatusDate
Sets the value(s) for statusDate (when.recorded)Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
-
setStatusDate
Sets the value for statusDate (when.recorded)Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
-
setStatusDateWithDayPrecision
Sets the value for statusDate (when.recorded)Definition: Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
-
getStatusReason
Gets the value(s) for statusReason (). creating it if it does not exist. Will not returnnull
.Definition: Captures the reason for the current status.
-
setStatusReason
Sets the value(s) for statusReason ()Definition: Captures the reason for the current status.
-
getAuthor
Gets the value(s) for author (who.actor). creating it if it does not exist. Will not returnnull
.Definition: Indicates whose goal this is - patient goal, practitioner goal, etc.
-
setAuthor
Sets the value(s) for author (who.actor)Definition: Indicates whose goal this is - patient goal, practitioner goal, etc.
-
getPriority
Gets the value(s) for priority (). creating it if it does not exist. Will not returnnull
.Definition: Identifies the mutually agreed level of importance associated with reaching/sustaining the goal
-
setPriority
Sets the value(s) for priority ()Definition: Identifies the mutually agreed level of importance associated with reaching/sustaining the goal
-
setPriority
Sets the value(s) for priority ()Definition: Identifies the mutually agreed level of importance associated with reaching/sustaining the goal
-
getAddresses
Gets the value(s) for addresses (). creating it if it does not exist. Will not returnnull
.Definition: The identified conditions and other health record elements that are intended to be addressed by the goal
-
setAddresses
Sets the value(s) for addresses ()Definition: The identified conditions and other health record elements that are intended to be addressed by the goal
-
addAddresses
Adds and returns a new value for addresses ()Definition: The identified conditions and other health record elements that are intended to be addressed by the goal
-
getNote
Gets the value(s) for note (). creating it if it does not exist. Will not returnnull
.Definition: Any comments related to the goal
-
setNote
Sets the value(s) for note ()Definition: Any comments related to the goal
-
addNote
Adds and returns a new value for note ()Definition: Any comments related to the goal
-
addNote
Adds a given new value for note ()Definition: Any comments related to the goal
- Parameters:
theValue
- The note to add (must not benull
)
-
getNoteFirstRep
Gets the first repetition for note (), creating it if it does not already exist.Definition: Any comments related to the goal
-
getOutcome
Gets the value(s) for outcome (). creating it if it does not exist. Will not returnnull
.Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
-
setOutcome
Sets the value(s) for outcome ()Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
-
addOutcome
Adds and returns a new value for outcome ()Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
-
addOutcome
Adds a given new value for outcome ()Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
- Parameters:
theValue
- The outcome to add (must not benull
)
-
getOutcomeFirstRep
Gets the first repetition for outcome (), creating it if it does not already exist.Definition: Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
-
getResourceName
- Specified by:
getResourceName
in interfaceca.uhn.fhir.model.api.IResource
-
getStructureFhirVersionEnum
- Specified by:
getStructureFhirVersionEnum
in interfaceorg.hl7.fhir.instance.model.api.IBaseResource
- Specified by:
getStructureFhirVersionEnum
in interfaceca.uhn.fhir.model.api.IResource
-