public class Dosage extends BackboneType implements org.hl7.fhir.instance.model.api.ICompositeType
| Modifier and Type | Class and Description |
|---|---|
static class |
Dosage.DosageDoseAndRateComponent |
| Modifier and Type | Field and Description |
|---|---|
protected List<CodeableConcept> |
additionalInstruction
Supplemental instructions to the patient on how to take the medication (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 List<Dosage.DosageDoseAndRateComponent> |
doseAndRate
The amount of medication administered.
|
protected Quantity |
maxDosePerAdministration
Upper limit on medication per administration.
|
protected Quantity |
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 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.
|
modifierExtension| Constructor and Description |
|---|
Dosage()
Constructor
|
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtensionaddExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElementcastToAddress, 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, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserDataprotected IntegerType sequence
protected StringType text
protected List<CodeableConcept> additionalInstruction
protected StringType patientInstruction
protected Type asNeeded
protected CodeableConcept site
protected CodeableConcept route
protected CodeableConcept method
protected List<Dosage.DosageDoseAndRateComponent> doseAndRate
protected Ratio maxDosePerPeriod
protected Quantity maxDosePerAdministration
protected Quantity maxDosePerLifetime
public Dosage()
public IntegerType getSequenceElement()
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 valuepublic boolean hasSequenceElement()
public boolean hasSequence()
public Dosage setSequenceElement(IntegerType value)
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 valuepublic int getSequence()
public Dosage setSequence(int value)
value - Indicates the order in which the dosage instructions should be applied or interpreted.public StringType getTextElement()
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 valuepublic boolean hasTextElement()
public boolean hasText()
public Dosage setTextElement(StringType value)
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 valuepublic Dosage setText(String value)
value - Free text dosage instructions e.g. SIG.public List<CodeableConcept> getAdditionalInstruction()
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").)public Dosage setAdditionalInstruction(List<CodeableConcept> theAdditionalInstruction)
this for easy method chainingpublic boolean hasAdditionalInstruction()
public CodeableConcept addAdditionalInstruction()
public Dosage addAdditionalInstruction(CodeableConcept t)
public CodeableConcept getAdditionalInstructionFirstRep()
additionalInstruction, creating it if it does not already existpublic StringType getPatientInstructionElement()
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 valuepublic boolean hasPatientInstructionElement()
public boolean hasPatientInstruction()
public Dosage setPatientInstructionElement(StringType value)
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 valuepublic String getPatientInstruction()
public Dosage setPatientInstruction(String value)
value - Instructions in terms that are understood by the patient or consumer.public boolean hasTiming()
public Dosage setTiming(Timing value)
value - timing (When medication should be administered.)public Type getAsNeeded()
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).)public BooleanType getAsNeededBooleanType() throws org.hl7.fhir.exceptions.FHIRException
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).)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasAsNeededBooleanType()
public CodeableConcept getAsNeededCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
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).)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasAsNeededCodeableConcept()
public boolean hasAsNeeded()
public Dosage setAsNeeded(Type value)
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).)public CodeableConcept getSite()
site (Body site to administer to.)public boolean hasSite()
public Dosage setSite(CodeableConcept value)
value - site (Body site to administer to.)public CodeableConcept getRoute()
route (How drug should enter body.)public boolean hasRoute()
public Dosage setRoute(CodeableConcept value)
value - route (How drug should enter body.)public CodeableConcept getMethod()
method (Technique for administering medication.)public boolean hasMethod()
public Dosage setMethod(CodeableConcept value)
value - method (Technique for administering medication.)public List<Dosage.DosageDoseAndRateComponent> getDoseAndRate()
doseAndRate (The amount of medication administered.)public Dosage setDoseAndRate(List<Dosage.DosageDoseAndRateComponent> theDoseAndRate)
this for easy method chainingpublic boolean hasDoseAndRate()
public Dosage.DosageDoseAndRateComponent addDoseAndRate()
public Dosage addDoseAndRate(Dosage.DosageDoseAndRateComponent t)
public Dosage.DosageDoseAndRateComponent getDoseAndRateFirstRep()
doseAndRate, creating it if it does not already existpublic Ratio getMaxDosePerPeriod()
maxDosePerPeriod (Upper limit on medication per unit of time.)public boolean hasMaxDosePerPeriod()
public Dosage setMaxDosePerPeriod(Ratio value)
value - maxDosePerPeriod (Upper limit on medication per unit of time.)public Quantity getMaxDosePerAdministration()
maxDosePerAdministration (Upper limit on medication per administration.)public boolean hasMaxDosePerAdministration()
public Dosage setMaxDosePerAdministration(Quantity value)
value - maxDosePerAdministration (Upper limit on medication per administration.)public Quantity getMaxDosePerLifetime()
maxDosePerLifetime (Upper limit on medication per lifetime of the patient.)public boolean hasMaxDosePerLifetime()
public Dosage setMaxDosePerLifetime(Quantity value)
value - maxDosePerLifetime (Upper limit on medication per lifetime of the patient.)protected void listChildren(List<Property> children)
listChildren in class BackboneTypepublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
getNamedProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
getTypesForProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in interface org.hl7.fhir.instance.model.api.IBasefhirType in class BackboneTypepublic Dosage copy()
copy in class BackboneTypepublic void copyValues(Dosage dst)
public boolean equalsDeep(Base other_)
equalsDeep in class BackboneTypepublic boolean equalsShallow(Base other_)
equalsShallow in class BackboneTypepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class BackboneTypeCopyright © 2014–2021 Health Level 7. All rights reserved.