Data Model Libraries
    Preparing search index...

    Class NutritionProduct

    NutritionProduct Class

    A food or fluid product that is consumed by patients.

    FHIR Specification

    • Short: A product used for nutritional purposes
    • Definition: A food or fluid product that is consumed by patients.
    • FHIR Version: 4.3.0

    FHIR NutritionProduct

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    nutritionproductStatusEnum status category? code? manufacturer? nutrient? ingredient? knownAllergen? productCharacteristic? instance_? note?

    Methods

    parse getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getCategory setCategory addCategory hasCategory getCode setCode hasCode getManufacturer setManufacturer addManufacturer hasManufacturer getNutrient setNutrient addNutrient hasNutrient getIngredient setIngredient addIngredient hasIngredient getKnownAllergen setKnownAllergen addKnownAllergen hasKnownAllergen getProductCharacteristic setProductCharacteristic addProductCharacteristic hasProductCharacteristic getInstance setInstance hasInstance 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 initCategory initManufacturer initNutrient initIngredient initKnownAllergen initProductCharacteristic initNote

    Constructors

    Properties

    nutritionproductStatusEnum: NutritionproductStatusEnum

    FHIR CodeSystem: NutritionproductStatus

    NutritionproductStatusEnum

    status: null | EnumCodeType

    NutritionProduct.status Element

    FHIR Specification

    • Short: active | inactive | entered-in-error
    • Definition: The current state of the product.
    • Comment: Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
    • 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: NutritionproductStatusEnum

    category?: CodeableConcept[]

    NutritionProduct.category Element

    FHIR Specification

    • Short: A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc)
    • Definition: Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    code?: CodeableConcept

    NutritionProduct.code Element

    FHIR Specification

    • Short: A code designating a specific type of nutritional product
    • Definition: The code assigned to the product, for example a manufacturer number or other terminology.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    manufacturer?: Reference[]

    NutritionProduct.manufacturer Element

    FHIR Specification

    • Short: Manufacturer, representative or officially responsible for the product
    • Definition: The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    nutrient?: NutritionProductNutrientComponent[]

    NutritionProduct.nutrient Element

    FHIR Specification

    • Short: The product's nutritional information expressed by the nutrients
    • Definition: The product's nutritional information expressed by the nutrients.
    • Comment: Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
    • Requirements: Allows identification of the {{title}} as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    ingredient?: NutritionProductIngredientComponent[]

    NutritionProduct.ingredient Element

    FHIR Specification

    • Short: Ingredients contained in this product
    • Definition: Ingredients contained in this product.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    knownAllergen?: CodeableReference[]

    NutritionProduct.knownAllergen Element

    FHIR Specification

    • Short: Known or suspected allergens that are a part of this product
    • Definition: Allergens that are known or suspected to be a part of this nutrition product.
    • FHIR Type: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    productCharacteristic?: NutritionProductProductCharacteristicComponent[]

    NutritionProduct.productCharacteristic Element

    FHIR Specification

    • Short: Specifies descriptive properties of the nutrition product
    • Definition: Specifies descriptive properties of the nutrition product.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Private Optionalinstance_

    instance_?: NutritionProductInstanceComponent

    NutritionProduct.instance Element

    FHIR Specification

    • Short: One or several physical instances or occurrences of the nutrition product
    • Definition: Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    NutritionProduct.note Element

    FHIR Specification

    • Short: Comments made about the product
    • Definition: Comments made about the product.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionProduct

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionProduct

      NutritionProduct data model or undefined for NutritionProduct

      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
    parsegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetCategorysetCategoryaddCategoryhasCategorygetCodesetCodehasCodegetManufacturersetManufactureraddManufacturerhasManufacturergetNutrientsetNutrientaddNutrienthasNutrientgetIngredientsetIngredientaddIngredienthasIngredientgetKnownAllergensetKnownAllergenaddKnownAllergenhasKnownAllergengetProductCharacteristicsetProductCharacteristicaddProductCharacteristichasProductCharacteristicgetInstancesetInstancehasInstancegetNotesetNoteaddNotehasNotefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitCategoryinitManufacturerinitNutrientinitIngredientinitKnownAllergeninitProductCharacteristicinitNote