Skip to main content

HS.FHIR.vSTU3.Model.Resource.NutritionOrder.Supplement

deprecated class HS.FHIR.vSTU3.Model.Resource.NutritionOrder.Supplement extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

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 = NutritionOrder.Supplement;
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 = NutritionOrder.Supplement;
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 instruction as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "instruction", XMLPROJECTION = "ELEMENT");
Free text or additional instructions or information pertaining to the oral supplement.
Property methods: instructionGet(), instructionGetSwizzled(), instructionIsValid(), instructionNewObject(), instructionSet()
property productName as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "productName", XMLPROJECTION = "ELEMENT");
The product or brand name of the nutritional supplement such as "Acme Protein Shake".
Property methods: productNameGet(), productNameGetSwizzled(), productNameIsValid(), productNameNewObject(), productNameSet()
property quantity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");
The amount of the nutritional supplement to be given.
Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property schedule as list of HS.FHIR.vSTU3.Model.Base.Timing (XMLNAME = "schedule", XMLPROJECTION = "ELEMENT");
The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.
Property methods: scheduleBuildValueArray(), scheduleCollectionToDisplay(), scheduleCollectionToOdbc(), scheduleDisplayToCollection(), scheduleGet(), scheduleGetObject(), scheduleGetObjectId(), scheduleGetSwizzled(), scheduleIsValid(), scheduleOdbcToCollection(), scheduleSet(), scheduleSetObject(), scheduleSetObjectId()
property type as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

deprecated method SetInstruction(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 "instruction" property.
deprecated method SetProductName(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 "productName" property.
deprecated method SetQuantity(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 "quantity" property.
deprecated method SetType(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 "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab