Data Model Libraries
    Preparing search index...

    Class NutritionIntakeConsumedItemComponent

    NutritionIntakeConsumedItemComponent Class

    FHIR Specification

    • Short: What food or fluid product or item was consumed
    • Definition: What food or fluid product or item was consumed.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_: null | CodeableConcept

    NutritionIntake.consumedItem.type Element

    FHIR Specification

    • Short: The type of food or fluid product
    • Definition: Indicates what a category of item that was consumed: e.g., food, fluid, enteral, etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    nutritionProduct: null | CodeableReference

    NutritionIntake.consumedItem.nutritionProduct Element

    FHIR Specification

    • Short: Code that identifies the food or fluid product that was consumed
    • Definition: Identifies the food or fluid product that was consumed. This is potentially a link to a resource representing the details of the food product (TBD) or a simple attribute carrying a code that identifies the food from a known list of foods.
    • Comment: If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of a new nutritionProduct resource is recommended.
    • FHIR Type: CodeableReference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    schedule?: Timing

    NutritionIntake.consumedItem.schedule Element

    FHIR Specification

    • Short: Scheduled frequency of consumption
    • Definition: Scheduled frequency of consumption.
    • FHIR Type: Timing
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    amount?: Quantity

    NutritionIntake.consumedItem.amount Element

    FHIR Specification

    • Short: Quantity of the specified food
    • Definition: Quantity of the specified food.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    rate?: Quantity

    NutritionIntake.consumedItem.rate Element

    FHIR Specification

    • Short: Rate at which enteral feeding was administered
    • Definition: Rate at which enteral feeding was administered.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    notConsumed?: BooleanType

    NutritionIntake.consumedItem.notConsumed Element

    FHIR Specification

    • Short: Flag to indicate if the food or fluid item was refused or otherwise not consumed
    • Definition: Indicator when a patient is in a setting where it is helpful to know if food was not consumed, such as it was refused, held (as in tube feedings), or otherwise not provided. If a consumption is being recorded from an app, such as MyFitnessPal, this indicator will likely not be used.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    notConsumedReason?: CodeableConcept

    NutritionIntake.consumedItem.notConsumedReason Element

    FHIR Specification

    • Short: Reason food or fluid was not consumed
    • Definition: Document the reason the food or fluid was not consumed, such as refused, held, etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionIntakeConsumedItemComponent

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionIntakeConsumedItemComponent

      NutritionIntakeConsumedItemComponent data model or undefined for NutritionIntakeConsumedItemComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise