Data Model Libraries
    Preparing search index...

    NutritionOrderOralDietComponent Class

    FHIR Specification

    • Short: Oral diet components
    • Definition: Diet given orally in contrast to enteral (tube) feeding.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_?: CodeableConcept[]

    NutritionOrder.oralDiet.type Element

    FHIR Specification

    • Short: Type of oral diet or diet restrictions that describe what can be consumed orally
    • Definition: The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    NutritionOrder.oralDiet.schedule Element

    FHIR Specification

    • Short: Scheduling information for oral diets
    • Definition: Schedule information for an oral diet.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    NutritionOrder.oralDiet.nutrient Element

    FHIR Specification

    • Short: Required nutrient modifications
    • Definition: Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    NutritionOrder.oralDiet.texture Element

    FHIR Specification

    • Short: Required texture modifications
    • Definition: Class that describes any texture modifications required for the patient to safely consume various types of solid foods.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    fluidConsistencyType?: CodeableConcept[]

    NutritionOrder.oralDiet.fluidConsistencyType Element

    FHIR Specification

    • Short: The required consistency of fluids and liquids provided to the patient
    • Definition: The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    instruction?: StringType

    NutritionOrder.oralDiet.instruction Element

    FHIR Specification

    • Short: Instructions or additional information about the oral diet
    • Definition: Free text or additional instructions or information pertaining to the oral diet.
    • Comment: Free text dosage instructions can be used for cases where the instructions are too complex to code.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionOrderOralDietComponent

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionOrderOralDietComponent

      NutritionOrderOralDietComponent data model or undefined for NutritionOrderOralDietComponent

      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