public static class MedicationOrder.MedicationOrderDosageInstructionComponent extends BackboneElement implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
| Modifier and Type | Field and Description |
|---|---|
protected CodeableConcept |
additionalInstructions
Additional instructions such as "Swallow with plenty of water" which may or may not be coded.
|
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
The amount of therapeutic or other substance given at one administration event.
|
protected Ratio |
maxDosePerPeriod
The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time.
|
protected CodeableConcept |
method
A coded value indicating the method by which the medication is introduced into or onto the body.
|
protected Type |
rate
Identifies the speed with which the medication was or will be introduced into the patient.
|
protected CodeableConcept |
route
A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
|
protected Type |
site
A coded specification of the anatomic site where the medication first enters the body.
|
protected StringType |
text
Free text dosage instructions can be used for cases where the instructions are too complex to code.
|
protected Timing |
timing
The timing schedule for giving the medication to the patient.
|
modifierExtension| Constructor and Description |
|---|
MedicationOrderDosageInstructionComponent()
Constructor
|
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtensionaddExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElementcastToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetFormatCommentsPost, getFormatCommentsPre, hasFormatCommentprotected StringType text
protected CodeableConcept additionalInstructions
protected Timing timing
protected Type asNeeded
protected Type site
protected CodeableConcept route
protected CodeableConcept method
protected Type dose
protected Type rate
protected Ratio maxDosePerPeriod
public MedicationOrderDosageInstructionComponent()
public StringType getTextElement()
text (Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing.). 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 MedicationOrder.MedicationOrderDosageInstructionComponent setTextElement(StringType value)
value - text (Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the valuepublic String getText()
public MedicationOrder.MedicationOrderDosageInstructionComponent setText(String value)
value - Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing.public CodeableConcept getAdditionalInstructions()
additionalInstructions (Additional instructions such as "Swallow with plenty of water" which may or may not be coded.)public boolean hasAdditionalInstructions()
public MedicationOrder.MedicationOrderDosageInstructionComponent setAdditionalInstructions(CodeableConcept value)
value - additionalInstructions (Additional instructions such as "Swallow with plenty of water" which may or may not be coded.)public Timing getTiming()
timing (The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".)public boolean hasTiming()
public MedicationOrder.MedicationOrderDosageInstructionComponent setTiming(Timing value)
value - timing (The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".)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 MedicationOrder.MedicationOrderDosageInstructionComponent 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 Type getSite()
site (A coded specification of the anatomic site where the medication first enters the body.)public CodeableConcept getSiteCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
site (A coded specification of the anatomic site where the medication first enters the body.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasSiteCodeableConcept()
public Reference getSiteReference() throws org.hl7.fhir.exceptions.FHIRException
site (A coded specification of the anatomic site where the medication first enters the body.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasSiteReference()
public boolean hasSite()
public MedicationOrder.MedicationOrderDosageInstructionComponent setSite(Type value)
value - site (A coded specification of the anatomic site where the medication first enters the body.)public CodeableConcept getRoute()
route (A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.)public boolean hasRoute()
public MedicationOrder.MedicationOrderDosageInstructionComponent setRoute(CodeableConcept value)
value - route (A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.)public CodeableConcept getMethod()
method (A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.)public boolean hasMethod()
public MedicationOrder.MedicationOrderDosageInstructionComponent setMethod(CodeableConcept value)
value - method (A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.)public Type getDose()
dose (The amount of therapeutic or other substance given at one administration event.)public Range getDoseRange() throws org.hl7.fhir.exceptions.FHIRException
dose (The amount of therapeutic or other substance given at one administration event.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasDoseRange()
public SimpleQuantity getDoseSimpleQuantity() throws org.hl7.fhir.exceptions.FHIRException
dose (The amount of therapeutic or other substance given at one administration event.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasDoseSimpleQuantity()
public boolean hasDose()
public MedicationOrder.MedicationOrderDosageInstructionComponent setDose(Type value)
value - dose (The amount of therapeutic or other substance given at one administration event.)public Type getRate()
rate (Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.)public Ratio getRateRatio() throws org.hl7.fhir.exceptions.FHIRException
rate (Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasRateRatio()
public Range getRateRange() throws org.hl7.fhir.exceptions.FHIRException
rate (Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasRateRange()
public SimpleQuantity getRateSimpleQuantity() throws org.hl7.fhir.exceptions.FHIRException
rate (Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasRateSimpleQuantity()
public boolean hasRate()
public MedicationOrder.MedicationOrderDosageInstructionComponent setRate(Type value)
value - rate (Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.)public Ratio getMaxDosePerPeriod()
maxDosePerPeriod (The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.)public boolean hasMaxDosePerPeriod()
public MedicationOrder.MedicationOrderDosageInstructionComponent setMaxDosePerPeriod(Ratio value)
value - maxDosePerPeriod (The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.)protected void listChildren(List<Property> childrenList)
listChildren in class BackboneElementpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic MedicationOrder.MedicationOrderDosageInstructionComponent copy()
copy in class BackboneElementpublic boolean equalsDeep(Base other)
equalsDeep in class BackboneElementpublic boolean equalsShallow(Base other)
equalsShallow in class BackboneElementpublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class BackboneElementpublic String fhirType()
fhirType in class BackboneElementCopyright © 2014–2018 University Health Network. All rights reserved.