Skip to main content

HS.FHIR.vSTU3.Model.Resource.MedicationAdministration.Dosage

deprecated class HS.FHIR.vSTU3.Model.Resource.MedicationAdministration.Dosage extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = MedicationAdministration.Dosage;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = MedicationAdministration.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 dose as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "dose", XMLPROJECTION = "ELEMENT");
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 method as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "method", XMLPROJECTION = "ELEMENT");
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 rateQuantity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "rateQuantity", XMLPROJECTION = "ELEMENT");
Property methods: rateQuantityGet(), rateQuantityGetSwizzled(), rateQuantityIsValid(), rateQuantityNewObject(), rateQuantitySet()
property rateRatio as HS.FHIR.vSTU3.Model.Base.Ratio (XMLNAME = "rateRatio", XMLPROJECTION = "ELEMENT");
Property methods: rateRatioGet(), rateRatioGetSwizzled(), rateRatioIsValid(), rateRatioNewObject(), rateRatioSet()
property route as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "route", XMLPROJECTION = "ELEMENT");
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.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "site", XMLPROJECTION = "ELEMENT");
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 HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "text", XMLPROJECTION = "ELEMENT");
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: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

deprecated method SetDose(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "dose" property.
deprecated method SetMethod(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "method" property.
deprecated method SetRateQuantity(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "rateQuantity" property.
deprecated method SetRoute(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "route" property.
deprecated method SetSite(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "site" property.
deprecated method SetText(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "text" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab