Package org.hl7.fhir.r4.model
Class Dosage
java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.Element
org.hl7.fhir.r4.model.Type
org.hl7.fhir.r4.model.BackboneType
org.hl7.fhir.r4.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.IBaseBackboneElement
,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.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.ICompositeType
Indicates how the medication is/was taken or should be taken by the patient.
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<CodeableConcept> Supplemental instructions to the patient on how to take the medication (e.g.protected Type
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 List
<Dosage.DosageDoseAndRateComponent> The amount of medication administered.protected Quantity
Upper limit on medication per administration.protected Quantity
Upper limit on medication per lifetime of the patient.protected Ratio
Upper limit on medication per unit of time.protected CodeableConcept
Technique for administering medication.protected StringType
Instructions in terms that are understood by the patient or consumer.protected CodeableConcept
How drug should enter body.protected IntegerType
Indicates the order in which the dosage instructions should be applied or interpreted.protected CodeableConcept
Body site to administer to.protected StringType
Free text dosage instructions e.g.protected Timing
When medication should be administered.Fields inherited from class org.hl7.fhir.r4.model.BackboneType
modifierExtension
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
copyValues
(Dosage dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getRoute()
int
getSite()
getText()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasRoute()
boolean
boolean
boolean
hasSite()
boolean
hasText()
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAdditionalInstruction
(List<CodeableConcept> theAdditionalInstruction) setAsNeeded
(Type value) setDoseAndRate
(List<Dosage.DosageDoseAndRateComponent> theDoseAndRate) setMaxDosePerLifetime
(Quantity value) setMaxDosePerPeriod
(Ratio value) setMethod
(CodeableConcept value) setPatientInstruction
(String value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setRoute
(CodeableConcept value) setSequence
(int value) setSequenceElement
(IntegerType value) setSite
(CodeableConcept value) setTextElement
(StringType value) protected Dosage
Methods inherited from class org.hl7.fhir.r4.model.BackboneType
addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, setModifierExtension
Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension
-
Field Details
-
sequence
Indicates the order in which the dosage instructions should be applied or interpreted. -
text
Free text dosage instructions e.g. SIG. -
additionalInstruction
Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). -
patientInstruction
Instructions in terms that are understood by the patient or consumer. -
timing
When medication should be administered. -
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
Body site to administer to. -
route
How drug should enter body. -
method
Technique for administering medication. -
doseAndRate
The amount of medication administered. -
maxDosePerPeriod
Upper limit on medication per unit of time. -
maxDosePerAdministration
Upper limit on medication per administration. -
maxDosePerLifetime
Upper limit on medication per lifetime of the patient.
-
-
Constructor Details
-
Dosage
public Dosage()Constructor
-
-
Method Details
-
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
-
hasSequence
-
setSequenceElement
- 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
- Returns:
- Indicates the order in which the dosage instructions should be applied or interpreted.
-
setSequence
- Parameters:
value
- Indicates the order in which the dosage instructions should be applied or interpreted.
-
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
-
hasText
-
setTextElement
- 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
-
getText
- Returns:
- Free text dosage instructions e.g. SIG.
-
setText
- Parameters:
value
- Free text dosage instructions e.g. SIG.
-
getAdditionalInstruction
- Returns:
additionalInstruction
(Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").)
-
setAdditionalInstruction
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAdditionalInstruction
-
addAdditionalInstruction
-
addAdditionalInstruction
-
getAdditionalInstructionFirstRep
- Returns:
- The first repetition of repeating field
additionalInstruction
, creating it if it does not already exist
-
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
-
hasPatientInstruction
-
setPatientInstructionElement
- 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
- Returns:
- Instructions in terms that are understood by the patient or consumer.
-
setPatientInstruction
- Parameters:
value
- Instructions in terms that are understood by the patient or consumer.
-
getTiming
- Returns:
timing
(When medication should be administered.)
-
hasTiming
-
setTiming
- Parameters:
value
-timing
(When medication should be administered.)
-
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
- 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
-
getAsNeededCodeableConcept
- 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
-
hasAsNeeded
-
setAsNeeded
- 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).)
-
getSite
- Returns:
site
(Body site to administer to.)
-
hasSite
-
setSite
- Parameters:
value
-site
(Body site to administer to.)
-
getRoute
- Returns:
route
(How drug should enter body.)
-
hasRoute
-
setRoute
- Parameters:
value
-route
(How drug should enter body.)
-
getMethod
- Returns:
method
(Technique for administering medication.)
-
hasMethod
-
setMethod
- Parameters:
value
-method
(Technique for administering medication.)
-
getDoseAndRate
- Returns:
doseAndRate
(The amount of medication administered.)
-
setDoseAndRate
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDoseAndRate
-
addDoseAndRate
-
addDoseAndRate
-
getDoseAndRateFirstRep
- Returns:
- The first repetition of repeating field
doseAndRate
, creating it if it does not already exist
-
getMaxDosePerPeriod
- Returns:
maxDosePerPeriod
(Upper limit on medication per unit of time.)
-
hasMaxDosePerPeriod
-
setMaxDosePerPeriod
- Parameters:
value
-maxDosePerPeriod
(Upper limit on medication per unit of time.)
-
getMaxDosePerAdministration
- Returns:
maxDosePerAdministration
(Upper limit on medication per administration.)
-
hasMaxDosePerAdministration
-
setMaxDosePerAdministration
- Parameters:
value
-maxDosePerAdministration
(Upper limit on medication per administration.)
-
getMaxDosePerLifetime
- Returns:
maxDosePerLifetime
(Upper limit on medication per lifetime of the patient.)
-
hasMaxDosePerLifetime
-
setMaxDosePerLifetime
- Parameters:
value
-maxDosePerLifetime
(Upper limit on medication per lifetime of the patient.)
-
listChildren
- Overrides:
listChildren
in classBackboneType
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classBackboneType
- 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 classBackboneType
- 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 classBackboneType
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classBackboneType
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classBackboneType
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classBackboneType
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classBackboneType
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classBackboneType
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneType
-
copy
- Specified by:
copy
in classBackboneType
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classBackboneType
-
equalsShallow
- Overrides:
equalsShallow
in classBackboneType
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneType
-