Package org.hl7.fhir.r4.model

Class MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.BackboneElement

org.hl7.fhir.r4.model.MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent

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:

MedicinalProductPharmaceutical

public static class MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

Serialized Form

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 in humans can be specified, for a product under investigation, 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 as per the protocol referenced in the clinical trial authorisation.
protected Ratio	maxDosePerTreatmentPeriod	The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.
protected Quantity	maxSingleDose	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.
protected Duration	maxTreatmentPeriod	The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.
protected List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent>	targetSpecies	A species for which this route applies.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
MedicinalProductPharmaceuticalRouteOfAdministrationComponent()	Constructor
MedicinalProductPharmaceuticalRouteOfAdministrationComponent(CodeableConcept code)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent	addTargetSpecies()
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	addTargetSpecies(MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent t)
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	copy()
void	copyValues(MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent 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<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent>	getTargetSpecies()
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent	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)
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	setCode(CodeableConcept value)
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	setFirstDose(Quantity value)
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	setMaxDosePerDay(Quantity value)
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	setMaxDosePerTreatmentPeriod(Ratio value)
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	setMaxSingleDose(Quantity value)
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	setMaxTreatmentPeriod(Duration value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	setTargetSpecies(List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent> theTargetSpecies)

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

addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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 Detail

code

protected CodeableConcept code

Coded expression for the route.

firstDose

protected Quantity firstDose

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.

maxSingleDose

protected Quantity maxSingleDose

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.

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 as per the protocol referenced in the clinical trial authorisation.

maxDosePerTreatmentPeriod

protected Ratio maxDosePerTreatmentPeriod

The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.

maxTreatmentPeriod

protected Duration maxTreatmentPeriod

The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.

targetSpecies

protected List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent> targetSpecies

A species for which this route applies.

Constructor Detail

MedicinalProductPharmaceuticalRouteOfAdministrationComponent

public MedicinalProductPharmaceuticalRouteOfAdministrationComponent()

Constructor

MedicinalProductPharmaceuticalRouteOfAdministrationComponent

public MedicinalProductPharmaceuticalRouteOfAdministrationComponent(CodeableConcept code)

Constructor

Method Detail

getCode

public CodeableConcept getCode()

Returns:

code (Coded expression for the route.)

hasCode

public boolean hasCode()

setCode

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent setCode(CodeableConcept value)

Parameters:

value - code (Coded expression for the route.)

getFirstDose

public Quantity getFirstDose()

Returns:

firstDose (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.)

hasFirstDose

public boolean hasFirstDose()

setFirstDose

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent setFirstDose(Quantity value)

Parameters:

value - firstDose (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.)

getMaxSingleDose

public Quantity getMaxSingleDose()

Returns:

maxSingleDose (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.)

hasMaxSingleDose

public boolean hasMaxSingleDose()

setMaxSingleDose

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent setMaxSingleDose(Quantity value)

Parameters:

value - maxSingleDose (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.)

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 as per the protocol referenced in the clinical trial authorisation.)

hasMaxDosePerDay

public boolean hasMaxDosePerDay()

setMaxDosePerDay

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent 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 as per the protocol referenced in the clinical trial authorisation.)

getMaxDosePerTreatmentPeriod

public Ratio getMaxDosePerTreatmentPeriod()

Returns:

maxDosePerTreatmentPeriod (The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.)

hasMaxDosePerTreatmentPeriod

public boolean hasMaxDosePerTreatmentPeriod()

setMaxDosePerTreatmentPeriod

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent setMaxDosePerTreatmentPeriod(Ratio value)

Parameters:

value - maxDosePerTreatmentPeriod (The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.)

getMaxTreatmentPeriod

public Duration getMaxTreatmentPeriod()

Returns:

maxTreatmentPeriod (The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.)

hasMaxTreatmentPeriod

public boolean hasMaxTreatmentPeriod()

setMaxTreatmentPeriod

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent setMaxTreatmentPeriod(Duration value)

Parameters:

value - maxTreatmentPeriod (The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.)

getTargetSpecies

public List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent> getTargetSpecies()

Returns:

targetSpecies (A species for which this route applies.)

setTargetSpecies

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent setTargetSpecies(List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent> theTargetSpecies)

Returns:

Returns a reference to this for easy method chaining

hasTargetSpecies

public boolean hasTargetSpecies()

addTargetSpecies

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent addTargetSpecies()

addTargetSpecies

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent addTargetSpecies(MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent t)

getTargetSpeciesFirstRep

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent getTargetSpeciesFirstRep()

Returns:

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

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

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 MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent 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