Class MedicationAdministration.Dosage.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.MedicationAdministration.Dosage.Builder
-
- Enclosing class:
- MedicationAdministration.Dosage
public static class MedicationAdministration.Dosage.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 MedicationAdministration.Dosage
build()
Build theMedicationAdministration.Dosage
MedicationAdministration.Dosage.Builder
dose(SimpleQuantity dose)
The amount of the medication given at one administration event.MedicationAdministration.Dosage.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.MedicationAdministration.Dosage.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected MedicationAdministration.Dosage.Builder
from(MedicationAdministration.Dosage dosage)
MedicationAdministration.Dosage.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).MedicationAdministration.Dosage.Builder
method(CodeableConcept method)
A coded value indicating the method by which the medication is intended to be or was introduced into or on the body.MedicationAdministration.Dosage.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.MedicationAdministration.Dosage.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.MedicationAdministration.Dosage.Builder
rate(Element rate)
Identifies the speed with which the medication was or will be introduced into the patient.MedicationAdministration.Dosage.Builder
route(CodeableConcept route)
A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient.MedicationAdministration.Dosage.Builder
site(CodeableConcept site)
A coded specification of the anatomic site where the medication first entered the body.MedicationAdministration.Dosage.Builder
text(java.lang.String text)
Convenience method for settingtext
.MedicationAdministration.Dosage.Builder
text(String text)
Free text dosage can be used for cases where the dosage administered is too complex to code.protected void
validate(MedicationAdministration.Dosage dosage)
-
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 MedicationAdministration.Dosage.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 MedicationAdministration.Dosage.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 MedicationAdministration.Dosage.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 MedicationAdministration.Dosage.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 MedicationAdministration.Dosage.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
-
text
public MedicationAdministration.Dosage.Builder text(java.lang.String text)
Convenience method for settingtext
.- Parameters:
text
- Free text dosage instructions e.g. SIG- Returns:
- A reference to this Builder instance
- See Also:
text(org.linuxforhealth.fhir.model.type.String)
-
text
public MedicationAdministration.Dosage.Builder text(String text)
Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.- Parameters:
text
- Free text dosage instructions e.g. SIG- Returns:
- A reference to this Builder instance
-
site
public MedicationAdministration.Dosage.Builder site(CodeableConcept site)
A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".- Parameters:
site
- Body site administered to- Returns:
- A reference to this Builder instance
-
route
public MedicationAdministration.Dosage.Builder route(CodeableConcept route)
A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.- Parameters:
route
- Path of substance into body- Returns:
- A reference to this Builder instance
-
method
public MedicationAdministration.Dosage.Builder method(CodeableConcept method)
A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.- Parameters:
method
- How drug was administered- Returns:
- A reference to this Builder instance
-
dose
public MedicationAdministration.Dosage.Builder dose(SimpleQuantity dose)
The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.- Parameters:
dose
- Amount of medication per dose- Returns:
- A reference to this Builder instance
-
rate
public MedicationAdministration.Dosage.Builder rate(Element rate)
Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.This is a choice element with the following allowed types:
- Parameters:
rate
- Dose quantity per unit of time- Returns:
- A reference to this Builder instance
-
build
public MedicationAdministration.Dosage build()
Build theMedicationAdministration.Dosage
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
MedicationAdministration.Dosage
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Dosage per the base specification
-
validate
protected void validate(MedicationAdministration.Dosage dosage)
-
from
protected MedicationAdministration.Dosage.Builder from(MedicationAdministration.Dosage dosage)
-
-