Skip to main content

HS.FHIR.vDSTU2.Model.Resource.MedicationDispense.DosageInstruction

deprecated class HS.FHIR.vDSTU2.Model.Resource.MedicationDispense.DosageInstruction extends HS.FHIR.vDSTU2.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.

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 = MedicationDispense.DosageInstruction;
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 = 0;
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 = MedicationDispense.DosageInstruction;
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 additionalInstructions as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "additionalInstructions");
Additional instructions such as"Swallow with plenty of water" which may or may not be coded.
Property methods: additionalInstructionsGet(), additionalInstructionsGetSwizzled(), additionalInstructionsIsValid(), additionalInstructionsNewObject(), additionalInstructionsSet()
property asNeededBoolean as HS.FHIR.vDSTU2.Model.Datatype.Boolean (XMLNAME = "asNeededBoolean");
Property methods: asNeededBooleanGet(), asNeededBooleanGetSwizzled(), asNeededBooleanIsValid(), asNeededBooleanNewObject(), asNeededBooleanSet()
property asNeededCodeableConcept as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "asNeededCodeableConcept");
Property methods: asNeededCodeableConceptGet(), asNeededCodeableConceptGetSwizzled(), asNeededCodeableConceptIsValid(), asNeededCodeableConceptNewObject(), asNeededCodeableConceptSet()
property doseQuantity as HS.FHIR.vDSTU2.Model.Base.SimpleQuantity (XMLNAME = "doseQuantity");
Property methods: doseQuantityGet(), doseQuantityGetSwizzled(), doseQuantityIsValid(), doseQuantityNewObject(), doseQuantitySet()
property doseRange as HS.FHIR.vDSTU2.Model.Base.Range (XMLNAME = "doseRange");
Property methods: doseRangeGet(), doseRangeGetSwizzled(), doseRangeIsValid(), doseRangeNewObject(), doseRangeSet()
property maxDosePerPeriod as HS.FHIR.vDSTU2.Model.Base.Ratio (XMLNAME = "maxDosePerPeriod");
The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.
Property methods: maxDosePerPeriodGet(), maxDosePerPeriodGetSwizzled(), maxDosePerPeriodIsValid(), maxDosePerPeriodNewObject(), maxDosePerPeriodSet()
property method as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "method");
A coded value indicating the method by which the medication is intended to be or was introduced into or on the body.
Property methods: methodGet(), methodGetSwizzled(), methodIsValid(), methodNewObject(), methodSet()
property rateRange as HS.FHIR.vDSTU2.Model.Base.Range (XMLNAME = "rateRange");
Property methods: rateRangeGet(), rateRangeGetSwizzled(), rateRangeIsValid(), rateRangeNewObject(), rateRangeSet()
property rateRatio as HS.FHIR.vDSTU2.Model.Base.Ratio (XMLNAME = "rateRatio");
Property methods: rateRatioGet(), rateRatioGetSwizzled(), rateRatioIsValid(), rateRatioNewObject(), rateRatioSet()
property route as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "route");
A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.
Property methods: routeGet(), routeGetSwizzled(), routeIsValid(), routeNewObject(), routeSet()
property siteCodeableConcept as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "siteCodeableConcept");
Property methods: siteCodeableConceptGet(), siteCodeableConceptGetSwizzled(), siteCodeableConceptIsValid(), siteCodeableConceptNewObject(), siteCodeableConceptSet()
property siteReference as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "siteReference");
Property methods: siteReferenceGet(), siteReferenceGetSwizzled(), siteReferenceIsValid(), siteReferenceNewObject(), siteReferenceSet()
property text as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "text");
Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property timing as HS.FHIR.vDSTU2.Model.Base.Timing (XMLNAME = "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".
Property methods: timingGet(), timingGetSwizzled(), timingIsValid(), timingNewObject(), timingSet()

Methods

deprecated method SetAdditionalInstructions(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 "additionalInstructions" 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 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 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 SetSiteCodeableConcept(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 "siteCodeableConcept" property.
deprecated method SetSiteReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "siteReference" 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