Class CarePlan.Activity.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.CarePlan.Activity.Builder
-
- Enclosing class:
- CarePlan.Activity
public static class CarePlan.Activity.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 CarePlan.Activity
build()
Build theCarePlan.Activity
CarePlan.Activity.Builder
detail(CarePlan.Activity.Detail detail)
A simple summary of a planned activity suitable for a general care plan system (e.g.CarePlan.Activity.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.CarePlan.Activity.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected CarePlan.Activity.Builder
from(CarePlan.Activity activity)
CarePlan.Activity.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).CarePlan.Activity.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.CarePlan.Activity.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.CarePlan.Activity.Builder
outcomeCodeableConcept(java.util.Collection<CodeableConcept> outcomeCodeableConcept)
Identifies the outcome at the point when the status of the activity is assessed.CarePlan.Activity.Builder
outcomeCodeableConcept(CodeableConcept... outcomeCodeableConcept)
Identifies the outcome at the point when the status of the activity is assessed.CarePlan.Activity.Builder
outcomeReference(java.util.Collection<Reference> outcomeReference)
Details of the outcome or action resulting from the activity.CarePlan.Activity.Builder
outcomeReference(Reference... outcomeReference)
Details of the outcome or action resulting from the activity.CarePlan.Activity.Builder
progress(java.util.Collection<Annotation> progress)
Notes about the adherence/status/progress of the activity.CarePlan.Activity.Builder
progress(Annotation... progress)
Notes about the adherence/status/progress of the activity.CarePlan.Activity.Builder
reference(Reference reference)
The details of the proposed activity represented in a specific resource.protected void
validate(CarePlan.Activity activity)
-
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 CarePlan.Activity.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 CarePlan.Activity.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 CarePlan.Activity.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 CarePlan.Activity.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 CarePlan.Activity.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
-
outcomeCodeableConcept
public CarePlan.Activity.Builder outcomeCodeableConcept(CodeableConcept... outcomeCodeableConcept)
Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
outcomeCodeableConcept
- Results of the activity- Returns:
- A reference to this Builder instance
-
outcomeCodeableConcept
public CarePlan.Activity.Builder outcomeCodeableConcept(java.util.Collection<CodeableConcept> outcomeCodeableConcept)
Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).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:
outcomeCodeableConcept
- Results of the activity- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
outcomeReference
public CarePlan.Activity.Builder outcomeReference(Reference... outcomeReference)
Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan. activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
outcomeReference
- Appointment, Encounter, Procedure, etc.- Returns:
- A reference to this Builder instance
-
outcomeReference
public CarePlan.Activity.Builder outcomeReference(java.util.Collection<Reference> outcomeReference)
Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan. activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).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:
outcomeReference
- Appointment, Encounter, Procedure, etc.- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
progress
public CarePlan.Activity.Builder progress(Annotation... progress)
Notes about the adherence/status/progress of the activity.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
progress
- Comments about the activity status/progress- Returns:
- A reference to this Builder instance
-
progress
public CarePlan.Activity.Builder progress(java.util.Collection<Annotation> progress)
Notes about the adherence/status/progress of the activity.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:
progress
- Comments about the activity status/progress- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
reference
public CarePlan.Activity.Builder reference(Reference reference)
The details of the proposed activity represented in a specific resource.Allowed resource types for this reference:
- Parameters:
reference
- Activity details defined in specific resource- Returns:
- A reference to this Builder instance
-
detail
public CarePlan.Activity.Builder detail(CarePlan.Activity.Detail detail)
A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.- Parameters:
detail
- In-line definition of activity- Returns:
- A reference to this Builder instance
-
build
public CarePlan.Activity build()
Build theCarePlan.Activity
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
CarePlan.Activity
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Activity per the base specification
-
validate
protected void validate(CarePlan.Activity activity)
-
from
protected CarePlan.Activity.Builder from(CarePlan.Activity activity)
-
-