
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
Nested ClassesModifier and TypeClassDescriptionstatic enumstatic classstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionThe 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.TokenClientParamFluent Client search parameter constant for categoryprotected CodeableConceptHuman-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 ReferenceIndicates whose goal this is - patient goal, practitioner goal, etc.protected ResourceThe actual object that is the target of the reference (Indicates whose goal this is - patient goal, practitioner goal, etc.)protected List<Identifier> This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.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.ReferenceClientParamFluent Client search parameter constant for patientprotected CodeableConceptIdentifies the mutually agreed level of importance associated with reaching/sustaining the goal.static final StringSearch parameter: categorystatic final StringSearch parameter: identifierstatic final StringSearch parameter: patientstatic final StringSearch parameter: start-datestatic final StringSearch parameter: statusstatic final StringSearch parameter: subjectstatic final StringSearch parameter: target-dateprotected TypeThe date or event after which the goal should begin being pursued.static final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for start-dateprotected Enumeration<Goal.GoalStatus> Indicates whether the goal has been reached and is still considered relevant.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusprotected DateTypeIdentifies when the current status.protected StringTypeCaptures the reason for the current status.protected ReferenceIdentifies the patient, group or organization for whom the goal is being established.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for subjectprotected ResourceThe actual object that is the target of the reference (Identifies the patient, group or organization for whom the goal is being established.)protected Goal.GoalTargetComponentIndicates what should be done by when.static final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for target-dateFields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, metaFields 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_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionGoal()ConstructorGoal(Enumeration<Goal.GoalStatus> status, CodeableConcept description) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddNote()copy()booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getNamedProperty(int _hash, String _name, boolean _checkValid) getNote()Base[]getProperty(int hash, String name, boolean checkValid) getStart()String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanbooleanhasNote()booleanbooleanbooleanbooleanhasStart()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) 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) setStatus(Goal.GoalStatus value) setStatusDate(Date value) setStatusDateElement(DateType value) setStatusReason(String value) setStatusReasonElement(StringType value) setSubject(Reference value) setSubjectTarget(Resource value) protected GoalMethods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextMethods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). -
status
Indicates whether the goal has been reached and is still considered relevant. -
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_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
-
SP_STATUS
Search parameter: statusDescription: proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
Type: token
Path: Goal.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
Type: token
Path: Goal.status
-
-
Constructor Details
-
Goal
public Goal()Constructor -
Goal
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier(This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)
-
setIdentifier
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getStatusElement
- Returns:
status(Indicates whether the goal has been reached and is still considered relevant.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
- Parameters:
value-status(Indicates whether the goal has been reached and is still considered relevant.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- Indicates whether the goal has been reached and is still considered relevant.
-
setStatus
- Parameters:
value- Indicates whether the goal has been reached and is still considered relevant.
-
getCategory
- Returns:
category(Indicates a category the goal falls within.)
-
setCategory
- Returns:
- Returns a reference to
thisfor 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:
subjectThe 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-subjectThe 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.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getTarget
- Returns:
target(Indicates what should be done by when.)
-
hasTarget
-
setTarget
- Parameters:
value-target(Indicates what should be done by when.)
-
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:
expressedByThe 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-expressedByThe 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
thisfor easy method chaining
-
hasAddresses
-
addAddresses
-
addAddresses
-
getAddressesFirstRep
- Returns:
- The first repetition of repeating field
addresses, creating it if it does not already exist
-
getNote
- Returns:
note(Any comments related to the goal.)
-
setNote
- Returns:
- Returns a reference to
thisfor 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
thisfor 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
thisfor easy method chaining
-
hasOutcomeReference
-
addOutcomeReference
-
addOutcomeReference
-
getOutcomeReferenceFirstRep
- Returns:
- The first repetition of repeating field
outcomeReference, creating it if it does not already exist
-
listChildren
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
- Specified by:
copyin classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-