Class Observation.Component.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.Observation.Component.Builder
-
- Enclosing class:
- Observation.Component
public static class Observation.Component.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 Observation.Component
build()
Build theObservation.Component
Observation.Component.Builder
code(CodeableConcept code)
Describes what was observed.Observation.Component.Builder
dataAbsentReason(CodeableConcept dataAbsentReason)
Provides a reason why the expected value in the element Observation.component.value[x] is missing.Observation.Component.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.Observation.Component.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Observation.Component.Builder
from(Observation.Component component)
Observation.Component.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Observation.Component.Builder
interpretation(java.util.Collection<CodeableConcept> interpretation)
A categorical assessment of an observation value.Observation.Component.Builder
interpretation(CodeableConcept... interpretation)
A categorical assessment of an observation value.Observation.Component.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.Observation.Component.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.Observation.Component.Builder
referenceRange(java.util.Collection<Observation.ReferenceRange> referenceRange)
Guidance on how to interpret the value by comparison to a normal or recommended range.Observation.Component.Builder
referenceRange(Observation.ReferenceRange... referenceRange)
Guidance on how to interpret the value by comparison to a normal or recommended range.protected void
validate(Observation.Component component)
Observation.Component.Builder
value(java.lang.Boolean value)
Convenience method for settingvalue
with choice type Boolean.Observation.Component.Builder
value(java.lang.Integer value)
Convenience method for settingvalue
with choice type Integer.Observation.Component.Builder
value(java.lang.String value)
Convenience method for settingvalue
with choice type String.Observation.Component.Builder
value(java.time.LocalTime value)
Convenience method for settingvalue
with choice type Time.Observation.Component.Builder
value(Element value)
The information determined as a result of making the observation, if the information has a simple value.-
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 Observation.Component.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 Observation.Component.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 Observation.Component.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 Observation.Component.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 Observation.Component.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
-
code
public Observation.Component.Builder code(CodeableConcept code)
Describes what was observed. Sometimes this is called the observation "code".This element is required.
- Parameters:
code
- Type of component observation (code / type)- Returns:
- A reference to this Builder instance
-
value
public Observation.Component.Builder value(java.lang.String value)
Convenience method for settingvalue
with choice type String.- Parameters:
value
- Actual component result- Returns:
- A reference to this Builder instance
- See Also:
value(Element)
-
value
public Observation.Component.Builder value(java.lang.Boolean value)
Convenience method for settingvalue
with choice type Boolean.- Parameters:
value
- Actual component result- Returns:
- A reference to this Builder instance
- See Also:
value(Element)
-
value
public Observation.Component.Builder value(java.lang.Integer value)
Convenience method for settingvalue
with choice type Integer.- Parameters:
value
- Actual component result- Returns:
- A reference to this Builder instance
- See Also:
value(Element)
-
value
public Observation.Component.Builder value(java.time.LocalTime value)
Convenience method for settingvalue
with choice type Time.- Parameters:
value
- Actual component result- Returns:
- A reference to this Builder instance
- See Also:
value(Element)
-
value
public Observation.Component.Builder value(Element value)
The information determined as a result of making the observation, if the information has a simple value.This is a choice element with the following allowed types:
- Parameters:
value
- Actual component result- Returns:
- A reference to this Builder instance
-
dataAbsentReason
public Observation.Component.Builder dataAbsentReason(CodeableConcept dataAbsentReason)
Provides a reason why the expected value in the element Observation.component.value[x] is missing.- Parameters:
dataAbsentReason
- Why the component result is missing- Returns:
- A reference to this Builder instance
-
interpretation
public Observation.Component.Builder interpretation(CodeableConcept... interpretation)
A categorical assessment of an observation value. For example, high, low, normal.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
interpretation
- High, low, normal, etc.- Returns:
- A reference to this Builder instance
-
interpretation
public Observation.Component.Builder interpretation(java.util.Collection<CodeableConcept> interpretation)
A categorical assessment of an observation value. For example, high, low, normal.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:
interpretation
- High, low, normal, etc.- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
referenceRange
public Observation.Component.Builder referenceRange(Observation.ReferenceRange... referenceRange)
Guidance on how to interpret the value by comparison to a normal or recommended range.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
referenceRange
- Provides guide for interpretation of component result- Returns:
- A reference to this Builder instance
-
referenceRange
public Observation.Component.Builder referenceRange(java.util.Collection<Observation.ReferenceRange> referenceRange)
Guidance on how to interpret the value by comparison to a normal or recommended range.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:
referenceRange
- Provides guide for interpretation of component result- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public Observation.Component build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Observation.Component
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Component per the base specification
-
validate
protected void validate(Observation.Component component)
-
from
protected Observation.Component.Builder from(Observation.Component component)
-
-