Data Model Libraries
    Preparing search index...

    Class NutritionOrderEnteralFormulaAdministrationComponent

    NutritionOrderEnteralFormulaAdministrationComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    NutritionOrder.enteralFormula.administration.schedule Element

    FHIR Specification

    • Short: Scheduling information for enteral formula products
    • Definition: Schedule information for an enteral formula.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    NutritionOrder.enteralFormula.administration.quantity Element

    FHIR Specification

    • Short: The volume of formula to provide
    • Definition: The volume of formula to provide to the patient per the specified administration schedule.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    rate?: IDataType

    NutritionOrder.enteralFormula.administration.rate[x] Element

    @ChoiceDataTypesMeta('NutritionOrder.enteralFormula.administration.rate[x]', ['Quantity','Ratio',]

    FHIR Specification

    • Short: Speed with which the formula is provided per period of time
    • Definition: The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.
    • Comment: Ratio is used when the quantity value in the denominator is not "1", otherwise use Quantity. For example, the Ratio datatype is used for "200 mL/4 hrs" versus the Quantity datatype for "50 mL/hr".
    • FHIR Types: 'Quantity', 'Ratio',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionOrderEnteralFormulaAdministrationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionOrderEnteralFormulaAdministrationComponent

      NutritionOrderEnteralFormulaAdministrationComponent data model or undefined for NutritionOrderEnteralFormulaAdministrationComponent

      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