HS.FHIRModel.R4.NutritionOrder
class HS.FHIRModel.R4.NutritionOrder extends HS.FHIRModel.FHIRClassSuper
******************************************* NutritionOrder generated class schema
*****************************************
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
Property Inventory
- _dateTime
- _implicitRules
- _instantiates
- _instantiatesUri
- _intent
- _language
- _status
- allergyIntolerance
- contained
- dateTime
- encounter
- enteralFormula
- excludeFoodModifier
- extension
- fhirID
- foodPreferenceModifier
- identifier
- implicitRules
- instantiates
- instantiatesCanonical
- instantiatesUri
- intent
- language
- meta
- modifierExtension
- note
- oralDiet
- orderer
- patient
- resourceType
- status
- supplement
- text
Method Inventory
- IncludeAllergyIntolerance()
- IncludeContained()
- IncludeEncounter()
- IncludeEnteralFormula()
- IncludeExcludeFoodModifier()
- IncludeExtension()
- IncludeFoodPreferenceModifier()
- IncludeIdentifier()
- IncludeInstantiates()
- IncludeInstantiatesCanonical()
- IncludeInstantiatesUri()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeNote()
- IncludeOralDiet()
- IncludeOrderer()
- IncludePatient()
- IncludeSupplement()
- IncludeText()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_NUTRITIONORDER;
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 _dateTime as HS.FHIRModel.R4.Element;
Extensions for dateTime
Property methods: _dateTimeGet(), _dateTimeGetSwizzled(), _dateTimeIsValid(), _dateTimeNewObject(), _dateTimeSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instantiates as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiates
Property methods: _instantiatesGet(), _instantiatesGetSwizzled(), _instantiatesIsValid(), _instantiatesNewObject(), _instantiatesSet()
property _instantiatesUri as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiatesUri
Property methods: _instantiatesUriGet(), _instantiatesUriGetSwizzled(), _instantiatesUriIsValid(), _instantiatesUriNewObject(), _instantiatesUriSet()
property _intent as HS.FHIRModel.R4.Element;
Extensions for intent
Property methods: _intentGet(), _intentGetSwizzled(), _intentIsValid(), _intentNewObject(), _intentSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property allergyIntolerance as HS.FHIRModel.R4.SeqOfReference;
A link to a record of allergies or intolerances which should be
included in the nutrition order.
Property methods: allergyIntoleranceGet(), allergyIntoleranceGetSwizzled(), allergyIntoleranceIsValid(), allergyIntoleranceNewObject(), allergyIntoleranceSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property dateTime as %String;
The date and time that this nutrition order was requested.
Property methods: dateTimeDisplayToLogical(), dateTimeGet(), dateTimeIsValid(), dateTimeLogicalToDisplay(), dateTimeLogicalToOdbc(), dateTimeNormalize(), dateTimeSet()
property encounter as HS.FHIRModel.R4.Reference;
An encounter that provides additional information about the healthcare
context in which this request is made.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property enteralFormula as HS.FHIRModel.R4.NutritionOrderX.EnteralFormula;
Feeding provided through the gastrointestinal tract via a tube, catheter,
or stoma that delivers nutrition distal to the oral cavity.
Property methods: enteralFormulaGet(), enteralFormulaGetSwizzled(), enteralFormulaIsValid(), enteralFormulaNewObject(), enteralFormulaSet()
property excludeFoodModifier as HS.FHIRModel.R4.SeqOfCodeableConcept;
This modifier is used to convey Order-specific modifier about the
type of oral food or oral fluids that should not be given. These
can be derived from patient allergies, intolerances, or preferences
such as No Red Meat, No Soy or No Wheat or Gluten-Free. While
it should not be necessary to repeat allergy or intolerance information
captured in the referenced AllergyIntolerance resource in the excludeFoodModifier,
this element may be used to convey additional specificity related
to foods that should be eliminated from the patientâs diet for
any reason. This modifier applies to the entire nutrition order
inclusive of the oral diet, nutritional supplements and enteral
formula feedings.
Property methods: excludeFoodModifierGet(), excludeFoodModifierGetSwizzled(), excludeFoodModifierIsValid(), excludeFoodModifierNewObject(), excludeFoodModifierSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. 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;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property foodPreferenceModifier as HS.FHIRModel.R4.SeqOfCodeableConcept;
This modifier is used to convey order-specific modifiers about the
type of food that should be given. These can be derived from patient
allergies, intolerances, or preferences such as Halal, Vegan or
Kosher. This modifier applies to the entire nutrition order inclusive
of the oral diet, nutritional supplements and enteral formula feedings.
Property methods: foodPreferenceModifierGet(), foodPreferenceModifierGetSwizzled(), foodPreferenceModifierIsValid(), foodPreferenceModifierNewObject(), foodPreferenceModifierSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifiers assigned to this order by the order sender or by the
order receiver.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property instantiates as HS.FHIRModel.R4.SeqOfString;
The URL pointing to a protocol, guideline, orderset or other definition
that is adhered to in whole or in part by this NutritionOrder.
Property methods: instantiatesGet(), instantiatesGetSwizzled(), instantiatesIsValid(), instantiatesNewObject(), instantiatesSet()
property instantiatesCanonical as HS.FHIRModel.R4.SeqOfString;
The URL pointing to a FHIR-defined protocol, guideline, orderset
or other definition that is adhered to in whole or in part by this
NutritionOrder.
Property methods: instantiatesCanonicalGet(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalNewObject(), instantiatesCanonicalSet()
property instantiatesUri as HS.FHIRModel.R4.SeqOfString;
The URL pointing to an externally maintained protocol, guideline,
orderset or other definition that is adhered to in whole or in part
by this NutritionOrder.
Property methods: instantiatesUriGet(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriNewObject(), instantiatesUriSet()
property intent as %String;
Indicates the level of authority/intentionality associated with the
NutrionOrder and where the request fits into the workflow chain.
Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it 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 is allowed to 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 note as HS.FHIRModel.R4.SeqOfAnnotation;
Comments made about the {{title}} by the requester, performer, subject
or other participants.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property oralDiet as HS.FHIRModel.R4.NutritionOrderX.OralDiet;
Diet given orally in contrast to enteral (tube) feeding.
Property methods: oralDietGet(), oralDietGetSwizzled(), oralDietIsValid(), oralDietNewObject(), oralDietSet()
property orderer as HS.FHIRModel.R4.Reference;
The practitioner that holds legal responsibility for ordering the
diet, nutritional supplement, or formula feedings.
Property methods: ordererGet(), ordererGetSwizzled(), ordererIsValid(), ordererNewObject(), ordererSet()
property patient as HS.FHIRModel.R4.Reference [ Required ];
The person (patient) who needs the nutrition order for an oral diet,
nutritional supplement and/or enteral or formula feeding.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property resourceType as %String [ InitialExpression = "NutritionOrder" , Required ];
This is a NutritionOrder resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String;
The workflow status of the nutrition order/request.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property supplement as HS.FHIRModel.R4.NutritionOrderX.SeqOfNutritionOrderXSupplement;
Oral nutritional products given in order to add further nutritional
value to the patient's diet.
Property methods: supplementGet(), supplementGetSwizzled(), supplementIsValid(), supplementNewObject(), supplementSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
Methods
method IncludeAllergyIntolerance()
method IncludeContained()
method IncludeEncounter()
method IncludeEnteralFormula()
method IncludeExcludeFoodModifier()
method IncludeExtension()
method IncludeFoodPreferenceModifier()
method IncludeIdentifier()
method IncludeInstantiates()
method IncludeInstantiatesCanonical()
method IncludeInstantiatesUri()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeOralDiet()
method IncludeOrderer()
method IncludePatient()
method IncludeSupplement()
method IncludeText()
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
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.NutritionOrder
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()