Class PlanDefinition.Goal.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.PlanDefinition.Goal.Builder
-
- Enclosing class:
- PlanDefinition.Goal
public static class PlanDefinition.Goal.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PlanDefinition.Goal.Builder
addresses(java.util.Collection<CodeableConcept> addresses)
Identifies problems, conditions, issues, or concerns the goal is intended to address.PlanDefinition.Goal.Builder
addresses(CodeableConcept... addresses)
Identifies problems, conditions, issues, or concerns the goal is intended to address.PlanDefinition.Goal
build()
Build thePlanDefinition.Goal
PlanDefinition.Goal.Builder
category(CodeableConcept category)
Indicates a category the goal falls within.PlanDefinition.Goal.Builder
description(CodeableConcept 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".PlanDefinition.Goal.Builder
documentation(java.util.Collection<RelatedArtifact> documentation)
Didactic or other informational resources associated with the goal that provide further supporting information about the goal.PlanDefinition.Goal.Builder
documentation(RelatedArtifact... documentation)
Didactic or other informational resources associated with the goal that provide further supporting information about the goal.PlanDefinition.Goal.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.PlanDefinition.Goal.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected PlanDefinition.Goal.Builder
from(PlanDefinition.Goal goal)
PlanDefinition.Goal.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).PlanDefinition.Goal.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.PlanDefinition.Goal.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.PlanDefinition.Goal.Builder
priority(CodeableConcept priority)
Identifies the expected level of importance associated with reaching/sustaining the defined goal.PlanDefinition.Goal.Builder
start(CodeableConcept start)
The event after which the goal should begin being pursued.PlanDefinition.Goal.Builder
target(java.util.Collection<PlanDefinition.Goal.Target> target)
Indicates what should be done and within what timeframe.PlanDefinition.Goal.Builder
target(PlanDefinition.Goal.Target... target)
Indicates what should be done and within what timeframe.protected void
validate(PlanDefinition.Goal goal)
-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public PlanDefinition.Goal.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public PlanDefinition.Goal.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public PlanDefinition.Goal.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public PlanDefinition.Goal.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public PlanDefinition.Goal.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
category
public PlanDefinition.Goal.Builder category(CodeableConcept category)
Indicates a category the goal falls within.- Parameters:
category
- E.g. Treatment, dietary, behavioral- Returns:
- A reference to this Builder instance
-
description
public PlanDefinition.Goal.Builder description(CodeableConcept 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".This element is required.
- Parameters:
description
- Code or text describing the goal- Returns:
- A reference to this Builder instance
-
priority
public PlanDefinition.Goal.Builder priority(CodeableConcept priority)
Identifies the expected level of importance associated with reaching/sustaining the defined goal.- Parameters:
priority
- high-priority | medium-priority | low-priority- Returns:
- A reference to this Builder instance
-
start
public PlanDefinition.Goal.Builder start(CodeableConcept start)
The event after which the goal should begin being pursued.- Parameters:
start
- When goal pursuit begins- Returns:
- A reference to this Builder instance
-
addresses
public PlanDefinition.Goal.Builder addresses(CodeableConcept... addresses)
Identifies problems, conditions, issues, or concerns the goal is intended to address.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
addresses
- What does the goal address- Returns:
- A reference to this Builder instance
-
addresses
public PlanDefinition.Goal.Builder addresses(java.util.Collection<CodeableConcept> addresses)
Identifies problems, conditions, issues, or concerns the goal is intended to address.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
addresses
- What does the goal address- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
documentation
public PlanDefinition.Goal.Builder documentation(RelatedArtifact... documentation)
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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
documentation
- Supporting documentation for the goal- Returns:
- A reference to this Builder instance
-
documentation
public PlanDefinition.Goal.Builder documentation(java.util.Collection<RelatedArtifact> documentation)
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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
documentation
- Supporting documentation for the goal- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
target
public PlanDefinition.Goal.Builder target(PlanDefinition.Goal.Target... target)
Indicates what should be done and within what timeframe.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
target
- Target outcome for the goal- Returns:
- A reference to this Builder instance
-
target
public PlanDefinition.Goal.Builder target(java.util.Collection<PlanDefinition.Goal.Target> target)
Indicates what should be done and within what timeframe.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
target
- Target outcome for the goal- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public PlanDefinition.Goal build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
PlanDefinition.Goal
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Goal per the base specification
-
validate
protected void validate(PlanDefinition.Goal goal)
-
from
protected PlanDefinition.Goal.Builder from(PlanDefinition.Goal goal)
-
-