
Package org.hl7.fhir.dstu3.model
Class Dosage
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.Element
-
- org.hl7.fhir.dstu3.model.Type
-
- org.hl7.fhir.dstu3.model.Dosage
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseDatatype
,org.hl7.fhir.instance.model.api.IBaseElement
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.ICompositeType
public class Dosage extends Type implements org.hl7.fhir.instance.model.api.ICompositeType
Indicates how the medication is/was taken or should be taken by the patient.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected List<CodeableConcept>
additionalInstruction
Supplemental instruction - e.g.protected Type
asNeeded
Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).protected Type
dose
Amount of medication per dose.protected SimpleQuantity
maxDosePerAdministration
Upper limit on medication per administration.protected SimpleQuantity
maxDosePerLifetime
Upper limit on medication per lifetime of the patient.protected Ratio
maxDosePerPeriod
Upper limit on medication per unit of time.protected CodeableConcept
method
Technique for administering medication.protected StringType
patientInstruction
Instructions in terms that are understood by the patient or consumer.protected Type
rate
Amount of medication per unit of time.protected CodeableConcept
route
How drug should enter body.protected IntegerType
sequence
Indicates the order in which the dosage instructions should be applied or interpreted.protected CodeableConcept
site
Body site to administer to.protected StringType
text
Free text dosage instructions e.g.protected Timing
timing
When medication should be administered.
-
Constructor Summary
Constructors Constructor Description Dosage()
Constructor
-
Method Summary
-
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
-
-
-
-
Field Detail
-
sequence
protected IntegerType sequence
Indicates the order in which the dosage instructions should be applied or interpreted.
-
text
protected StringType text
Free text dosage instructions e.g. SIG.
-
additionalInstruction
protected List<CodeableConcept> additionalInstruction
Supplemental instruction - e.g. "with meals".
-
patientInstruction
protected StringType patientInstruction
Instructions in terms that are understood by the patient or consumer.
-
asNeeded
protected Type asNeeded
Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
-
site
protected CodeableConcept site
Body site to administer to.
-
route
protected CodeableConcept route
How drug should enter body.
-
method
protected CodeableConcept method
Technique for administering medication.
-
maxDosePerPeriod
protected Ratio maxDosePerPeriod
Upper limit on medication per unit of time.
-
maxDosePerAdministration
protected SimpleQuantity maxDosePerAdministration
Upper limit on medication per administration.
-
maxDosePerLifetime
protected SimpleQuantity maxDosePerLifetime
Upper limit on medication per lifetime of the patient.
-
-
Constructor Detail
-
Dosage
public Dosage()
Constructor
-
-
Method Detail
-
getSequenceElement
public IntegerType getSequenceElement()
- Returns:
sequence
(Indicates the order in which the dosage instructions should be applied or interpreted.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value
-
hasSequenceElement
public boolean hasSequenceElement()
-
hasSequence
public boolean hasSequence()
-
setSequenceElement
public Dosage setSequenceElement(IntegerType value)
- Parameters:
value
-sequence
(Indicates the order in which the dosage instructions should be applied or interpreted.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value
-
getSequence
public int getSequence()
- Returns:
- Indicates the order in which the dosage instructions should be applied or interpreted.
-
setSequence
public Dosage setSequence(int value)
- Parameters:
value
- Indicates the order in which the dosage instructions should be applied or interpreted.
-
getTextElement
public StringType getTextElement()
- Returns:
text
(Free text dosage instructions e.g. SIG.). 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 Dosage setTextElement(StringType value)
- Parameters:
value
-text
(Free text dosage instructions e.g. SIG.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
-
setText
public Dosage setText(String value)
- Parameters:
value
- Free text dosage instructions e.g. SIG.
-
getAdditionalInstruction
public List<CodeableConcept> getAdditionalInstruction()
- Returns:
additionalInstruction
(Supplemental instruction - e.g. "with meals".)
-
setAdditionalInstruction
public Dosage setAdditionalInstruction(List<CodeableConcept> theAdditionalInstruction)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAdditionalInstruction
public boolean hasAdditionalInstruction()
-
addAdditionalInstruction
public CodeableConcept addAdditionalInstruction()
-
addAdditionalInstruction
public Dosage addAdditionalInstruction(CodeableConcept t)
-
getAdditionalInstructionFirstRep
public CodeableConcept getAdditionalInstructionFirstRep()
- Returns:
- The first repetition of repeating field
additionalInstruction
, creating it if it does not already exist
-
getPatientInstructionElement
public StringType getPatientInstructionElement()
- Returns:
patientInstruction
(Instructions in terms that are understood by the patient or consumer.). This is the underlying object with id, value and extensions. The accessor "getPatientInstruction" gives direct access to the value
-
hasPatientInstructionElement
public boolean hasPatientInstructionElement()
-
hasPatientInstruction
public boolean hasPatientInstruction()
-
setPatientInstructionElement
public Dosage setPatientInstructionElement(StringType value)
- Parameters:
value
-patientInstruction
(Instructions in terms that are understood by the patient or consumer.). This is the underlying object with id, value and extensions. The accessor "getPatientInstruction" gives direct access to the value
-
getPatientInstruction
public String getPatientInstruction()
- Returns:
- Instructions in terms that are understood by the patient or consumer.
-
setPatientInstruction
public Dosage setPatientInstruction(String value)
- Parameters:
value
- Instructions in terms that are understood by the patient or consumer.
-
hasTiming
public boolean hasTiming()
-
setTiming
public Dosage setTiming(Timing value)
- Parameters:
value
-timing
(When medication should be administered.)
-
getAsNeeded
public Type getAsNeeded()
- Returns:
asNeeded
(Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).)
-
getAsNeededBooleanType
public BooleanType getAsNeededBooleanType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
asNeeded
(Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasAsNeededBooleanType
public boolean hasAsNeededBooleanType()
-
getAsNeededCodeableConcept
public CodeableConcept getAsNeededCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
asNeeded
(Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasAsNeededCodeableConcept
public boolean hasAsNeededCodeableConcept()
-
hasAsNeeded
public boolean hasAsNeeded()
-
setAsNeeded
public Dosage setAsNeeded(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
- Parameters:
value
-asNeeded
(Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getSite
public CodeableConcept getSite()
- Returns:
site
(Body site to administer to.)
-
hasSite
public boolean hasSite()
-
setSite
public Dosage setSite(CodeableConcept value)
- Parameters:
value
-site
(Body site to administer to.)
-
getRoute
public CodeableConcept getRoute()
- Returns:
route
(How drug should enter body.)
-
hasRoute
public boolean hasRoute()
-
setRoute
public Dosage setRoute(CodeableConcept value)
- Parameters:
value
-route
(How drug should enter body.)
-
getMethod
public CodeableConcept getMethod()
- Returns:
method
(Technique for administering medication.)
-
hasMethod
public boolean hasMethod()
-
setMethod
public Dosage setMethod(CodeableConcept value)
- Parameters:
value
-method
(Technique for administering medication.)
-
getDoseRange
public Range getDoseRange() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
dose
(Amount of medication per dose.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDoseRange
public boolean hasDoseRange()
-
getDoseSimpleQuantity
public SimpleQuantity getDoseSimpleQuantity() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
dose
(Amount of medication per dose.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDoseSimpleQuantity
public boolean hasDoseSimpleQuantity()
-
hasDose
public boolean hasDose()
-
setDose
public Dosage setDose(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
- Parameters:
value
-dose
(Amount of medication per dose.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getMaxDosePerPeriod
public Ratio getMaxDosePerPeriod()
- Returns:
maxDosePerPeriod
(Upper limit on medication per unit of time.)
-
hasMaxDosePerPeriod
public boolean hasMaxDosePerPeriod()
-
setMaxDosePerPeriod
public Dosage setMaxDosePerPeriod(Ratio value)
- Parameters:
value
-maxDosePerPeriod
(Upper limit on medication per unit of time.)
-
getMaxDosePerAdministration
public SimpleQuantity getMaxDosePerAdministration()
- Returns:
maxDosePerAdministration
(Upper limit on medication per administration.)
-
hasMaxDosePerAdministration
public boolean hasMaxDosePerAdministration()
-
setMaxDosePerAdministration
public Dosage setMaxDosePerAdministration(SimpleQuantity value)
- Parameters:
value
-maxDosePerAdministration
(Upper limit on medication per administration.)
-
getMaxDosePerLifetime
public SimpleQuantity getMaxDosePerLifetime()
- Returns:
maxDosePerLifetime
(Upper limit on medication per lifetime of the patient.)
-
hasMaxDosePerLifetime
public boolean hasMaxDosePerLifetime()
-
setMaxDosePerLifetime
public Dosage setMaxDosePerLifetime(SimpleQuantity value)
- Parameters:
value
-maxDosePerLifetime
(Upper limit on medication per lifetime of the patient.)
-
getRateRatio
public Ratio getRateRatio() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
rate
(Amount of medication per unit of time.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasRateRatio
public boolean hasRateRatio()
-
getRateRange
public Range getRateRange() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
rate
(Amount of medication per unit of time.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasRateRange
public boolean hasRateRange()
-
getRateSimpleQuantity
public SimpleQuantity getRateSimpleQuantity() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
rate
(Amount of medication per unit of time.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasRateSimpleQuantity
public boolean hasRateSimpleQuantity()
-
hasRate
public boolean hasRate()
-
setRate
public Dosage setRate(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
- Parameters:
value
-rate
(Amount of medication per unit of time.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classElement
- 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 classElement
- 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 classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classElement
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classElement
-
-