Data Model Libraries
    Preparing search index...

    Class NutritionOrderEnteralFormulaComponent

    NutritionOrderEnteralFormulaComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    baseFormulaType?: CodeableReference

    NutritionOrder.enteralFormula.baseFormulaType Element

    FHIR Specification

    • Short: Type of enteral or infant formula
    • Definition: The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    baseFormulaProductName?: StringType

    NutritionOrder.enteralFormula.baseFormulaProductName Element

    FHIR Specification

    • Short: Product or brand name of the enteral or infant formula
    • Definition: The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula".
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    deliveryDevice?: CodeableReference[]

    NutritionOrder.enteralFormula.deliveryDevice Element

    FHIR Specification

    • Short: Intended type of device for the administration
    • Definition: The intended type of device that is to be used for the administration of the enteral formula.
    • FHIR Type: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    NutritionOrder.enteralFormula.additive Element

    FHIR Specification

    • Short: Components to add to the feeding
    • Definition: Indicates modular components to be provided in addition or mixed with the base formula.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    caloricDensity?: Quantity

    NutritionOrder.enteralFormula.caloricDensity Element

    FHIR Specification

    • Short: Amount of energy per specified volume that is required
    • Definition: The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    routeOfAdministration?: CodeableConcept

    NutritionOrder.enteralFormula.routeOfAdministration Element

    FHIR Specification

    • Short: How the formula should enter the patient's gastrointestinal tract
    • Definition: The route or physiological path of administration into the patient's gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    NutritionOrder.enteralFormula.administration Element

    FHIR Specification

    • Short: Formula feeding instruction as structured data
    • Definition: Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.
    • Comment: See implementation notes below for further discussion on how to order continuous vs bolus enteral feeding using this resource.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    maxVolumeToDeliver?: Quantity

    NutritionOrder.enteralFormula.maxVolumeToDeliver Element

    FHIR Specification

    • Short: Upper limit on formula volume per unit of time
    • Definition: The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    administrationInstruction?: MarkdownType

    NutritionOrder.enteralFormula.administrationInstruction Element

    FHIR Specification

    • Short: Formula feeding instructions expressed as text
    • Definition: Free text formula administration, feeding instructions or additional instructions or information.
    • Comment: Free text dosage instructions can be used for cases where the instructions are too complex to code.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionOrderEnteralFormulaComponent

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionOrderEnteralFormulaComponent

      NutritionOrderEnteralFormulaComponent data model or undefined for NutritionOrderEnteralFormulaComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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