Class Specimen.Container.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.Specimen.Container.Builder
-
- Enclosing class:
- Specimen.Container
public static class Specimen.Container.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 Specimen.Container.Builder
additive(Element additive)
Introduced substance to preserve, maintain or enhance the specimen.Specimen.Container
build()
Build theSpecimen.Container
Specimen.Container.Builder
capacity(SimpleQuantity capacity)
The capacity (volume or other measure) the container may contain.Specimen.Container.Builder
description(java.lang.String description)
Convenience method for settingdescription
.Specimen.Container.Builder
description(String description)
Textual description of the container.Specimen.Container.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.Specimen.Container.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Specimen.Container.Builder
from(Specimen.Container container)
Specimen.Container.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Specimen.Container.Builder
identifier(java.util.Collection<Identifier> identifier)
Id for container.Specimen.Container.Builder
identifier(Identifier... identifier)
Id for container.Specimen.Container.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.Specimen.Container.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.Specimen.Container.Builder
specimenQuantity(SimpleQuantity specimenQuantity)
The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.Specimen.Container.Builder
type(CodeableConcept type)
The type of container associated with the specimen (e.g.protected void
validate(Specimen.Container container)
-
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 Specimen.Container.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 Specimen.Container.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 Specimen.Container.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 Specimen.Container.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 Specimen.Container.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
-
identifier
public Specimen.Container.Builder identifier(Identifier... identifier)
Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Id for the container- Returns:
- A reference to this Builder instance
-
identifier
public Specimen.Container.Builder identifier(java.util.Collection<Identifier> identifier)
Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.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:
identifier
- Id for the container- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
description
public Specimen.Container.Builder description(java.lang.String description)
Convenience method for settingdescription
.- Parameters:
description
- Textual description of the container- Returns:
- A reference to this Builder instance
- See Also:
description(org.linuxforhealth.fhir.model.type.String)
-
description
public Specimen.Container.Builder description(String description)
Textual description of the container.- Parameters:
description
- Textual description of the container- Returns:
- A reference to this Builder instance
-
type
public Specimen.Container.Builder type(CodeableConcept type)
The type of container associated with the specimen (e.g. slide, aliquot, etc.).- Parameters:
type
- Kind of container directly associated with specimen- Returns:
- A reference to this Builder instance
-
capacity
public Specimen.Container.Builder capacity(SimpleQuantity capacity)
The capacity (volume or other measure) the container may contain.- Parameters:
capacity
- Container volume or size- Returns:
- A reference to this Builder instance
-
specimenQuantity
public Specimen.Container.Builder specimenQuantity(SimpleQuantity specimenQuantity)
The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.- Parameters:
specimenQuantity
- Quantity of specimen within container- Returns:
- A reference to this Builder instance
-
additive
public Specimen.Container.Builder additive(Element additive)
Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.This is a choice element with the following allowed types:
When of typeReference
, the allowed resource types for this reference are:- Parameters:
additive
- Additive associated with container- Returns:
- A reference to this Builder instance
-
build
public Specimen.Container build()
Build theSpecimen.Container
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Specimen.Container
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Container per the base specification
-
validate
protected void validate(Specimen.Container container)
-
from
protected Specimen.Container.Builder from(Specimen.Container container)
-
-