Class AdministrableProductDefinition.RouteOfAdministration.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.AdministrableProductDefinition.RouteOfAdministration.Builder
-
- Enclosing class:
- AdministrableProductDefinition.RouteOfAdministration
public static class AdministrableProductDefinition.RouteOfAdministration.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 AdministrableProductDefinition.RouteOfAdministration
build()
AdministrableProductDefinition.RouteOfAdministration.Builder
code(CodeableConcept code)
Coded expression for the route.AdministrableProductDefinition.RouteOfAdministration.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.AdministrableProductDefinition.RouteOfAdministration.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.AdministrableProductDefinition.RouteOfAdministration.Builder
firstDose(Quantity firstDose)
The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.protected AdministrableProductDefinition.RouteOfAdministration.Builder
from(AdministrableProductDefinition.RouteOfAdministration routeOfAdministration)
AdministrableProductDefinition.RouteOfAdministration.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).AdministrableProductDefinition.RouteOfAdministration.Builder
maxDosePerDay(Quantity maxDosePerDay)
The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.AdministrableProductDefinition.RouteOfAdministration.Builder
maxDosePerTreatmentPeriod(Ratio maxDosePerTreatmentPeriod)
The maximum dose per treatment period that can be administered.AdministrableProductDefinition.RouteOfAdministration.Builder
maxSingleDose(Quantity maxSingleDose)
The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.AdministrableProductDefinition.RouteOfAdministration.Builder
maxTreatmentPeriod(Duration maxTreatmentPeriod)
The maximum treatment period during which the product can be administered.AdministrableProductDefinition.RouteOfAdministration.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.AdministrableProductDefinition.RouteOfAdministration.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.AdministrableProductDefinition.RouteOfAdministration.Builder
targetSpecies(java.util.Collection<AdministrableProductDefinition.RouteOfAdministration.TargetSpecies> targetSpecies)
A species for which this route applies.AdministrableProductDefinition.RouteOfAdministration.Builder
targetSpecies(AdministrableProductDefinition.RouteOfAdministration.TargetSpecies... targetSpecies)
A species for which this route applies.protected void
validate(AdministrableProductDefinition.RouteOfAdministration routeOfAdministration)
-
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 AdministrableProductDefinition.RouteOfAdministration.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 AdministrableProductDefinition.RouteOfAdministration.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 AdministrableProductDefinition.RouteOfAdministration.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 AdministrableProductDefinition.RouteOfAdministration.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 AdministrableProductDefinition.RouteOfAdministration.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 AdministrableProductDefinition.RouteOfAdministration.Builder code(CodeableConcept code)
Coded expression for the route.This element is required.
- Parameters:
code
- Coded expression for the route- Returns:
- A reference to this Builder instance
-
firstDose
public AdministrableProductDefinition.RouteOfAdministration.Builder firstDose(Quantity firstDose)
The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.- Parameters:
firstDose
- The first dose (dose quantity) administered can be specified for the product- Returns:
- A reference to this Builder instance
-
maxSingleDose
public AdministrableProductDefinition.RouteOfAdministration.Builder maxSingleDose(Quantity maxSingleDose)
The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.- Parameters:
maxSingleDose
- The maximum single dose that can be administered- Returns:
- A reference to this Builder instance
-
maxDosePerDay
public AdministrableProductDefinition.RouteOfAdministration.Builder maxDosePerDay(Quantity maxDosePerDay)
The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.- Parameters:
maxDosePerDay
- The maximum dose quantity to be administered in any one 24-h period- Returns:
- A reference to this Builder instance
-
maxDosePerTreatmentPeriod
public AdministrableProductDefinition.RouteOfAdministration.Builder maxDosePerTreatmentPeriod(Ratio maxDosePerTreatmentPeriod)
The maximum dose per treatment period that can be administered.- Parameters:
maxDosePerTreatmentPeriod
- The maximum dose per treatment period that can be administered- Returns:
- A reference to this Builder instance
-
maxTreatmentPeriod
public AdministrableProductDefinition.RouteOfAdministration.Builder maxTreatmentPeriod(Duration maxTreatmentPeriod)
The maximum treatment period during which the product can be administered.- Parameters:
maxTreatmentPeriod
- The maximum treatment period during which the product can be administered- Returns:
- A reference to this Builder instance
-
targetSpecies
public AdministrableProductDefinition.RouteOfAdministration.Builder targetSpecies(AdministrableProductDefinition.RouteOfAdministration.TargetSpecies... targetSpecies)
A species for which this route applies.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
targetSpecies
- A species for which this route applies- Returns:
- A reference to this Builder instance
-
targetSpecies
public AdministrableProductDefinition.RouteOfAdministration.Builder targetSpecies(java.util.Collection<AdministrableProductDefinition.RouteOfAdministration.TargetSpecies> targetSpecies)
A species for which this route applies.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:
targetSpecies
- A species for which this route applies- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public AdministrableProductDefinition.RouteOfAdministration build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
AdministrableProductDefinition.RouteOfAdministration
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid RouteOfAdministration per the base specification
-
validate
protected void validate(AdministrableProductDefinition.RouteOfAdministration routeOfAdministration)
-
from
protected AdministrableProductDefinition.RouteOfAdministration.Builder from(AdministrableProductDefinition.RouteOfAdministration routeOfAdministration)
-
-