Data Model Libraries
    Preparing search index...

    Class NutritionIntake

    NutritionIntake Class

    A record of food or fluid that is being consumed by a patient. A NutritionIntake may indicate that the patient may be consuming the food or fluid now or has consumed the food or fluid in the past. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay or through an app that tracks food or fluids consumed. The consumption information may come from sources such as the patient's memory, from a nutrition label, or from a clinician documenting observed intake.

    FHIR Specification

    • Short: Record of food or fluid being taken by a patient
    • Definition: A record of food or fluid that is being consumed by a patient. A NutritionIntake may indicate that the patient may be consuming the food or fluid now or has consumed the food or fluid in the past. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay or through an app that tracks food or fluids consumed. The consumption information may come from sources such as the patient's memory, from a nutrition label, or from a clinician documenting observed intake.
    • FHIR Version: 5.0.0

    FHIR NutritionIntake

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? instantiatesCanonical? instantiatesUri? basedOn? partOf? eventStatusEnum status statusReason? code? subject encounter? occurrence? recorded? reported? consumedItem ingredientLabel? performer? location? derivedFrom? reason? note?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getInstantiatesCanonicalElement setInstantiatesCanonicalElement addInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical addInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement addInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri addInstantiatesUri hasInstantiatesUri getBasedOn setBasedOn addBasedOn hasBasedOn getPartOf setPartOf addPartOf hasPartOf getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusReason setStatusReason addStatusReason hasStatusReason getCode setCode hasCode getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getOccurrence setOccurrence hasOccurrence getOccurrenceDateTimeType hasOccurrenceDateTimeType getOccurrencePeriod hasOccurrencePeriod getRecordedElement setRecordedElement hasRecordedElement getRecorded setRecorded hasRecorded getReported setReported hasReported getReportedBooleanType hasReportedBooleanType getReportedReference hasReportedReference getConsumedItem setConsumedItem addConsumedItem hasConsumedItem getIngredientLabel setIngredientLabel addIngredientLabel hasIngredientLabel getPerformer setPerformer addPerformer hasPerformer getLocation setLocation hasLocation getDerivedFrom setDerivedFrom addDerivedFrom hasDerivedFrom getReason setReason addReason hasReason getNote setNote addNote hasNote fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initInstantiatesCanonical initInstantiatesUri initBasedOn initPartOf initStatusReason initConsumedItem initIngredientLabel initPerformer initDerivedFrom initReason initNote

    Constructors

    Properties

    identifier?: Identifier[]

    NutritionIntake.identifier Element

    FHIR Specification

    • Short: External identifier
    • Definition: Identifiers associated with this Nutrition Intake that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
    • Comment: This is a business identifier, not a resource identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiatesCanonical?: CanonicalType[]

    NutritionIntake.instantiatesCanonical Element

    FHIR Specification

    instantiatesUri?: UriType[]

    NutritionIntake.instantiatesUri Element

    FHIR Specification

    • Short: Instantiates external protocol or definition
    • Definition: Instantiates external protocol or definition.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    basedOn?: Reference[]

    NutritionIntake.basedOn Element

    FHIR Specification

    partOf?: Reference[]

    NutritionIntake.partOf Element

    FHIR Specification

    eventStatusEnum: EventStatusEnum

    FHIR CodeSystem: EventStatus

    EventStatusEnum

    status: null | EnumCodeType

    NutritionIntake.status Element

    FHIR Specification

    • Short: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
    • Definition: A code representing the patient or other source's judgment about the state of the intake that this assertion is about. Generally, this will be active or completed.
    • Comment: NutritionIntake is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for NutritionIntake.status contains codes that assert the status of the consumption of the food or fluid by the patient (for example, stopped or on hold) as well as codes that assert the status of the Nutrition Intake itself (for example, entered in error). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: EventStatusEnum

    statusReason?: CodeableConcept[]

    NutritionIntake.statusReason Element

    FHIR Specification

    • Short: Reason for current status
    • Definition: Captures the reason for the current state of the NutritionIntake.
    • Comment: This is generally only used for "exception" statuses such as "not-taken", "on-hold", "cancelled" or "entered-in-error". The reason for performing the event at all is captured in reasonCode, not here.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    code?: CodeableConcept

    NutritionIntake.code Element

    FHIR Specification

    • Short: Code representing an overall type of nutrition intake
    • Definition: Overall type of nutrition intake.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    NutritionIntake.subject Element

    FHIR Specification

    encounter?: Reference

    NutritionIntake.encounter Element

    FHIR Specification

    • Short: Encounter associated with NutritionIntake
    • Definition: The encounter that establishes the context for this NutritionIntake.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    occurrence?: IDataType

    NutritionIntake.occurrence[x] Element

    @ChoiceDataTypesMeta('NutritionIntake.occurrence[x]', ['dateTime','Period',]

    FHIR Specification

    • Short: The date/time or interval when the food or fluid is/was consumed
    • Definition: The interval of time during which it is being asserted that the patient is/was consuming the food or fluid.
    • Comment: This attribute reflects the period over which the patient consumed the food fluid and is expected to be populated on the majority of NutritionIntake. If the food or fluid is still being taken and is expected to continue indefinitely at the time the usage is recorded, the "end" date will be omitted. If the end date is known, then it is included as the "end date". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.
    • FHIR Types: 'dateTime', 'Period',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    recorded?: DateTimeType

    NutritionIntake.recorded Element

    FHIR Specification

    • Short: When the intake was recorded
    • Definition: The date when the Nutrition Intake was asserted by the information source.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    reported?: IDataType

    NutritionIntake.reported[x] Element

    @ChoiceDataTypesMeta('NutritionIntake.reported[x]', ['boolean','Reference',]

    FHIR Specification

    • Short: Person or organization that provided the information about the consumption of this food or fluid
    • Definition: The person or organization that provided the information about the consumption of this food or fluid. Note: Use derivedFrom when a NutritionIntake is derived from other resources.
    • FHIR Types: 'boolean', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    consumedItem: null | NutritionIntakeConsumedItemComponent[]

    NutritionIntake.consumedItem Element

    FHIR Specification

    • Short: What food or fluid product or item was consumed
    • Definition: What food or fluid product or item was consumed.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false
    ingredientLabel?: NutritionIntakeIngredientLabelComponent[]

    NutritionIntake.ingredientLabel Element

    FHIR Specification

    • Short: Total nutrient for the whole meal, product, serving
    • Definition: Total nutrient amounts for the whole meal, product, serving, etc.
    • Comment: Individual item nutrients are not currently included in the resource and will likely end up as a reference in nutritionProduct to represent the individual items.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    performer?: NutritionIntakePerformerComponent[]

    NutritionIntake.performer Element

    FHIR Specification

    • Short: Who was performed in the intake
    • Definition: Who performed the intake and how they were involved.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    location?: Reference

    NutritionIntake.location Element

    FHIR Specification

    derivedFrom?: Reference[]

    NutritionIntake.derivedFrom Element

    FHIR Specification

    • Short: Additional supporting information
    • Definition: Allows linking the NutritionIntake to the underlying NutritionOrder, or to other information, such as AllergyIntolerance, that supports or is used to derive the NutritionIntake.
    • Comment: Likely references would be to AllergyIntolerance, Observation or QuestionnaireAnswers.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reason?: CodeableReference[]

    NutritionIntake.reason Element

    FHIR Specification

    note?: Annotation[]

    NutritionIntake.note Element

    FHIR Specification

    • Short: Further information about the consumption
    • Definition: Provides extra information about the Nutrition Intake that is not conveyed by the other attributes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionIntake

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionIntake

      NutritionIntake data model or undefined for NutritionIntake

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetInstantiatesCanonicalElementsetInstantiatesCanonicalElementaddInstantiatesCanonicalElementhasInstantiatesCanonicalElementgetInstantiatesCanonicalsetInstantiatesCanonicaladdInstantiatesCanonicalhasInstantiatesCanonicalgetInstantiatesUriElementsetInstantiatesUriElementaddInstantiatesUriElementhasInstantiatesUriElementgetInstantiatesUrisetInstantiatesUriaddInstantiatesUrihasInstantiatesUrigetBasedOnsetBasedOnaddBasedOnhasBasedOngetPartOfsetPartOfaddPartOfhasPartOfgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusReasonsetStatusReasonaddStatusReasonhasStatusReasongetCodesetCodehasCodegetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetOccurrencesetOccurrencehasOccurrencegetOccurrenceDateTimeTypehasOccurrenceDateTimeTypegetOccurrencePeriodhasOccurrencePeriodgetRecordedElementsetRecordedElementhasRecordedElementgetRecordedsetRecordedhasRecordedgetReportedsetReportedhasReportedgetReportedBooleanTypehasReportedBooleanTypegetReportedReferencehasReportedReferencegetConsumedItemsetConsumedItemaddConsumedItemhasConsumedItemgetIngredientLabelsetIngredientLabeladdIngredientLabelhasIngredientLabelgetPerformersetPerformeraddPerformerhasPerformergetLocationsetLocationhasLocationgetDerivedFromsetDerivedFromaddDerivedFromhasDerivedFromgetReasonsetReasonaddReasonhasReasongetNotesetNoteaddNotehasNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitInstantiatesCanonicalinitInstantiatesUriinitBasedOninitPartOfinitStatusReasoninitConsumedIteminitIngredientLabelinitPerformerinitDerivedFrominitReasoninitNote