Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.NutritionOrder

class HS.FHIR.DTL.vR4.Model.Resource.NutritionOrder extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Diet, formula or nutritional supplement request.

Property 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 XMLNAME = NutritionOrder;
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 XMLPROJECTION = ELEMENT;
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;
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 allergyIntolerance as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "allergyIntolerance", XMLPROJECTION = "ELEMENT");
Reference

List of the patient's food and nutrition-related allergies and intolerances.

AllergyIntolerance

Property methods: allergyIntoleranceBuildValueArray(), allergyIntoleranceCollectionToDisplay(), allergyIntoleranceCollectionToOdbc(), allergyIntoleranceDisplayToCollection(), allergyIntoleranceGet(), allergyIntoleranceGetObject(), allergyIntoleranceGetObjectId(), allergyIntoleranceGetSwizzled(), allergyIntoleranceIsValid(), allergyIntoleranceOdbcToCollection(), allergyIntoleranceSet(), allergyIntoleranceSetObject(), allergyIntoleranceSetObjectId()
property dateTime as %String (MAXLEN = 1000000, XMLNAME = "dateTime", XMLPROJECTION = "ATTRIBUTE") [ Required ];
dateTime

Date and time the nutrition order was requested.

Property methods: dateTimeDisplayToLogical(), dateTimeGet(), dateTimeIsValid(), dateTimeLogicalToDisplay(), dateTimeLogicalToOdbc(), dateTimeNormalize(), dateTimeSet()
property encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

The encounter associated with this nutrition order.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property enteralFormula as HS.FHIR.DTL.vR4.Model.Element.NutritionOrder.enteralFormula (XMLNAME = "enteralFormula", XMLPROJECTION = "ELEMENT");
BackboneElement

Enteral formula components.

Property methods: enteralFormulaGet(), enteralFormulaGetSwizzled(), enteralFormulaIsValid(), enteralFormulaNewObject(), enteralFormulaSet()
property excludeFoodModifier as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "excludeFoodModifier", XMLPROJECTION = "ELEMENT");
CodeableConcept

Order-specific modifier about the type of food that should not be given.

any FHIR4 code may be used; food-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: excludeFoodModifierBuildValueArray(), excludeFoodModifierCollectionToDisplay(), excludeFoodModifierCollectionToOdbc(), excludeFoodModifierDisplayToCollection(), excludeFoodModifierGet(), excludeFoodModifierGetObject(), excludeFoodModifierGetObjectId(), excludeFoodModifierGetSwizzled(), excludeFoodModifierIsValid(), excludeFoodModifierOdbcToCollection(), excludeFoodModifierSet(), excludeFoodModifierSetObject(), excludeFoodModifierSetObjectId()
property foodPreferenceModifier as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "foodPreferenceModifier", XMLPROJECTION = "ELEMENT");
CodeableConcept

Order-specific modifier about the type of food that should be given.

any FHIR4 code may be used; encounter-diet shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: foodPreferenceModifierBuildValueArray(), foodPreferenceModifierCollectionToDisplay(), foodPreferenceModifierCollectionToOdbc(), foodPreferenceModifierDisplayToCollection(), foodPreferenceModifierGet(), foodPreferenceModifierGetObject(), foodPreferenceModifierGetObjectId(), foodPreferenceModifierGetSwizzled(), foodPreferenceModifierIsValid(), foodPreferenceModifierOdbcToCollection(), foodPreferenceModifierSet(), foodPreferenceModifierSetObject(), foodPreferenceModifierSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Identifiers assigned to this order.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property instantiates as list of %String (MAXLEN = 1000000, XMLNAME = "instantiates", XMLPROJECTION = "ELEMENT");
uri

Instantiates protocol or definition.

Property methods: instantiatesBuildValueArray(), instantiatesCanonicalBuildValueArray(), instantiatesCanonicalCollectionToDisplay(), instantiatesCanonicalCollectionToOdbc(), instantiatesCanonicalDisplayToCollection(), instantiatesCanonicalDisplayToLogical(), instantiatesCanonicalGet(), instantiatesCanonicalGetObject(), instantiatesCanonicalGetObjectId(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalLogicalToDisplay(), instantiatesCanonicalLogicalToOdbc(), instantiatesCanonicalNormalize(), instantiatesCanonicalOdbcToCollection(), instantiatesCanonicalSet(), instantiatesCanonicalSetObject(), instantiatesCanonicalSetObjectId(), instantiatesCollectionToDisplay(), instantiatesCollectionToOdbc(), instantiatesDisplayToCollection(), instantiatesDisplayToLogical(), instantiatesGet(), instantiatesGetObject(), instantiatesGetObjectId(), instantiatesGetSwizzled(), instantiatesIsValid(), instantiatesLogicalToDisplay(), instantiatesLogicalToOdbc(), instantiatesNormalize(), instantiatesOdbcToCollection(), instantiatesSet(), instantiatesSetObject(), instantiatesSetObjectId(), instantiatesUriBuildValueArray(), instantiatesUriCollectionToDisplay(), instantiatesUriCollectionToOdbc(), instantiatesUriDisplayToCollection(), instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriGetObject(), instantiatesUriGetObjectId(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriOdbcToCollection(), instantiatesUriSet(), instantiatesUriSetObject(), instantiatesUriSetObjectId()
property instantiatesCanonical as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesCanonical", XMLPROJECTION = "ELEMENT");
canonical

Instantiates FHIR protocol or definition.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: instantiatesCanonicalBuildValueArray(), instantiatesCanonicalCollectionToDisplay(), instantiatesCanonicalCollectionToOdbc(), instantiatesCanonicalDisplayToCollection(), instantiatesCanonicalDisplayToLogical(), instantiatesCanonicalGet(), instantiatesCanonicalGetObject(), instantiatesCanonicalGetObjectId(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalLogicalToDisplay(), instantiatesCanonicalLogicalToOdbc(), instantiatesCanonicalNormalize(), instantiatesCanonicalOdbcToCollection(), instantiatesCanonicalSet(), instantiatesCanonicalSetObject(), instantiatesCanonicalSetObjectId()
property instantiatesUri as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesUri", XMLPROJECTION = "ELEMENT");
uri

Instantiates external protocol or definition.

Property methods: instantiatesUriBuildValueArray(), instantiatesUriCollectionToDisplay(), instantiatesUriCollectionToOdbc(), instantiatesUriDisplayToCollection(), instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriGetObject(), instantiatesUriGetObjectId(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriOdbcToCollection(), instantiatesUriSet(), instantiatesUriSetObject(), instantiatesUriSetObjectId()
property intent as %String (MAXLEN = 1000000, XMLNAME = "intent", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option

request-intent|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend request-intent|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Comments.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property oralDiet as HS.FHIR.DTL.vR4.Model.Element.NutritionOrder.oralDiet (XMLNAME = "oralDiet", XMLPROJECTION = "ELEMENT");
BackboneElement

Oral diet components.

Property methods: oralDietGet(), oralDietGetSwizzled(), oralDietIsValid(), oralDietNewObject(), oralDietSet()
property orderer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "orderer", XMLPROJECTION = "ELEMENT");
Reference

Who ordered the diet, formula or nutritional supplement.

Practitioner | PractitionerRole

Property methods: ordererGet(), ordererGetSwizzled(), ordererIsValid(), ordererNewObject(), ordererSet()
property patient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

The person who requires the diet, formula or nutritional supplement.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | on-hold | revoked | completed | entered-in-error | unknown

request-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend request-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property supplement as list of HS.FHIR.DTL.vR4.Model.Element.NutritionOrder.supplement (XMLNAME = "supplement", XMLPROJECTION = "ELEMENT");
BackboneElement

Supplement components.

Property methods: supplementBuildValueArray(), supplementCollectionToDisplay(), supplementCollectionToOdbc(), supplementDisplayToCollection(), supplementGet(), supplementGetObject(), supplementGetObjectId(), supplementGetSwizzled(), supplementIsValid(), supplementOdbcToCollection(), supplementSet(), supplementSetObject(), supplementSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab