Class Observation.ReferenceRange.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.ReferenceRange.Builder
-
- Enclosing class:
- Observation.ReferenceRange
public static class Observation.ReferenceRange.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.ReferenceRange.Builder
age(Range age)
The age at which this reference range is applicable.Observation.ReferenceRange.Builder
appliesTo(java.util.Collection<CodeableConcept> appliesTo)
Codes to indicate the target population this reference range applies to.Observation.ReferenceRange.Builder
appliesTo(CodeableConcept... appliesTo)
Codes to indicate the target population this reference range applies to.Observation.ReferenceRange
build()
Build theObservation.ReferenceRange
Observation.ReferenceRange.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.ReferenceRange.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Observation.ReferenceRange.Builder
from(Observation.ReferenceRange referenceRange)
Observation.ReferenceRange.Builder
high(SimpleQuantity high)
The value of the high bound of the reference range.Observation.ReferenceRange.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Observation.ReferenceRange.Builder
low(SimpleQuantity low)
The value of the low bound of the reference range.Observation.ReferenceRange.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.ReferenceRange.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.ReferenceRange.Builder
text(java.lang.String text)
Convenience method for settingtext
.Observation.ReferenceRange.Builder
text(String text)
Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation.Observation.ReferenceRange.Builder
type(CodeableConcept type)
Codes to indicate the what part of the targeted reference population it applies to.protected void
validate(Observation.ReferenceRange referenceRange)
-
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.ReferenceRange.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.ReferenceRange.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.ReferenceRange.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.ReferenceRange.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.ReferenceRange.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
-
low
public Observation.ReferenceRange.Builder low(SimpleQuantity low)
The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).- Parameters:
low
- Low Range, if relevant- Returns:
- A reference to this Builder instance
-
high
public Observation.ReferenceRange.Builder high(SimpleQuantity high)
The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).- Parameters:
high
- High Range, if relevant- Returns:
- A reference to this Builder instance
-
type
public Observation.ReferenceRange.Builder type(CodeableConcept type)
Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.- Parameters:
type
- Reference range qualifier- Returns:
- A reference to this Builder instance
-
appliesTo
public Observation.ReferenceRange.Builder appliesTo(CodeableConcept... appliesTo)
Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
appliesTo
- Reference range population- Returns:
- A reference to this Builder instance
-
appliesTo
public Observation.ReferenceRange.Builder appliesTo(java.util.Collection<CodeableConcept> appliesTo)
Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.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:
appliesTo
- Reference range population- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
age
public Observation.ReferenceRange.Builder age(Range age)
The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.- Parameters:
age
- Applicable age range, if relevant- Returns:
- A reference to this Builder instance
-
text
public Observation.ReferenceRange.Builder text(java.lang.String text)
Convenience method for settingtext
.- Parameters:
text
- Text based reference range in an observation- Returns:
- A reference to this Builder instance
- See Also:
text(org.linuxforhealth.fhir.model.type.String)
-
text
public Observation.ReferenceRange.Builder text(String text)
Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".- Parameters:
text
- Text based reference range in an observation- Returns:
- A reference to this Builder instance
-
build
public Observation.ReferenceRange build()
Build theObservation.ReferenceRange
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Observation.ReferenceRange
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid ReferenceRange per the base specification
-
validate
protected void validate(Observation.ReferenceRange referenceRange)
-
from
protected Observation.ReferenceRange.Builder from(Observation.ReferenceRange referenceRange)
-
-