Data Model Libraries
    Preparing search index...

    Class NutritionProductNutrientComponent

    NutritionProductNutrientComponent Class

    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 NutritionProduct

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    item? amount?

    Methods

    parse getItem setItem hasItem getAmount setAmount addAmount hasAmount fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initAmount

    Constructors

    Properties

    item?: CodeableReference

    NutritionProduct.nutrient.item Element

    FHIR Specification

    • Short: The (relevant) nutrients in the product
    • Definition: The (relevant) nutrients in the product.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    amount?: Ratio[]

    NutritionProduct.nutrient.amount Element

    FHIR Specification

    • Short: The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
    • Definition: The amount of nutrient expressed in one or more units: X per pack / per serving / per dose.
    • FHIR Type: Ratio
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionProductNutrientComponent

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionProductNutrientComponent

      NutritionProductNutrientComponent data model or undefined for NutritionProductNutrientComponent

      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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods