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
public class Dosage extends BackboneType 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDosage.DosageDoseAndRateComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<CodeableConcept>additionalInstructionSupplemental instructions to the patient on how to take the medication (e.g.protected TypeasNeededIndicates 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>doseAndRateThe amount of medication administered.protected QuantitymaxDosePerAdministrationUpper limit on medication per administration.protected QuantitymaxDosePerLifetimeUpper limit on medication per lifetime of the patient.protected RatiomaxDosePerPeriodUpper limit on medication per unit of time.protected CodeableConceptmethodTechnique for administering medication.protected StringTypepatientInstructionInstructions in terms that are understood by the patient or consumer.protected CodeableConceptrouteHow drug should enter body.protected IntegerTypesequenceIndicates the order in which the dosage instructions should be applied or interpreted.protected CodeableConceptsiteBody site to administer to.protected StringTypetextFree text dosage instructions e.g.protected TimingtimingWhen medication should be administered.-
Fields inherited from class org.hl7.fhir.r4.model.BackboneType
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description Dosage()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.BackboneType
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension
-
Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, 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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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
-
-
-
-
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 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
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.
-
doseAndRate
protected List<Dosage.DosageDoseAndRateComponent> doseAndRate
The amount of medication administered.
-
maxDosePerPeriod
protected Ratio maxDosePerPeriod
Upper limit on medication per unit of time.
-
maxDosePerAdministration
protected Quantity maxDosePerAdministration
Upper limit on medication per administration.
-
maxDosePerLifetime
protected Quantity 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 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
public Dosage setAdditionalInstruction(List<CodeableConcept> theAdditionalInstruction)
- Returns:
- Returns a reference to
thisfor 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)
- 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
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.)
-
getDoseAndRate
public List<Dosage.DosageDoseAndRateComponent> getDoseAndRate()
- Returns:
doseAndRate(The amount of medication administered.)
-
setDoseAndRate
public Dosage setDoseAndRate(List<Dosage.DosageDoseAndRateComponent> theDoseAndRate)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDoseAndRate
public boolean hasDoseAndRate()
-
addDoseAndRate
public Dosage.DosageDoseAndRateComponent addDoseAndRate()
-
addDoseAndRate
public Dosage addDoseAndRate(Dosage.DosageDoseAndRateComponent t)
-
getDoseAndRateFirstRep
public Dosage.DosageDoseAndRateComponent getDoseAndRateFirstRep()
- Returns:
- The first repetition of repeating field
doseAndRate, creating it if it does not already exist
-
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 Quantity getMaxDosePerAdministration()
- Returns:
maxDosePerAdministration(Upper limit on medication per administration.)
-
hasMaxDosePerAdministration
public boolean hasMaxDosePerAdministration()
-
setMaxDosePerAdministration
public Dosage setMaxDosePerAdministration(Quantity value)
- Parameters:
value-maxDosePerAdministration(Upper limit on medication per administration.)
-
getMaxDosePerLifetime
public Quantity getMaxDosePerLifetime()
- Returns:
maxDosePerLifetime(Upper limit on medication per lifetime of the patient.)
-
hasMaxDosePerLifetime
public boolean hasMaxDosePerLifetime()
-
setMaxDosePerLifetime
public Dosage setMaxDosePerLifetime(Quantity value)
- Parameters:
value-maxDosePerLifetime(Upper limit on medication per lifetime of the patient.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classBackboneType
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classBackboneType- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classBackboneType- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classBackboneType- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classBackboneType- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classBackboneType- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classBackboneType- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classBackboneType- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classBackboneType
-
copy
public Dosage copy()
- Specified by:
copyin classBackboneType
-
copyValues
public void copyValues(Dosage dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classBackboneType
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classBackboneType
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classBackboneType
-
-