Class PlanDefinition.Goal
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.PlanDefinition.Goal
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- PlanDefinition
public static class PlanDefinition.Goal extends BackboneElement
A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPlanDefinition.Goal.Builderstatic classPlanDefinition.Goal.TargetIndicates what should be done and within what timeframe.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(java.lang.String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static PlanDefinition.Goal.Builderbuilder()booleanequals(java.lang.Object obj)java.util.List<CodeableConcept>getAddresses()Identifies problems, conditions, issues, or concerns the goal is intended to address.CodeableConceptgetCategory()Indicates a category the goal falls within.CodeableConceptgetDescription()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".java.util.List<RelatedArtifact>getDocumentation()Didactic or other informational resources associated with the goal that provide further supporting information about the goal.CodeableConceptgetPriority()Identifies the expected level of importance associated with reaching/sustaining the defined goal.CodeableConceptgetStart()The event after which the goal should begin being pursued.java.util.List<PlanDefinition.Goal.Target>getTarget()Indicates what should be done and within what timeframe.booleanhasChildren()inthashCode()PlanDefinition.Goal.BuildertoBuilder()Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getCategory
public CodeableConcept getCategory()
Indicates a category the goal falls within.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getDescription
public CodeableConcept getDescription()
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".- Returns:
- An immutable object of type
CodeableConceptthat is non-null.
-
getPriority
public CodeableConcept getPriority()
Identifies the expected level of importance associated with reaching/sustaining the defined goal.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getStart
public CodeableConcept getStart()
The event after which the goal should begin being pursued.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getAddresses
public java.util.List<CodeableConcept> getAddresses()
Identifies problems, conditions, issues, or concerns the goal is intended to address.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat may be empty.
-
getDocumentation
public java.util.List<RelatedArtifact> getDocumentation()
Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.- Returns:
- An unmodifiable list containing immutable objects of type
RelatedArtifactthat may be empty.
-
getTarget
public java.util.List<PlanDefinition.Goal.Target> getTarget()
Indicates what should be done and within what timeframe.- Returns:
- An unmodifiable list containing immutable objects of type
PlanDefinition.Goal.Targetthat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toBuilder
public PlanDefinition.Goal.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static PlanDefinition.Goal.Builder builder()
-
-