Package org.hl7.fhir
Class MedicationDispenseDosageInstruction
- java.lang.Object
-
- org.hl7.fhir.Element
-
- org.hl7.fhir.BackboneElement
-
- org.hl7.fhir.MedicationDispenseDosageInstruction
-
- All Implemented Interfaces:
org.jvnet.jaxb2_commons.lang.Equals2,org.jvnet.jaxb2_commons.lang.HashCode2,org.jvnet.jaxb2_commons.lang.ToString2
public class MedicationDispenseDosageInstruction extends BackboneElement implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.Java class for MedicationDispense.DosageInstruction complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="MedicationDispense.DosageInstruction"> <complexContent> <extension base="{http://hl7.org/fhir}BackboneElement"> <sequence> <element name="text" type="{http://hl7.org/fhir}string" minOccurs="0"/> <element name="additionalInstructions" type="{http://hl7.org/fhir}CodeableConcept" minOccurs="0"/> <element name="timing" type="{http://hl7.org/fhir}Timing" minOccurs="0"/> <choice minOccurs="0"> <element name="asNeededBoolean" type="{http://hl7.org/fhir}boolean"/> <element name="asNeededCodeableConcept" type="{http://hl7.org/fhir}CodeableConcept"/> </choice> <choice minOccurs="0"> <element name="siteCodeableConcept" type="{http://hl7.org/fhir}CodeableConcept"/> <element name="siteReference" type="{http://hl7.org/fhir}Reference"/> </choice> <element name="route" type="{http://hl7.org/fhir}CodeableConcept" minOccurs="0"/> <element name="method" type="{http://hl7.org/fhir}CodeableConcept" minOccurs="0"/> <choice minOccurs="0"> <element name="doseRange" type="{http://hl7.org/fhir}Range"/> <element name="doseQuantity" type="{http://hl7.org/fhir}SimpleQuantity"/> </choice> <choice minOccurs="0"> <element name="rateRatio" type="{http://hl7.org/fhir}Ratio"/> <element name="rateRange" type="{http://hl7.org/fhir}Range"/> </choice> <element name="maxDosePerPeriod" type="{http://hl7.org/fhir}Ratio" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>
-
-
Field Summary
Fields Modifier and Type Field Description protected CodeableConceptadditionalInstructionsprotected BooleanasNeededBooleanprotected CodeableConceptasNeededCodeableConceptprotected SimpleQuantitydoseQuantityprotected RangedoseRangeprotected RatiomaxDosePerPeriodprotected CodeableConceptmethodprotected RangerateRangeprotected RatiorateRatioprotected CodeableConceptrouteprotected CodeableConceptsiteCodeableConceptprotected ReferencesiteReferenceprotected Stringtextprotected Timingtiming-
Fields inherited from class org.hl7.fhir.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description MedicationDispenseDosageInstruction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringBuilderappend(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, java.lang.StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)java.lang.StringBuilderappendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, java.lang.StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)booleanequals(java.lang.Object object)booleanequals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, java.lang.Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)CodeableConceptgetAdditionalInstructions()Gets the value of the additionalInstructions property.BooleangetAsNeededBoolean()Gets the value of the asNeededBoolean property.CodeableConceptgetAsNeededCodeableConcept()Gets the value of the asNeededCodeableConcept property.SimpleQuantitygetDoseQuantity()Gets the value of the doseQuantity property.RangegetDoseRange()Gets the value of the doseRange property.RatiogetMaxDosePerPeriod()Gets the value of the maxDosePerPeriod property.CodeableConceptgetMethod()Gets the value of the method property.RangegetRateRange()Gets the value of the rateRange property.RatiogetRateRatio()Gets the value of the rateRatio property.CodeableConceptgetRoute()Gets the value of the route property.CodeableConceptgetSiteCodeableConcept()Gets the value of the siteCodeableConcept property.ReferencegetSiteReference()Gets the value of the siteReference property.StringgetText()Gets the value of the text property.TiminggetTiming()Gets the value of the timing property.inthashCode()inthashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)voidsetAdditionalInstructions(CodeableConcept value)Sets the value of the additionalInstructions property.voidsetAsNeededBoolean(Boolean value)Sets the value of the asNeededBoolean property.voidsetAsNeededCodeableConcept(CodeableConcept value)Sets the value of the asNeededCodeableConcept property.voidsetDoseQuantity(SimpleQuantity value)Sets the value of the doseQuantity property.voidsetDoseRange(Range value)Sets the value of the doseRange property.voidsetMaxDosePerPeriod(Ratio value)Sets the value of the maxDosePerPeriod property.voidsetMethod(CodeableConcept value)Sets the value of the method property.voidsetRateRange(Range value)Sets the value of the rateRange property.voidsetRateRatio(Ratio value)Sets the value of the rateRatio property.voidsetRoute(CodeableConcept value)Sets the value of the route property.voidsetSiteCodeableConcept(CodeableConcept value)Sets the value of the siteCodeableConcept property.voidsetSiteReference(Reference value)Sets the value of the siteReference property.voidsetText(String value)Sets the value of the text property.voidsetTiming(Timing value)Sets the value of the timing property.java.lang.StringtoString()MedicationDispenseDosageInstructionwithAdditionalInstructions(CodeableConcept value)MedicationDispenseDosageInstructionwithAsNeededBoolean(Boolean value)MedicationDispenseDosageInstructionwithAsNeededCodeableConcept(CodeableConcept value)MedicationDispenseDosageInstructionwithDoseQuantity(SimpleQuantity value)MedicationDispenseDosageInstructionwithDoseRange(Range value)MedicationDispenseDosageInstructionwithExtension(java.util.Collection<Extension> values)MedicationDispenseDosageInstructionwithExtension(Extension... values)MedicationDispenseDosageInstructionwithId(java.lang.String value)MedicationDispenseDosageInstructionwithMaxDosePerPeriod(Ratio value)MedicationDispenseDosageInstructionwithMethod(CodeableConcept value)MedicationDispenseDosageInstructionwithModifierExtension(java.util.Collection<Extension> values)MedicationDispenseDosageInstructionwithModifierExtension(Extension... values)MedicationDispenseDosageInstructionwithRateRange(Range value)MedicationDispenseDosageInstructionwithRateRatio(Ratio value)MedicationDispenseDosageInstructionwithRoute(CodeableConcept value)MedicationDispenseDosageInstructionwithSiteCodeableConcept(CodeableConcept value)MedicationDispenseDosageInstructionwithSiteReference(Reference value)MedicationDispenseDosageInstructionwithText(String value)MedicationDispenseDosageInstructionwithTiming(Timing value)-
Methods inherited from class org.hl7.fhir.BackboneElement
getModifierExtension
-
Methods inherited from class org.hl7.fhir.Element
getExtension, getId, setId
-
-
-
-
Field Detail
-
text
protected String text
-
additionalInstructions
protected CodeableConcept additionalInstructions
-
timing
protected Timing timing
-
asNeededBoolean
protected Boolean asNeededBoolean
-
asNeededCodeableConcept
protected CodeableConcept asNeededCodeableConcept
-
siteCodeableConcept
protected CodeableConcept siteCodeableConcept
-
siteReference
protected Reference siteReference
-
route
protected CodeableConcept route
-
method
protected CodeableConcept method
-
doseRange
protected Range doseRange
-
doseQuantity
protected SimpleQuantity doseQuantity
-
rateRatio
protected Ratio rateRatio
-
rateRange
protected Range rateRange
-
maxDosePerPeriod
protected Ratio maxDosePerPeriod
-
-
Method Detail
-
getText
public String getText()
Gets the value of the text property.- Returns:
- possible object is
String
-
setText
public void setText(String value)
Sets the value of the text property.- Parameters:
value- allowed object isString
-
getAdditionalInstructions
public CodeableConcept getAdditionalInstructions()
Gets the value of the additionalInstructions property.- Returns:
- possible object is
CodeableConcept
-
setAdditionalInstructions
public void setAdditionalInstructions(CodeableConcept value)
Sets the value of the additionalInstructions property.- Parameters:
value- allowed object isCodeableConcept
-
getTiming
public Timing getTiming()
Gets the value of the timing property.- Returns:
- possible object is
Timing
-
setTiming
public void setTiming(Timing value)
Sets the value of the timing property.- Parameters:
value- allowed object isTiming
-
getAsNeededBoolean
public Boolean getAsNeededBoolean()
Gets the value of the asNeededBoolean property.- Returns:
- possible object is
Boolean
-
setAsNeededBoolean
public void setAsNeededBoolean(Boolean value)
Sets the value of the asNeededBoolean property.- Parameters:
value- allowed object isBoolean
-
getAsNeededCodeableConcept
public CodeableConcept getAsNeededCodeableConcept()
Gets the value of the asNeededCodeableConcept property.- Returns:
- possible object is
CodeableConcept
-
setAsNeededCodeableConcept
public void setAsNeededCodeableConcept(CodeableConcept value)
Sets the value of the asNeededCodeableConcept property.- Parameters:
value- allowed object isCodeableConcept
-
getSiteCodeableConcept
public CodeableConcept getSiteCodeableConcept()
Gets the value of the siteCodeableConcept property.- Returns:
- possible object is
CodeableConcept
-
setSiteCodeableConcept
public void setSiteCodeableConcept(CodeableConcept value)
Sets the value of the siteCodeableConcept property.- Parameters:
value- allowed object isCodeableConcept
-
getSiteReference
public Reference getSiteReference()
Gets the value of the siteReference property.- Returns:
- possible object is
Reference
-
setSiteReference
public void setSiteReference(Reference value)
Sets the value of the siteReference property.- Parameters:
value- allowed object isReference
-
getRoute
public CodeableConcept getRoute()
Gets the value of the route property.- Returns:
- possible object is
CodeableConcept
-
setRoute
public void setRoute(CodeableConcept value)
Sets the value of the route property.- Parameters:
value- allowed object isCodeableConcept
-
getMethod
public CodeableConcept getMethod()
Gets the value of the method property.- Returns:
- possible object is
CodeableConcept
-
setMethod
public void setMethod(CodeableConcept value)
Sets the value of the method property.- Parameters:
value- allowed object isCodeableConcept
-
getDoseRange
public Range getDoseRange()
Gets the value of the doseRange property.- Returns:
- possible object is
Range
-
setDoseRange
public void setDoseRange(Range value)
Sets the value of the doseRange property.- Parameters:
value- allowed object isRange
-
getDoseQuantity
public SimpleQuantity getDoseQuantity()
Gets the value of the doseQuantity property.- Returns:
- possible object is
SimpleQuantity
-
setDoseQuantity
public void setDoseQuantity(SimpleQuantity value)
Sets the value of the doseQuantity property.- Parameters:
value- allowed object isSimpleQuantity
-
getRateRatio
public Ratio getRateRatio()
Gets the value of the rateRatio property.- Returns:
- possible object is
Ratio
-
setRateRatio
public void setRateRatio(Ratio value)
Sets the value of the rateRatio property.- Parameters:
value- allowed object isRatio
-
getRateRange
public Range getRateRange()
Gets the value of the rateRange property.- Returns:
- possible object is
Range
-
setRateRange
public void setRateRange(Range value)
Sets the value of the rateRange property.- Parameters:
value- allowed object isRange
-
getMaxDosePerPeriod
public Ratio getMaxDosePerPeriod()
Gets the value of the maxDosePerPeriod property.- Returns:
- possible object is
Ratio
-
setMaxDosePerPeriod
public void setMaxDosePerPeriod(Ratio value)
Sets the value of the maxDosePerPeriod property.- Parameters:
value- allowed object isRatio
-
withText
public MedicationDispenseDosageInstruction withText(String value)
-
withAdditionalInstructions
public MedicationDispenseDosageInstruction withAdditionalInstructions(CodeableConcept value)
-
withTiming
public MedicationDispenseDosageInstruction withTiming(Timing value)
-
withAsNeededBoolean
public MedicationDispenseDosageInstruction withAsNeededBoolean(Boolean value)
-
withAsNeededCodeableConcept
public MedicationDispenseDosageInstruction withAsNeededCodeableConcept(CodeableConcept value)
-
withSiteCodeableConcept
public MedicationDispenseDosageInstruction withSiteCodeableConcept(CodeableConcept value)
-
withSiteReference
public MedicationDispenseDosageInstruction withSiteReference(Reference value)
-
withRoute
public MedicationDispenseDosageInstruction withRoute(CodeableConcept value)
-
withMethod
public MedicationDispenseDosageInstruction withMethod(CodeableConcept value)
-
withDoseRange
public MedicationDispenseDosageInstruction withDoseRange(Range value)
-
withDoseQuantity
public MedicationDispenseDosageInstruction withDoseQuantity(SimpleQuantity value)
-
withRateRatio
public MedicationDispenseDosageInstruction withRateRatio(Ratio value)
-
withRateRange
public MedicationDispenseDosageInstruction withRateRange(Range value)
-
withMaxDosePerPeriod
public MedicationDispenseDosageInstruction withMaxDosePerPeriod(Ratio value)
-
withModifierExtension
public MedicationDispenseDosageInstruction withModifierExtension(Extension... values)
- Overrides:
withModifierExtensionin classBackboneElement
-
withModifierExtension
public MedicationDispenseDosageInstruction withModifierExtension(java.util.Collection<Extension> values)
- Overrides:
withModifierExtensionin classBackboneElement
-
withExtension
public MedicationDispenseDosageInstruction withExtension(Extension... values)
- Overrides:
withExtensionin classBackboneElement
-
withExtension
public MedicationDispenseDosageInstruction withExtension(java.util.Collection<Extension> values)
- Overrides:
withExtensionin classBackboneElement
-
withId
public MedicationDispenseDosageInstruction withId(java.lang.String value)
- Overrides:
withIdin classBackboneElement
-
equals
public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, java.lang.Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)- Specified by:
equalsin interfaceorg.jvnet.jaxb2_commons.lang.Equals2- Overrides:
equalsin classBackboneElement
-
equals
public boolean equals(java.lang.Object object)
- Overrides:
equalsin classBackboneElement
-
hashCode
public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)- Specified by:
hashCodein interfaceorg.jvnet.jaxb2_commons.lang.HashCode2- Overrides:
hashCodein classBackboneElement
-
hashCode
public int hashCode()
- Overrides:
hashCodein classBackboneElement
-
toString
public java.lang.String toString()
- Overrides:
toStringin classBackboneElement
-
append
public java.lang.StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, java.lang.StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)- Specified by:
appendin interfaceorg.jvnet.jaxb2_commons.lang.ToString2- Overrides:
appendin classBackboneElement
-
appendFields
public java.lang.StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, java.lang.StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)- Specified by:
appendFieldsin interfaceorg.jvnet.jaxb2_commons.lang.ToString2- Overrides:
appendFieldsin classBackboneElement
-
-