Package com.ibm.fhir.model.resource
Class MedicinalProductPharmaceutical.RouteOfAdministration
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.type.Element
-
- com.ibm.fhir.model.type.BackboneElement
-
- com.ibm.fhir.model.resource.MedicinalProductPharmaceutical.RouteOfAdministration
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- MedicinalProductPharmaceutical
public static class MedicinalProductPharmaceutical.RouteOfAdministration extends BackboneElement
The path by which the pharmaceutical product is taken into or makes contact with the body.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMedicinalProductPharmaceutical.RouteOfAdministration.Builderstatic classMedicinalProductPharmaceutical.RouteOfAdministration.TargetSpeciesA species for which this route applies.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static MedicinalProductPharmaceutical.RouteOfAdministration.Builderbuilder()booleanequals(Object obj)CodeableConceptgetCode()Coded expression for the route.QuantitygetFirstDose()The first dose (dose quantity) administered in humans can be specified, for a product under investigation, 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 as per the protocol referenced in the clinical trial authorisation.RatiogetMaxDosePerTreatmentPeriod()The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.QuantitygetMaxSingleDose()The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement.DurationgetMaxTreatmentPeriod()The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.List<MedicinalProductPharmaceutical.RouteOfAdministration.TargetSpecies>getTargetSpecies()A species for which this route applies.booleanhasChildren()inthashCode()MedicinalProductPharmaceutical.RouteOfAdministration.BuildertoBuilder()Create a new Builder from the contents of this Element-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement
getModifierExtension
-
-
-
-
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 in humans can be specified, for a product under investigation, 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 as per the protocol of a clinical trial can be 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 as per the protocol referenced in the clinical trial authorisation.- Returns:
- An immutable object of type
Quantitythat may be null.
-
getMaxDosePerTreatmentPeriod
public Ratio getMaxDosePerTreatmentPeriod()
The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.- Returns:
- An immutable object of type
Ratiothat may be null.
-
getMaxTreatmentPeriod
public Duration getMaxTreatmentPeriod()
The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.- Returns:
- An immutable object of type
Durationthat may be null.
-
getTargetSpecies
public List<MedicinalProductPharmaceutical.RouteOfAdministration.TargetSpecies> getTargetSpecies()
A species for which this route applies.- Returns:
- An unmodifiable list containing immutable objects of type
MedicinalProductPharmaceutical.RouteOfAdministration.TargetSpeciesthat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(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
-
toBuilder
public MedicinalProductPharmaceutical.RouteOfAdministration.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static MedicinalProductPharmaceutical.RouteOfAdministration.Builder builder()
-
-