Class Medication.Ingredient.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.Medication.Ingredient.Builder
-
- Enclosing class:
- Medication.Ingredient
public static class Medication.Ingredient.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 Medication.Ingredient
build()
Build theMedication.Ingredient
Medication.Ingredient.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.Medication.Ingredient.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Medication.Ingredient.Builder
from(Medication.Ingredient ingredient)
Medication.Ingredient.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Medication.Ingredient.Builder
isActive(java.lang.Boolean isActive)
Convenience method for settingisActive
.Medication.Ingredient.Builder
isActive(Boolean isActive)
Indication of whether this ingredient affects the therapeutic action of the drug.Medication.Ingredient.Builder
item(Element item)
The actual ingredient - either a substance (simple ingredient) or another medication of a medication.Medication.Ingredient.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.Medication.Ingredient.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.Medication.Ingredient.Builder
strength(Ratio strength)
Specifies how many (or how much) of the items there are in this Medication.protected void
validate(Medication.Ingredient ingredient)
-
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 Medication.Ingredient.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 Medication.Ingredient.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 Medication.Ingredient.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 Medication.Ingredient.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 Medication.Ingredient.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
-
item
public Medication.Ingredient.Builder item(Element item)
The actual ingredient - either a substance (simple ingredient) or another medication of a medication.This element is required.
This is a choice element with the following allowed types:
When of typeReference
, the allowed resource types for this reference are:- Parameters:
item
- The actual ingredient or content- Returns:
- A reference to this Builder instance
-
isActive
public Medication.Ingredient.Builder isActive(java.lang.Boolean isActive)
Convenience method for settingisActive
.- Parameters:
isActive
- Active ingredient indicator- Returns:
- A reference to this Builder instance
- See Also:
isActive(org.linuxforhealth.fhir.model.type.Boolean)
-
isActive
public Medication.Ingredient.Builder isActive(Boolean isActive)
Indication of whether this ingredient affects the therapeutic action of the drug.- Parameters:
isActive
- Active ingredient indicator- Returns:
- A reference to this Builder instance
-
strength
public Medication.Ingredient.Builder strength(Ratio strength)
Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.- Parameters:
strength
- Quantity of ingredient present- Returns:
- A reference to this Builder instance
-
build
public Medication.Ingredient build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Medication.Ingredient
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Ingredient per the base specification
-
validate
protected void validate(Medication.Ingredient ingredient)
-
from
protected Medication.Ingredient.Builder from(Medication.Ingredient ingredient)
-
-