MedicationAdministration.MedicationAdministrationDosageComponent (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.Element
  - - org.hl7.fhir.dstu2016may.model.BackboneElement
    - - org.hl7.fhir.dstu2016may.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 and Description
`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 SimpleQuantity`	`quantity` The amount of the medication given at one administration event.
`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 Type`	`site` A coded specification of the anatomic site where the medication first entered the body.
`protected StringType`	`text` Free text dosage instructions can be used for cases where the instructions are too complex to code.

Fields inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.dstu2016may.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

MedicationAdministrationDosageComponent()
Constructor

Constructors
Constructor and Description
`MedicationAdministrationDosageComponent()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`MedicationAdministration.MedicationAdministrationDosageComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`CodeableConcept`	`getMethod()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`SimpleQuantity`	`getQuantity()`
`Type`	`getRate()`
`Range`	`getRateRange()`
`Ratio`	`getRateRatio()`
`CodeableConcept`	`getRoute()`
`Type`	`getSite()`
`CodeableConcept`	`getSiteCodeableConcept()`
`Reference`	`getSiteReference()`
`String`	`getText()`
`StringType`	`getTextElement()`
`boolean`	`hasMethod()`
`boolean`	`hasQuantity()`
`boolean`	`hasRate()`
`boolean`	`hasRateRange()`
`boolean`	`hasRateRatio()`
`boolean`	`hasRoute()`
`boolean`	`hasSite()`
`boolean`	`hasSiteCodeableConcept()`
`boolean`	`hasSiteReference()`
`boolean`	`hasText()`
`boolean`	`hasTextElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`MedicationAdministration.MedicationAdministrationDosageComponent`	`setMethod(CodeableConcept value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`MedicationAdministration.MedicationAdministrationDosageComponent`	`setQuantity(SimpleQuantity value)`
`MedicationAdministration.MedicationAdministrationDosageComponent`	`setRate(Type value)`
`MedicationAdministration.MedicationAdministrationDosageComponent`	`setRoute(CodeableConcept value)`
`MedicationAdministration.MedicationAdministrationDosageComponent`	`setSite(Type value)`
`MedicationAdministration.MedicationAdministrationDosageComponent`	`setText(String value)`
`MedicationAdministration.MedicationAdministrationDosageComponent`	`setTextElement(StringType value)`

Methods inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

Methods inherited from class org.hl7.fhir.dstu2016may.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, 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, hasFormatComment

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
  - text
```
protected StringType text
```
    Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.
  - site
```
protected Type 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.
  - quantity
```
protected SimpleQuantity quantity
```
    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. Currently we do not specify a default of '1' in the denominator, but this is being discussed. 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 instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.). 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 instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.). 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 instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.
  - setText
```
public MedicationAdministration.MedicationAdministrationDosageComponent setText(String value)
```
    Parameters:
    
    value - Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.
  - getSite
```
public Type getSite()
```
    Returns:
    
    site (A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".)
  - getSiteCodeableConcept
```
public CodeableConcept getSiteCodeableConcept()
                                       throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    site (A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasSiteCodeableConcept
```
public boolean hasSiteCodeableConcept()
```
  - getSiteReference
```
public Reference getSiteReference()
                           throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    site (A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasSiteReference
```
public boolean hasSiteReference()
```
  - hasSite
```
public boolean hasSite()
```
  - setSite
```
public MedicationAdministration.MedicationAdministrationDosageComponent setSite(Type 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.)
  - getQuantity
```
public SimpleQuantity getQuantity()
```
    Returns:
    
    quantity (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.)
  - hasQuantity
```
public boolean hasQuantity()
```
  - setQuantity
```
public MedicationAdministration.MedicationAdministrationDosageComponent setQuantity(SimpleQuantity value)
```
    Parameters:
    
    value - quantity (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. Currently we do not specify a default of '1' in the denominator, but this is being discussed. 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. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasRateRatio
```
public boolean hasRateRatio()
```
  - getRateRange
```
public Range getRateRange()
                   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. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasRateRange
```
public boolean hasRateRange()
```
  - hasRate
```
public boolean hasRate()
```
  - setRate
```
public MedicationAdministration.MedicationAdministrationDosageComponent setRate(Type value)
```
    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. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class BackboneElement
  - 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 void 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 void 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
  - 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 MedicationAdministration.MedicationAdministrationDosageComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - 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()
```
    Overrides:
    
    fhirType in class BackboneElement

Class MedicationAdministration.MedicationAdministrationDosageComponent

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

text

site

route

method

quantity

rate

Constructor Detail

MedicationAdministrationDosageComponent

Method Detail

getTextElement

hasTextElement

hasText

setTextElement

getText

setText

getSite

getSiteCodeableConcept

hasSiteCodeableConcept

getSiteReference

hasSiteReference

hasSite

setSite

getRoute

hasRoute

setRoute

getMethod

hasMethod

setMethod

getQuantity

hasQuantity

setQuantity

getRate

getRateRatio

hasRateRatio

getRateRange

hasRateRange

hasRate

setRate

listChildren

getProperty

setProperty

setProperty

makeProperty

addChild

copy

equalsDeep

equalsShallow

isEmpty

fhirType