
Package org.hl7.fhir.dstu3.model
Class MedicationAdministration.MedicationAdministrationDosageComponent
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.Element
-
- org.hl7.fhir.dstu3.model.BackboneElement
-
- org.hl7.fhir.dstu3.model.MedicationAdministration.MedicationAdministrationDosageComponent
-
- 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:
- MedicationAdministration
public static class MedicationAdministration.MedicationAdministrationDosageComponent extends BackboneElement implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected SimpleQuantity
dose
The amount of the medication given at one administration event.protected CodeableConcept
method
A coded value indicating the method by which the medication is intended to be or was introduced into or on the body.protected Type
rate
Identifies the speed with which the medication was or will be introduced into the patient.protected CodeableConcept
route
A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient.protected CodeableConcept
site
A coded specification of the anatomic site where the medication first entered the body.protected StringType
text
Free text dosage can be used for cases where the dosage administered is too complex to code.-
Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description MedicationAdministrationDosageComponent()
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension
-
Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
-
-
-
-
Field Detail
-
text
protected StringType 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.
-
site
protected CodeableConcept site
A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".
-
route
protected 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.
-
method
protected 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.
-
dose
protected 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.
-
rate
protected Type 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.
-
-
Constructor Detail
-
MedicationAdministrationDosageComponent
public MedicationAdministrationDosageComponent()
Constructor
-
-
Method Detail
-
getTextElement
public StringType getTextElement()
- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
-
hasTextElement
public boolean hasTextElement()
-
hasText
public boolean hasText()
-
setTextElement
public MedicationAdministration.MedicationAdministrationDosageComponent setTextElement(StringType value)
- Parameters:
value
-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.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
-
getText
public String getText()
- Returns:
- 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.
-
setText
public MedicationAdministration.MedicationAdministrationDosageComponent setText(String value)
- Parameters:
value
- 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.
-
getSite
public CodeableConcept getSite()
- Returns:
site
(A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".)
-
hasSite
public boolean hasSite()
-
setSite
public MedicationAdministration.MedicationAdministrationDosageComponent setSite(CodeableConcept value)
- Parameters:
value
-site
(A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".)
-
getRoute
public CodeableConcept getRoute()
- Returns:
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.)
-
hasRoute
public boolean hasRoute()
-
setRoute
public MedicationAdministration.MedicationAdministrationDosageComponent setRoute(CodeableConcept value)
- Parameters:
value
-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.)
-
getMethod
public CodeableConcept getMethod()
- Returns:
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.)
-
hasMethod
public boolean hasMethod()
-
setMethod
public MedicationAdministration.MedicationAdministrationDosageComponent setMethod(CodeableConcept value)
- Parameters:
value
-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.)
-
getDose
public SimpleQuantity getDose()
- Returns:
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.)
-
hasDose
public boolean hasDose()
-
setDose
public MedicationAdministration.MedicationAdministrationDosageComponent setDose(SimpleQuantity value)
- Parameters:
value
-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.)
-
getRate
public Type getRate()
- Returns:
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.)
-
getRateRatio
public Ratio getRateRatio() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
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.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasRateRatio
public boolean hasRateRatio()
-
getRateSimpleQuantity
public SimpleQuantity getRateSimpleQuantity() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
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.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasRateSimpleQuantity
public boolean hasRateSimpleQuantity()
-
hasRate
public boolean hasRate()
-
setRate
public MedicationAdministration.MedicationAdministrationDosageComponent setRate(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
- Parameters:
value
-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.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classBackboneElement
- 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 classBackboneElement
- 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 classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
public MedicationAdministration.MedicationAdministrationDosageComponent copy()
- Specified by:
copy
in classBackboneElement
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-
-