Package org.hl7.fhir.r5.model

Class AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

AdministrableProductDefinition

public static class AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	code	Coded expression for the route.
protected Quantity	firstDose	The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.
protected Quantity	maxDosePerDay	The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.
protected Ratio	maxDosePerTreatmentPeriod	The maximum dose per treatment period that can be administered.
protected Quantity	maxSingleDose	The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.
protected Duration	maxTreatmentPeriod	The maximum treatment period during which the product can be administered.
protected List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent>	targetSpecies	A species for which this route applies.

Fields inherited from class org.hl7.fhir.r5.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
AdministrableProductDefinitionRouteOfAdministrationComponent()	Constructor
AdministrableProductDefinitionRouteOfAdministrationComponent(CodeableConcept code)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent	addTargetSpecies()
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	addTargetSpecies(AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent t)
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	copy()
void	copyValues(AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getCode()
Quantity	getFirstDose()
Quantity	getMaxDosePerDay()
Ratio	getMaxDosePerTreatmentPeriod()
Quantity	getMaxSingleDose()
Duration	getMaxTreatmentPeriod()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent>	getTargetSpecies()
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent	getTargetSpeciesFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCode()
boolean	hasFirstDose()
boolean	hasMaxDosePerDay()
boolean	hasMaxDosePerTreatmentPeriod()
boolean	hasMaxSingleDose()
boolean	hasMaxTreatmentPeriod()
boolean	hasTargetSpecies()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	setCode(CodeableConcept value)
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	setFirstDose(Quantity value)
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	setMaxDosePerDay(Quantity value)
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	setMaxDosePerTreatmentPeriod(Ratio value)
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	setMaxSingleDose(Quantity value)
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	setMaxTreatmentPeriod(Duration value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	setTargetSpecies(List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent> theTargetSpecies)

Methods inherited from class org.hl7.fhir.r5.model.BackboneElement

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionValue, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

code

protected CodeableConcept code

Coded expression for the route.

firstDose

protected Quantity firstDose

The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.

maxSingleDose

protected Quantity maxSingleDose

The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.

maxDosePerDay

protected Quantity maxDosePerDay

The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.

maxDosePerTreatmentPeriod

protected Ratio maxDosePerTreatmentPeriod

The maximum dose per treatment period that can be administered.

maxTreatmentPeriod

protected Duration maxTreatmentPeriod

The maximum treatment period during which the product can be administered.

targetSpecies

protected List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent> targetSpecies

A species for which this route applies.

Constructor Details

AdministrableProductDefinitionRouteOfAdministrationComponent

public AdministrableProductDefinitionRouteOfAdministrationComponent()

Constructor

AdministrableProductDefinitionRouteOfAdministrationComponent

public AdministrableProductDefinitionRouteOfAdministrationComponent(CodeableConcept code)

Constructor

Method Details

getCode

public CodeableConcept getCode()

Returns:

code (Coded expression for the route.)

hasCode

public boolean hasCode()

setCode

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent setCode(CodeableConcept value)

Parameters:

value - code (Coded expression for the route.)

getFirstDose

public Quantity getFirstDose()

Returns:

firstDose (The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.)

hasFirstDose

public boolean hasFirstDose()

setFirstDose

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent setFirstDose(Quantity value)

Parameters:

value - firstDose (The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.)

getMaxSingleDose

public Quantity getMaxSingleDose()

Returns:

maxSingleDose (The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.)

hasMaxSingleDose

public boolean hasMaxSingleDose()

setMaxSingleDose

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent setMaxSingleDose(Quantity value)

Parameters:

value - maxSingleDose (The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.)

getMaxDosePerDay

public Quantity getMaxDosePerDay()

Returns:

maxDosePerDay (The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.)

hasMaxDosePerDay

public boolean hasMaxDosePerDay()

setMaxDosePerDay

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent setMaxDosePerDay(Quantity value)

Parameters:

value - maxDosePerDay (The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.)

getMaxDosePerTreatmentPeriod

public Ratio getMaxDosePerTreatmentPeriod()

Returns:

maxDosePerTreatmentPeriod (The maximum dose per treatment period that can be administered.)

hasMaxDosePerTreatmentPeriod

public boolean hasMaxDosePerTreatmentPeriod()

setMaxDosePerTreatmentPeriod

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent setMaxDosePerTreatmentPeriod(Ratio value)

Parameters:

value - maxDosePerTreatmentPeriod (The maximum dose per treatment period that can be administered.)

getMaxTreatmentPeriod

public Duration getMaxTreatmentPeriod()

Returns:

maxTreatmentPeriod (The maximum treatment period during which the product can be administered.)

hasMaxTreatmentPeriod

public boolean hasMaxTreatmentPeriod()

setMaxTreatmentPeriod

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent setMaxTreatmentPeriod(Duration value)

Parameters:

value - maxTreatmentPeriod (The maximum treatment period during which the product can be administered.)

getTargetSpecies

public List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent> getTargetSpecies()

Returns:

targetSpecies (A species for which this route applies.)

setTargetSpecies

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent setTargetSpecies(List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent> theTargetSpecies)

Returns:

Returns a reference to this for easy method chaining

hasTargetSpecies

public boolean hasTargetSpecies()

addTargetSpecies

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent addTargetSpecies()

addTargetSpecies

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent addTargetSpecies(AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent t)

getTargetSpeciesFirstRep

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent getTargetSpeciesFirstRep()

Returns:

The first repetition of repeating field targetSpecies, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)