HS.FHIRModel.R4.MedicationAdministrationX.Dosage
class HS.FHIRModel.R4.MedicationAdministrationX.Dosage extends HS.FHIRModel.FHIRClassSuper
******************************************* MedicationAdministrationX.Dosage generated class schema
*****************************************
Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
Property Inventory
Method Inventory
- IncludeDose()
- IncludeExtension()
- IncludeMethod()
- IncludeModifierExtension()
- IncludeRateQuantity()
- IncludeRateRatio()
- IncludeRoute()
- IncludeSite()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_MEDICATIONADMINISTRATIONX_DOSAGE;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Properties
property _text as HS.FHIRModel.R4.Element;
Extensions for text
Property methods: _textGet(), _textGetSwizzled(), _textIsValid(), _textNewObject(), _textSet()
property dose as HS.FHIRModel.R4.Quantity;
The amount of the medication given at one administration event.
Use this value when the administration is essentially an instantaneous
event such as a swallowing a tablet or giving an injection.
Property methods: doseGet(), doseGetSwizzled(), doseIsValid(), doseNewObject(), doseSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the element. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references).
This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property method as HS.FHIRModel.R4.CodeableConcept;
A coded value indicating the method by which the medication is intended
to be or was introduced into or on the body. This attribute will
most often NOT be populated. It is most commonly used for injections.
For example, Slow Push, Deep IV.
Property methods: methodGet(), methodGetSwizzled(), methodIsValid(), methodNewObject(), methodSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the element and that modifies the understanding
of the element in which it is contained and/or the understanding
of the containing element's descendants. Usually modifier elements
provide negation or qualification. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension. Applications
processing a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property rateQuantity as HS.FHIRModel.R4.Quantity;
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. Other examples: 200 mcg/min
or 200 mcg/1 minute; 1 liter/8 hours.
Property methods: rateQuantityGet(), rateQuantityGetSwizzled(), rateQuantityIsValid(), rateQuantityNewObject(), rateQuantitySet()
property rateRatio as HS.FHIRModel.R4.Ratio;
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. Other examples: 200 mcg/min
or 200 mcg/1 minute; 1 liter/8 hours.
Property methods: rateRatioGet(), rateRatioGetSwizzled(), rateRatioIsValid(), rateRatioNewObject(), rateRatioSet()
property route as HS.FHIRModel.R4.CodeableConcept;
A code specifying the route or physiological path of administration
of a therapeutic agent into or onto the patient. For example, topical,
intravenous, etc.
Property methods: routeGet(), routeGetSwizzled(), routeIsValid(), routeNewObject(), routeSet()
property site as HS.FHIRModel.R4.CodeableConcept;
A coded specification of the anatomic site where the medication first
entered the body. For example, "left arm".
Property methods: siteGet(), siteGetSwizzled(), siteIsValid(), siteNewObject(), siteSet()
property text as %String;
Free text dosage can be used for cases where the dosage administered
is too complex to code. When coded dosage is present, the free text
dosage may still be present for display to humans. The dosage instructions
should reflect the dosage of the medication that was administered.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
Methods
method IncludeDose()
method IncludeExtension()
method IncludeMethod()
method IncludeModifierExtension()
method IncludeRateQuantity()
method IncludeRateRatio()
method IncludeRoute()
method IncludeSite()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.MedicationAdministrationX.Dosage
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()