Class Goal
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for achievement-statusprotected CodeableConcept
Describes the progression, or lack thereof, towards the goal against the target.The identified conditions and other health record elements that are intended to be addressed by the goal.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> Indicates a category the goal falls within.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categoryprotected CodeableConcept
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
Indicates whose goal this is - patient goal, practitioner goal, etc.protected Resource
The actual object that is the target of the reference (Indicates whose goal this is - patient goal, practitioner goal, etc.)protected List
<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 final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for lifecycle-statusprotected Enumeration
<Goal.GoalLifecycleStatus> The state of the goal throughout its lifecycle.protected List
<Annotation> Any comments related to the goal.protected List
<CodeableConcept> Identifies the change (or lack of change) at the point when the status of the goal is assessed.Details of what's changed (or not changed).protected List
<Observation> The actual objects that are the target of the reference (Details of what's changed (or not changed).)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected CodeableConcept
Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.static final String
Search parameter: achievement-statusstatic final String
Search parameter: categorystatic final String
Search parameter: identifierstatic final String
Search parameter: lifecycle-statusstatic final String
Search parameter: patientstatic final String
Search parameter: start-datestatic final String
Search parameter: subjectstatic final String
Search parameter: target-dateprotected Type
The date or event after which the goal should begin being pursued.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for start-dateprotected DateType
Identifies when the current status.protected StringType
Captures the reason for the current status.protected Reference
Identifies the patient, group or organization for whom the goal is being established.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
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> Indicates what should be done by when.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for target-dateFields 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, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionGoal()
ConstructorGoal
(Enumeration<Goal.GoalLifecycleStatus> lifecycleStatus, CodeableConcept description, Reference subject) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadcopy()
void
copyValues
(Goal dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadBase[]
getProperty
(int hash, String name, boolean checkValid) getStart()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
hasStart()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAddresses
(List<Reference> theAddresses) setCategory
(List<CodeableConcept> theCategory) setDescription
(CodeableConcept value) setExpressedBy
(Reference value) setExpressedByTarget
(Resource value) setIdentifier
(List<Identifier> theIdentifier) setNote
(List<Annotation> theNote) setOutcomeCode
(List<CodeableConcept> theOutcomeCode) setOutcomeReference
(List<Reference> theOutcomeReference) setPriority
(CodeableConcept value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setStatusDate
(Date value) setStatusDateElement
(DateType value) setStatusReason
(String value) setStatusReasonElement
(StringType value) setSubject
(Reference value) setSubjectTarget
(Resource value) setTarget
(List<Goal.GoalTargetComponent> theTarget) protected Goal
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, 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, getIdPart, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
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
The state of the goal throughout its lifecycle. -
achievementStatus
Describes the progression, or lack thereof, towards the goal against the target. -
category
Indicates a category the goal falls within. -
priority
Identifies the mutually agreed level of importance associated with reaching/sustaining the goal. -
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
Identifies the patient, group or organization for whom the goal is being established. -
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
The date or event after which the goal should begin being pursued. -
target
Indicates what should be done by when. -
statusDate
Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc. -
statusReason
Captures the reason for the current status. -
expressedBy
Indicates whose goal this is - patient goal, practitioner goal, etc. -
expressedByTarget
The actual object that is the target of the reference (Indicates whose goal this is - patient goal, practitioner goal, etc.) -
addresses
The identified conditions and other health record elements that are intended to be addressed by the goal. -
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
Any comments related to the goal. -
outcomeCode
Identifies the change (or lack of change) at the point when the status of the goal is assessed. -
outcomeReference
Details of what's changed (or not changed). -
outcomeReferenceTarget
The actual objects that are the target of the reference (Details of what's changed (or not changed).) -
SP_IDENTIFIER
Search parameter: identifierDescription: External Ids for this goal
Type: token
Path: Goal.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External Ids for this goal
Type: token
Path: Goal.identifier
-
SP_LIFECYCLE_STATUS
Search parameter: lifecycle-statusDescription: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Type: token
Path: Goal.lifecycleStatus
- See Also:
-
LIFECYCLE_STATUS
Fluent Client search parameter constant for lifecycle-statusDescription: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Type: token
Path: Goal.lifecycleStatus
-
SP_ACHIEVEMENT_STATUS
Search parameter: achievement-statusDescription: in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Type: token
Path: Goal.achievementStatus
- See Also:
-
ACHIEVEMENT_STATUS
Fluent Client search parameter constant for achievement-statusDescription: in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Type: token
Path: Goal.achievementStatus
-
SP_PATIENT
Search parameter: patientDescription: Who this goal is intended for
Type: reference
Path: Goal.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Who this goal is intended for
Type: reference
Path: Goal.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Goal:patient". -
SP_SUBJECT
Search parameter: subjectDescription: Who this goal is intended for
Type: reference
Path: Goal.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: Who this goal is intended for
Type: reference
Path: Goal.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Goal:subject". -
SP_START_DATE
Search parameter: start-dateDescription: When goal pursuit begins
Type: date
Path: Goal.startDate
- See Also:
-
START_DATE
Fluent Client search parameter constant for start-dateDescription: When goal pursuit begins
Type: date
Path: Goal.startDate
-
SP_CATEGORY
Search parameter: categoryDescription: E.g. Treatment, dietary, behavioral, etc.
Type: token
Path: Goal.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: E.g. Treatment, dietary, behavioral, etc.
Type: token
Path: Goal.category
-
SP_TARGET_DATE
Search parameter: target-dateDescription: Reach goal on or before
Type: date
Path: Goal.target.dueDate
- See Also:
-
TARGET_DATE
Fluent Client search parameter constant for target-dateDescription: Reach goal on or before
Type: date
Path: Goal.target.dueDate
-
-
Constructor Details
-
Goal
public Goal()Constructor -
Goal
public Goal(Enumeration<Goal.GoalLifecycleStatus> lifecycleStatus, CodeableConcept description, Reference subject) Constructor
-
-
Method Details
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
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
-
hasLifecycleStatus
-
setLifecycleStatusElement
- 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
- Returns:
- The state of the goal throughout its lifecycle.
-
setLifecycleStatus
- Parameters:
value
- The state of the goal throughout its lifecycle.
-
getAchievementStatus
- Returns:
achievementStatus
(Describes the progression, or lack thereof, towards the goal against the target.)
-
hasAchievementStatus
-
setAchievementStatus
- Parameters:
value
-achievementStatus
(Describes the progression, or lack thereof, towards the goal against the target.)
-
getCategory
- Returns:
category
(Indicates a category the goal falls within.)
-
setCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist
-
getPriority
- Returns:
priority
(Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.)
-
hasPriority
-
setPriority
- Parameters:
value
-priority
(Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.)
-
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
-
setDescription
- 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
- Returns:
subject
(Identifies the patient, group or organization for whom the goal is being established.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(Identifies the patient, group or organization for whom the goal is being established.)
-
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
- 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
- Returns:
start
(The date or event after which the goal should begin being pursued.)
-
getStartDateType
- Returns:
start
(The date or event after which the goal should begin being pursued.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStartDateType
-
getStartCodeableConcept
- Returns:
start
(The date or event after which the goal should begin being pursued.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStartCodeableConcept
-
hasStart
-
setStart
- Parameters:
value
-start
(The date or event after which the goal should begin being pursued.)
-
getTarget
- Returns:
target
(Indicates what should be done by when.)
-
setTarget
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTarget
-
addTarget
-
addTarget
-
getTargetFirstRep
- Returns:
- The first repetition of repeating field
target
, creating it if it does not already exist
-
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
-
hasStatusDate
-
setStatusDateElement
- 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
- Returns:
- Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
-
setStatusDate
- Parameters:
value
- Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
-
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
-
hasStatusReason
-
setStatusReasonElement
- 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
- Returns:
- Captures the reason for the current status.
-
setStatusReason
- Parameters:
value
- Captures the reason for the current status.
-
getExpressedBy
- Returns:
expressedBy
(Indicates whose goal this is - patient goal, practitioner goal, etc.)
-
hasExpressedBy
-
setExpressedBy
- Parameters:
value
-expressedBy
(Indicates whose goal this is - patient goal, practitioner goal, etc.)
-
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
- 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
- Returns:
addresses
(The identified conditions and other health record elements that are intended to be addressed by the goal.)
-
setAddresses
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAddresses
-
addAddresses
-
addAddresses
-
getAddressesFirstRep
- Returns:
- The first repetition of repeating field
addresses
, creating it if it does not already exist
-
getAddressesTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getNote
- Returns:
note
(Any comments related to the goal.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
getOutcomeCode
- Returns:
outcomeCode
(Identifies the change (or lack of change) at the point when the status of the goal is assessed.)
-
setOutcomeCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasOutcomeCode
-
addOutcomeCode
-
addOutcomeCode
-
getOutcomeCodeFirstRep
- Returns:
- The first repetition of repeating field
outcomeCode
, creating it if it does not already exist
-
getOutcomeReference
- Returns:
outcomeReference
(Details of what's changed (or not changed).)
-
setOutcomeReference
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasOutcomeReference
-
addOutcomeReference
-
addOutcomeReference
-
getOutcomeReferenceFirstRep
- Returns:
- The first repetition of repeating field
outcomeReference
, creating it if it does not already exist
-
getOutcomeReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addOutcomeReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-