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
FieldsModifier and TypeFieldDescriptionprotected Booleanprotected CodeableConceptprotected Ratioprotected CodeableConceptprotected SimpleQuantityprotected Rangeprotected Rangeprotected Ratioprotected CodeableConceptprotected CodeableConceptprotected Referenceprotected Stringprotected TimingFields inherited from class org.hl7.fhir.BackboneElement
modifierExtension -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionappend(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy) appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy) booleanbooleanequals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy) Gets the value of the asNeededBoolean property.Gets the value of the asNeededCodeableConcept property.Gets the value of the maxDosePerPeriod property.Gets the value of the method property.Gets the value of the quantityQuantity property.Gets the value of the quantityRange property.Gets the value of the rateRange property.Gets the value of the rateRatio property.getRoute()Gets the value of the route property.Gets the value of the siteCodeableConcept property.Gets the value of the siteReference property.getText()Gets the value of the text property.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.voidSets 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.voidSets 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.voidSets the value of the siteCodeableConcept property.voidsetSiteReference(Reference value) Sets the value of the siteReference property.voidSets the value of the text property.voidSets the value of the timing property.toString()withAsNeededBoolean(Boolean value) withExtension(Collection<Extension> values) withExtension(Extension... values) withMaxDosePerPeriod(Ratio value) withMethod(CodeableConcept value) withModifierExtension(Collection<Extension> values) withModifierExtension(Extension... values) withQuantityRange(Range value) withRateRange(Range value) withRateRatio(Ratio value) withRoute(CodeableConcept value) withSiteReference(Reference value) withTiming(Timing value) Methods inherited from class org.hl7.fhir.BackboneElement
getModifierExtension, setModifierExtensionMethods inherited from class org.hl7.fhir.Element
getExtension, getId, setExtension, setId
-
Field Details
-
text
-
timing
-
asNeededBoolean
-
asNeededCodeableConcept
-
siteCodeableConcept
-
siteReference
-
route
-
method
-
quantityQuantity
-
quantityRange
-
rateRatio
-
rateRange
-
maxDosePerPeriod
-
-
Constructor Details
-
MedicationStatementDosage
public MedicationStatementDosage()
-
-
Method Details
-
getText
Gets the value of the text property.- Returns:
- possible object is
String
-
setText
Sets the value of the text property.- Parameters:
value- allowed object isString
-
getTiming
Gets the value of the timing property.- Returns:
- possible object is
Timing
-
setTiming
Sets the value of the timing property.- Parameters:
value- allowed object isTiming
-
getAsNeededBoolean
Gets the value of the asNeededBoolean property.- Returns:
- possible object is
Boolean
-
setAsNeededBoolean
Sets the value of the asNeededBoolean property.- Parameters:
value- allowed object isBoolean
-
getAsNeededCodeableConcept
Gets the value of the asNeededCodeableConcept property.- Returns:
- possible object is
CodeableConcept
-
setAsNeededCodeableConcept
Sets the value of the asNeededCodeableConcept property.- Parameters:
value- allowed object isCodeableConcept
-
getSiteCodeableConcept
Gets the value of the siteCodeableConcept property.- Returns:
- possible object is
CodeableConcept
-
setSiteCodeableConcept
Sets the value of the siteCodeableConcept property.- Parameters:
value- allowed object isCodeableConcept
-
getSiteReference
Gets the value of the siteReference property.- Returns:
- possible object is
Reference
-
setSiteReference
Sets the value of the siteReference property.- Parameters:
value- allowed object isReference
-
getRoute
Gets the value of the route property.- Returns:
- possible object is
CodeableConcept
-
setRoute
Sets the value of the route property.- Parameters:
value- allowed object isCodeableConcept
-
getMethod
Gets the value of the method property.- Returns:
- possible object is
CodeableConcept
-
setMethod
Sets the value of the method property.- Parameters:
value- allowed object isCodeableConcept
-
getQuantityQuantity
Gets the value of the quantityQuantity property.- Returns:
- possible object is
SimpleQuantity
-
setQuantityQuantity
Sets the value of the quantityQuantity property.- Parameters:
value- allowed object isSimpleQuantity
-
getQuantityRange
Gets the value of the quantityRange property.- Returns:
- possible object is
Range
-
setQuantityRange
Sets the value of the quantityRange property.- Parameters:
value- allowed object isRange
-
getRateRatio
Gets the value of the rateRatio property.- Returns:
- possible object is
Ratio
-
setRateRatio
Sets the value of the rateRatio property.- Parameters:
value- allowed object isRatio
-
getRateRange
Gets the value of the rateRange property.- Returns:
- possible object is
Range
-
setRateRange
Sets the value of the rateRange property.- Parameters:
value- allowed object isRange
-
getMaxDosePerPeriod
Gets the value of the maxDosePerPeriod property.- Returns:
- possible object is
Ratio
-
setMaxDosePerPeriod
Sets the value of the maxDosePerPeriod property.- Parameters:
value- allowed object isRatio
-
withText
-
withTiming
-
withAsNeededBoolean
-
withAsNeededCodeableConcept
-
withSiteCodeableConcept
-
withSiteReference
-
withRoute
-
withMethod
-
withQuantityQuantity
-
withQuantityRange
-
withRateRatio
-
withRateRange
-
withMaxDosePerPeriod
-
withModifierExtension
- Overrides:
withModifierExtensionin classBackboneElement
-
withModifierExtension
- Overrides:
withModifierExtensionin classBackboneElement
-
withExtension
- Overrides:
withExtensionin classBackboneElement
-
withExtension
- Overrides:
withExtensionin classBackboneElement
-
withId
- Overrides:
withIdin classBackboneElement
-
equals
public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy) - Specified by:
equalsin interfaceorg.jvnet.jaxb2_commons.lang.Equals2- Overrides:
equalsin classBackboneElement
-
equals
- 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
- Overrides:
toStringin classBackboneElement
-
append
public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy) - Specified by:
appendin interfaceorg.jvnet.jaxb2_commons.lang.ToString2- Overrides:
appendin classBackboneElement
-
appendFields
public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy) - Specified by:
appendFieldsin interfaceorg.jvnet.jaxb2_commons.lang.ToString2- Overrides:
appendFieldsin classBackboneElement
-