Skip to main content

HS.FHIRModel.R4.NutritionOrderX.Supplement

class HS.FHIRModel.R4.NutritionOrderX.Supplement extends HS.FHIRModel.FHIRClassSuper

*****************************************
** NutritionOrderX.Supplement generated class schema
*****************************************
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_NUTRITIONORDERX_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.FHIRModel.R4.Element;
Extensions for instruction
Property methods: _instructionGet(), _instructionGetSwizzled(), _instructionIsValid(), _instructionNewObject(), _instructionSet()
property _productName as HS.FHIRModel.R4.Element;
Extensions for productName
Property methods: _productNameGet(), _productNameGetSwizzled(), _productNameIsValid(), _productNameNewObject(), _productNameSet()
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 instruction as %String;
Free text or additional instructions or information pertaining to the oral supplement.
Property methods: instructionDisplayToLogical(), instructionGet(), instructionIsValid(), instructionLogicalToDisplay(), instructionLogicalToOdbc(), instructionNormalize(), instructionSet()
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 productName as %String;
The product or brand name of the nutritional supplement such as "Acme Protein Shake".
Property methods: productNameDisplayToLogical(), productNameGet(), productNameIsValid(), productNameLogicalToDisplay(), productNameLogicalToOdbc(), productNameNormalize(), productNameSet()
property quantity as HS.FHIRModel.R4.Quantity;
The amount of the nutritional supplement to be given.
Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property schedule as HS.FHIRModel.R4.SeqOfTiming;
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: scheduleGet(), scheduleGetSwizzled(), scheduleIsValid(), scheduleNewObject(), scheduleSet()
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

method IncludeExtension()
method IncludeModifierExtension()
method IncludeQuantity()
method IncludeSchedule()
method IncludeType()
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
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab