Package org.hl7.fhir
Class MedicationStatementDosage
- java.lang.Object
-
- org.hl7.fhir.Element
-
- org.hl7.fhir.BackboneElement
-
- org.hl7.fhir.MedicationStatementDosage
-
- All Implemented Interfaces:
org.jvnet.jaxb2_commons.lang.Equals2,org.jvnet.jaxb2_commons.lang.HashCode2,org.jvnet.jaxb2_commons.lang.ToString2
public class MedicationStatementDosage extends BackboneElement implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now, or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from e.g. the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.Java class for MedicationStatement.Dosage complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="MedicationStatement.Dosage"> <complexContent> <extension base="{http://hl7.org/fhir}BackboneElement"> <sequence> <element name="text" type="{http://hl7.org/fhir}string" 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="quantityQuantity" type="{http://hl7.org/fhir}SimpleQuantity"/> <element name="quantityRange" type="{http://hl7.org/fhir}Range"/> </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 BooleanasNeededBooleanprotected CodeableConceptasNeededCodeableConceptprotected RatiomaxDosePerPeriodprotected CodeableConceptmethodprotected SimpleQuantityquantityQuantityprotected RangequantityRangeprotected RangerateRangeprotected RatiorateRatioprotected CodeableConceptrouteprotected CodeableConceptsiteCodeableConceptprotected ReferencesiteReferenceprotected Stringtextprotected Timingtiming-
Fields inherited from class org.hl7.fhir.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description MedicationStatementDosage()
-
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)BooleangetAsNeededBoolean()Gets the value of the asNeededBoolean property.CodeableConceptgetAsNeededCodeableConcept()Gets the value of the asNeededCodeableConcept property.RatiogetMaxDosePerPeriod()Gets the value of the maxDosePerPeriod property.CodeableConceptgetMethod()Gets the value of the method property.SimpleQuantitygetQuantityQuantity()Gets the value of the quantityQuantity property.RangegetQuantityRange()Gets the value of the quantityRange 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)voidsetAsNeededBoolean(Boolean value)Sets the value of the asNeededBoolean property.voidsetAsNeededCodeableConcept(CodeableConcept value)Sets the value of the asNeededCodeableConcept property.voidsetMaxDosePerPeriod(Ratio value)Sets the value of the maxDosePerPeriod property.voidsetMethod(CodeableConcept value)Sets the value of the method property.voidsetQuantityQuantity(SimpleQuantity value)Sets the value of the quantityQuantity property.voidsetQuantityRange(Range value)Sets the value of the quantityRange 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()MedicationStatementDosagewithAsNeededBoolean(Boolean value)MedicationStatementDosagewithAsNeededCodeableConcept(CodeableConcept value)MedicationStatementDosagewithExtension(java.util.Collection<Extension> values)MedicationStatementDosagewithExtension(Extension... values)MedicationStatementDosagewithId(java.lang.String value)MedicationStatementDosagewithMaxDosePerPeriod(Ratio value)MedicationStatementDosagewithMethod(CodeableConcept value)MedicationStatementDosagewithModifierExtension(java.util.Collection<Extension> values)MedicationStatementDosagewithModifierExtension(Extension... values)MedicationStatementDosagewithQuantityQuantity(SimpleQuantity value)MedicationStatementDosagewithQuantityRange(Range value)MedicationStatementDosagewithRateRange(Range value)MedicationStatementDosagewithRateRatio(Ratio value)MedicationStatementDosagewithRoute(CodeableConcept value)MedicationStatementDosagewithSiteCodeableConcept(CodeableConcept value)MedicationStatementDosagewithSiteReference(Reference value)MedicationStatementDosagewithText(String value)MedicationStatementDosagewithTiming(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
-
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
-
quantityQuantity
protected SimpleQuantity quantityQuantity
-
quantityRange
protected Range quantityRange
-
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
-
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
-
getQuantityQuantity
public SimpleQuantity getQuantityQuantity()
Gets the value of the quantityQuantity property.- Returns:
- possible object is
SimpleQuantity
-
setQuantityQuantity
public void setQuantityQuantity(SimpleQuantity value)
Sets the value of the quantityQuantity property.- Parameters:
value- allowed object isSimpleQuantity
-
getQuantityRange
public Range getQuantityRange()
Gets the value of the quantityRange property.- Returns:
- possible object is
Range
-
setQuantityRange
public void setQuantityRange(Range value)
Sets the value of the quantityRange property.- Parameters:
value- allowed object isRange
-
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 MedicationStatementDosage withText(String value)
-
withTiming
public MedicationStatementDosage withTiming(Timing value)
-
withAsNeededBoolean
public MedicationStatementDosage withAsNeededBoolean(Boolean value)
-
withAsNeededCodeableConcept
public MedicationStatementDosage withAsNeededCodeableConcept(CodeableConcept value)
-
withSiteCodeableConcept
public MedicationStatementDosage withSiteCodeableConcept(CodeableConcept value)
-
withSiteReference
public MedicationStatementDosage withSiteReference(Reference value)
-
withRoute
public MedicationStatementDosage withRoute(CodeableConcept value)
-
withMethod
public MedicationStatementDosage withMethod(CodeableConcept value)
-
withQuantityQuantity
public MedicationStatementDosage withQuantityQuantity(SimpleQuantity value)
-
withQuantityRange
public MedicationStatementDosage withQuantityRange(Range value)
-
withRateRatio
public MedicationStatementDosage withRateRatio(Ratio value)
-
withRateRange
public MedicationStatementDosage withRateRange(Range value)
-
withMaxDosePerPeriod
public MedicationStatementDosage withMaxDosePerPeriod(Ratio value)
-
withModifierExtension
public MedicationStatementDosage withModifierExtension(Extension... values)
- Overrides:
withModifierExtensionin classBackboneElement
-
withModifierExtension
public MedicationStatementDosage withModifierExtension(java.util.Collection<Extension> values)
- Overrides:
withModifierExtensionin classBackboneElement
-
withExtension
public MedicationStatementDosage withExtension(Extension... values)
- Overrides:
withExtensionin classBackboneElement
-
withExtension
public MedicationStatementDosage withExtension(java.util.Collection<Extension> values)
- Overrides:
withExtensionin classBackboneElement
-
withId
public MedicationStatementDosage 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
-
-