Data Model Libraries
    Preparing search index...

    Class NutritionOrder

    NutritionOrder Class

    A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

    FHIR Specification

    • Short: Diet, formula or nutritional supplement request
    • Definition: A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
    • Comment: Referenced by an Order Request (workflow).
    • FHIR Version: 4.0.1

    FHIR NutritionOrder

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? instantiatesCanonical? instantiatesUri? instantiates? requestStatusEnum status requestIntentEnum intent patient encounter? dateTime orderer? allergyIntolerance? foodPreferenceModifier? excludeFoodModifier? oralDiet? supplement? enteralFormula? note?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getInstantiatesCanonicalElement setInstantiatesCanonicalElement addInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical addInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement addInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri addInstantiatesUri hasInstantiatesUri getInstantiatesElement setInstantiatesElement addInstantiatesElement hasInstantiatesElement getInstantiates setInstantiates addInstantiates hasInstantiates getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getIntentEnumType setIntentEnumType hasIntentEnumType getIntentElement setIntentElement hasIntentElement getIntent setIntent hasIntent getPatient setPatient hasPatient getEncounter setEncounter hasEncounter getDateTimeElement setDateTimeElement hasDateTimeElement getDateTime setDateTime hasDateTime getOrderer setOrderer hasOrderer getAllergyIntolerance setAllergyIntolerance addAllergyIntolerance hasAllergyIntolerance getFoodPreferenceModifier setFoodPreferenceModifier addFoodPreferenceModifier hasFoodPreferenceModifier getExcludeFoodModifier setExcludeFoodModifier addExcludeFoodModifier hasExcludeFoodModifier getOralDiet setOralDiet hasOralDiet getSupplement setSupplement addSupplement hasSupplement getEnteralFormula setEnteralFormula hasEnteralFormula getNote setNote addNote hasNote fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initInstantiatesCanonical initInstantiatesUri initInstantiates initAllergyIntolerance initFoodPreferenceModifier initExcludeFoodModifier initSupplement initNote

    Constructors

    Properties

    identifier?: Identifier[]

    NutritionOrder.identifier Element

    FHIR Specification

    • Short: Identifiers assigned to this order
    • Definition: Identifiers assigned to this order by the order sender or by the order receiver.
    • Comment: The Identifier.type element can be to indicate filler vs. placer if needed. This is explained in further detail here.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    instantiatesCanonical?: CanonicalType[]

    NutritionOrder.instantiatesCanonical Element

    FHIR Specification

    • Short: Instantiates FHIR protocol or definition
    • Definition: 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.
    • Comment: Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiatesUri?: UriType[]

    NutritionOrder.instantiatesUri Element

    FHIR Specification

    • Short: Instantiates external protocol or definition
    • Definition: 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.
    • Comment: This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiates?: UriType[]

    NutritionOrder.instantiates Element

    FHIR Specification

    • Short: Instantiates protocol or definition
    • Definition: The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    requestStatusEnum: RequestStatusEnum

    FHIR CodeSystem: RequestStatus

    RequestStatusEnum

    status: null | EnumCodeType

    NutritionOrder.status Element

    FHIR Specification

    • Short: draft | active | on-hold | revoked | completed | entered-in-error | unknown
    • Definition: The workflow status of the nutrition order/request.
    • Comment: Typically the system placing the order sets the status to "requested". Thereafter, the order is maintained by the receiver that updates the status as the request is handled. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: RequestStatusEnum

    requestIntentEnum: RequestIntentEnum

    FHIR CodeSystem: RequestIntent

    RequestIntentEnum

    intent: null | EnumCodeType

    NutritionOrder.intent Element

    FHIR Specification

    • Short: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    • Definition: Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.
    • Comment: When resources map to this element, they are free to define as many codes as necessary to cover their space and will map to "proposal, plan or order". Can have multiple codes that map to one of these. E.g. "original order", "encoded order", "reflex order" would all map to "order". Expectation is that the set of codes is mutually exclusive or a strict all-encompassing hierarchy.
    • Requirements: Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
    • isSummary: true

    CodeSystem Enumeration: RequestIntentEnum

    patient: null | Reference

    NutritionOrder.patient Element

    FHIR Specification

    • Short: The person who requires the diet, formula or nutritional supplement
    • Definition: The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    encounter?: Reference

    NutritionOrder.encounter Element

    FHIR Specification

    • Short: The encounter associated with this nutrition order
    • Definition: An encounter that provides additional information about the healthcare context in which this request is made.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    dateTime: null | DateTimeType

    NutritionOrder.dateTime Element

    FHIR Specification

    • Short: Date and time the nutrition order was requested
    • Definition: The date and time that this nutrition order was requested.
    • FHIR Type: dateTime
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    orderer?: Reference

    NutritionOrder.orderer Element

    FHIR Specification

    allergyIntolerance?: Reference[]

    NutritionOrder.allergyIntolerance Element

    FHIR Specification

    • Short: List of the patient's food and nutrition-related allergies and intolerances
    • Definition: A link to a record of allergies or intolerances which should be included in the nutrition order.
    • Comment: Information on a patient's food allergies and intolerances to inform healthcare personnel about the type of foods that the patient shouldn't receive or consume.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    foodPreferenceModifier?: CodeableConcept[]

    NutritionOrder.foodPreferenceModifier Element

    FHIR Specification

    • Short: Order-specific modifier about the type of food that should be given
    • Definition: 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.
    • Comment: Information on a patient's food preferences that inform healthcare personnel about the food that the patient should receive or consume.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    excludeFoodModifier?: CodeableConcept[]

    NutritionOrder.excludeFoodModifier Element

    FHIR Specification

    • Short: Order-specific modifier about the type of food that should not be given
    • Definition: 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.
    • Comment: Information on a patient's food allergies, intolerances and preferences to inform healthcare personnel about the type of foods that the patient shouldn't receive or consume.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    oralDiet?: NutritionOrderOralDietComponent

    NutritionOrder.oralDiet Element

    FHIR Specification

    • Short: Oral diet components
    • Definition: Diet given orally in contrast to enteral (tube) feeding.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    supplement?: NutritionOrderSupplementComponent[]

    NutritionOrder.supplement Element

    FHIR Specification

    • Short: Supplement components
    • Definition: Oral nutritional products given in order to add further nutritional value to the patient's diet.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    enteralFormula?: NutritionOrderEnteralFormulaComponent

    NutritionOrder.enteralFormula Element

    FHIR Specification

    • Short: Enteral formula components
    • Definition: Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    NutritionOrder.note Element

    FHIR Specification

    • Short: Comments
    • Definition: Comments made about the {{title}} by the requester, performer, subject or other participants.
    • Comment: This element SHALL NOT be used to supply free text instructions for the diet which are represented in the .oralDiet.instruction, supplement.instruction, or enteralFormula.administrationInstruction elements.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided NutritionOrder JSON to instantiate the NutritionOrder data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionOrder

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to NutritionOrder

      Returns undefined | NutritionOrder

      NutritionOrder data model or undefined for NutritionOrder

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetInstantiatesCanonicalElementsetInstantiatesCanonicalElementaddInstantiatesCanonicalElementhasInstantiatesCanonicalElementgetInstantiatesCanonicalsetInstantiatesCanonicaladdInstantiatesCanonicalhasInstantiatesCanonicalgetInstantiatesUriElementsetInstantiatesUriElementaddInstantiatesUriElementhasInstantiatesUriElementgetInstantiatesUrisetInstantiatesUriaddInstantiatesUrihasInstantiatesUrigetInstantiatesElementsetInstantiatesElementaddInstantiatesElementhasInstantiatesElementgetInstantiatessetInstantiatesaddInstantiateshasInstantiatesgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetIntentEnumTypesetIntentEnumTypehasIntentEnumTypegetIntentElementsetIntentElementhasIntentElementgetIntentsetIntenthasIntentgetPatientsetPatienthasPatientgetEncountersetEncounterhasEncountergetDateTimeElementsetDateTimeElementhasDateTimeElementgetDateTimesetDateTimehasDateTimegetOrderersetOrdererhasOrderergetAllergyIntolerancesetAllergyIntoleranceaddAllergyIntolerancehasAllergyIntolerancegetFoodPreferenceModifiersetFoodPreferenceModifieraddFoodPreferenceModifierhasFoodPreferenceModifiergetExcludeFoodModifiersetExcludeFoodModifieraddExcludeFoodModifierhasExcludeFoodModifiergetOralDietsetOralDiethasOralDietgetSupplementsetSupplementaddSupplementhasSupplementgetEnteralFormulasetEnteralFormulahasEnteralFormulagetNotesetNoteaddNotehasNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitInstantiatesCanonicalinitInstantiatesUriinitInstantiatesinitAllergyIntoleranceinitFoodPreferenceModifierinitExcludeFoodModifierinitSupplementinitNote