Class AdministrableProductDefinition.RouteOfAdministration
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.AdministrableProductDefinition.RouteOfAdministration
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- AdministrableProductDefinition
public static class AdministrableProductDefinition.RouteOfAdministration extends BackboneElement
The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAdministrableProductDefinition.RouteOfAdministration.Builderstatic classAdministrableProductDefinition.RouteOfAdministration.TargetSpeciesA species for which this route applies.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(java.lang.String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static AdministrableProductDefinition.RouteOfAdministration.Builderbuilder()booleanequals(java.lang.Object obj)CodeableConceptgetCode()Coded expression for the route.QuantitygetFirstDose()The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.QuantitygetMaxDosePerDay()The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.RatiogetMaxDosePerTreatmentPeriod()The maximum dose per treatment period that can be administered.QuantitygetMaxSingleDose()The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.DurationgetMaxTreatmentPeriod()The maximum treatment period during which the product can be administered.java.util.List<AdministrableProductDefinition.RouteOfAdministration.TargetSpecies>getTargetSpecies()A species for which this route applies.booleanhasChildren()inthashCode()AdministrableProductDefinition.RouteOfAdministration.BuildertoBuilder()Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getCode
public CodeableConcept getCode()
Coded expression for the route.- Returns:
- An immutable object of type
CodeableConceptthat is non-null.
-
getFirstDose
public Quantity getFirstDose()
The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.- Returns:
- An immutable object of type
Quantitythat may be null.
-
getMaxSingleDose
public Quantity getMaxSingleDose()
The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.- Returns:
- An immutable object of type
Quantitythat may be null.
-
getMaxDosePerDay
public Quantity getMaxDosePerDay()
The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.- Returns:
- An immutable object of type
Quantitythat may be null.
-
getMaxDosePerTreatmentPeriod
public Ratio getMaxDosePerTreatmentPeriod()
The maximum dose per treatment period that can be administered.- Returns:
- An immutable object of type
Ratiothat may be null.
-
getMaxTreatmentPeriod
public Duration getMaxTreatmentPeriod()
The maximum treatment period during which the product can be administered.- Returns:
- An immutable object of type
Durationthat may be null.
-
getTargetSpecies
public java.util.List<AdministrableProductDefinition.RouteOfAdministration.TargetSpecies> getTargetSpecies()
A species for which this route applies.- Returns:
- An unmodifiable list containing immutable objects of type
AdministrableProductDefinition.RouteOfAdministration.TargetSpeciesthat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toBuilder
public AdministrableProductDefinition.RouteOfAdministration.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static AdministrableProductDefinition.RouteOfAdministration.Builder builder()
-
-