Data Model Libraries
    Preparing search index...

    Class NutritionOrderEnteralFormulaAdditiveComponent

    NutritionOrderEnteralFormulaAdditiveComponent Class

    FHIR Specification

    • Short: Components to add to the feeding
    • Definition: Indicates modular components to be provided in addition or mixed with the base formula.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    NutritionOrder.enteralFormula.additive.type Element

    FHIR Specification

    • Short: Type of modular component to add to the feeding
    • Definition: Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    productName?: StringType

    NutritionOrder.enteralFormula.additive.productName Element

    FHIR Specification

    • Short: Product or brand name of the modular additive
    • Definition: The product or brand name of the type of modular component to be added to the formula.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    NutritionOrder.enteralFormula.additive.quantity Element

    FHIR Specification

    • Short: Amount of additive to be given or mixed in
    • Definition: The amount of additive to be given in addition or to be mixed in with the base formula.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionOrderEnteralFormulaAdditiveComponent

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionOrderEnteralFormulaAdditiveComponent

      NutritionOrderEnteralFormulaAdditiveComponent data model or undefined for NutritionOrderEnteralFormulaAdditiveComponent

      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