Skip to main content

HS.FHIR.vSTU3.Model.Base.Dosage

deprecated class HS.FHIR.vSTU3.Model.Base.Dosage extends HS.FHIR.vSTU3.Model.Base.Element

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Indicates how the medication is/was taken or should be taken by the patient.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

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 = 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.

Properties

property additionalInstruction as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "additionalInstruction", XMLPROJECTION = "ELEMENT");
Supplemental instruction - e.g. "with meals".
Property methods: additionalInstructionBuildValueArray(), additionalInstructionCollectionToDisplay(), additionalInstructionCollectionToOdbc(), additionalInstructionDisplayToCollection(), additionalInstructionGet(), additionalInstructionGetObject(), additionalInstructionGetObjectId(), additionalInstructionGetSwizzled(), additionalInstructionIsValid(), additionalInstructionOdbcToCollection(), additionalInstructionSet(), additionalInstructionSetObject(), additionalInstructionSetObjectId()
property asNeededBoolean as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "asNeededBoolean", XMLPROJECTION = "ELEMENT");
Property methods: asNeededBooleanGet(), asNeededBooleanGetSwizzled(), asNeededBooleanIsValid(), asNeededBooleanNewObject(), asNeededBooleanSet()
property asNeededCodeableConcept as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "asNeededCodeableConcept", XMLPROJECTION = "ELEMENT");
Property methods: asNeededCodeableConceptGet(), asNeededCodeableConceptGetSwizzled(), asNeededCodeableConceptIsValid(), asNeededCodeableConceptNewObject(), asNeededCodeableConceptSet()
property doseQuantity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "doseQuantity", XMLPROJECTION = "ELEMENT");
Property methods: doseQuantityGet(), doseQuantityGetSwizzled(), doseQuantityIsValid(), doseQuantityNewObject(), doseQuantitySet()
property doseRange as HS.FHIR.vSTU3.Model.Base.Range (XMLNAME = "doseRange", XMLPROJECTION = "ELEMENT");
Property methods: doseRangeGet(), doseRangeGetSwizzled(), doseRangeIsValid(), doseRangeNewObject(), doseRangeSet()
property maxDosePerAdministration as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "maxDosePerAdministration", XMLPROJECTION = "ELEMENT");
Upper limit on medication per administration.
Property methods: maxDosePerAdministrationGet(), maxDosePerAdministrationGetSwizzled(), maxDosePerAdministrationIsValid(), maxDosePerAdministrationNewObject(), maxDosePerAdministrationSet()
property maxDosePerLifetime as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "maxDosePerLifetime", XMLPROJECTION = "ELEMENT");
Upper limit on medication per lifetime of the patient.
Property methods: maxDosePerLifetimeGet(), maxDosePerLifetimeGetSwizzled(), maxDosePerLifetimeIsValid(), maxDosePerLifetimeNewObject(), maxDosePerLifetimeSet()
property maxDosePerPeriod as HS.FHIR.vSTU3.Model.Base.Ratio (XMLNAME = "maxDosePerPeriod", XMLPROJECTION = "ELEMENT");
Upper limit on medication per unit of time.
Property methods: maxDosePerPeriodGet(), maxDosePerPeriodGetSwizzled(), maxDosePerPeriodIsValid(), maxDosePerPeriodNewObject(), maxDosePerPeriodSet()
property method as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "method", XMLPROJECTION = "ELEMENT");
Technique for administering medication.
Property methods: methodGet(), methodGetSwizzled(), methodIsValid(), methodNewObject(), methodSet()
property patientInstruction as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "patientInstruction", XMLPROJECTION = "ELEMENT");
Instructions in terms that are understood by the patient or consumer.
Property methods: patientInstructionGet(), patientInstructionGetSwizzled(), patientInstructionIsValid(), patientInstructionNewObject(), patientInstructionSet()
property rateQuantity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "rateQuantity", XMLPROJECTION = "ELEMENT");
Property methods: rateQuantityGet(), rateQuantityGetSwizzled(), rateQuantityIsValid(), rateQuantityNewObject(), rateQuantitySet()
property rateRange as HS.FHIR.vSTU3.Model.Base.Range (XMLNAME = "rateRange", XMLPROJECTION = "ELEMENT");
Property methods: rateRangeGet(), rateRangeGetSwizzled(), rateRangeIsValid(), rateRangeNewObject(), rateRangeSet()
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");
How drug should enter body.
Property methods: routeGet(), routeGetSwizzled(), routeIsValid(), routeNewObject(), routeSet()
property sequence as HS.FHIR.vSTU3.Model.Datatype.Integer (XMLNAME = "sequence", XMLPROJECTION = "ELEMENT");
Indicates the order in which the dosage instructions should be applied or interpreted.
Property methods: sequenceGet(), sequenceGetSwizzled(), sequenceIsValid(), sequenceNewObject(), sequenceSet()
property site as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "site", XMLPROJECTION = "ELEMENT");
Body site to administer to.
Property methods: siteGet(), siteGetSwizzled(), siteIsValid(), siteNewObject(), siteSet()
property text as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "text", XMLPROJECTION = "ELEMENT");
Free text dosage instructions e.g. SIG.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property timing as HS.FHIR.vSTU3.Model.Base.Timing (XMLNAME = "timing", XMLPROJECTION = "ELEMENT");
When medication should be administered.
Property methods: timingGet(), timingGetSwizzled(), timingIsValid(), timingNewObject(), timingSet()

Methods

deprecated method SetAdditionalInstruction(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.
Insert method for the "additionalInstruction" property.
deprecated method SetAsNeededBoolean(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 "asNeededBoolean" property.
deprecated method SetAsNeededCodeableConcept(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 "asNeededCodeableConcept" property.
deprecated method SetDoseQuantity(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 "doseQuantity" property.
deprecated method SetMaxDosePerAdministration(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 "maxDosePerAdministration" property.
deprecated method SetMaxDosePerLifetime(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 "maxDosePerLifetime" 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 SetPatientInstruction(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 "patientInstruction" 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 SetSequence(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 "sequence" 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