Data Model Libraries
    Preparing search index...

    Class NutritionProductInstanceComponent

    NutritionProductInstanceComponent Class

    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 NutritionProduct

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    quantity? identifier? name? lotNumber? expiry? useBy? biologicalSourceEvent?

    Methods

    parse getQuantity setQuantity hasQuantity getIdentifier setIdentifier addIdentifier hasIdentifier getNameElement setNameElement hasNameElement getName setName hasName getLotNumberElement setLotNumberElement hasLotNumberElement getLotNumber setLotNumber hasLotNumber getExpiryElement setExpiryElement hasExpiryElement getExpiry setExpiry hasExpiry getUseByElement setUseByElement hasUseByElement getUseBy setUseBy hasUseBy getBiologicalSourceEvent setBiologicalSourceEvent hasBiologicalSourceEvent 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 initIdentifier

    Constructors

    Properties

    quantity?: Quantity

    NutritionProduct.instance.quantity Element

    FHIR Specification

    • Short: The amount of items or instances
    • Definition: The amount of items or instances that the resource considers, for instance when referring to 2 identical units together.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    identifier?: Identifier[]

    NutritionProduct.instance.identifier Element

    FHIR Specification

    • Short: The identifier for the physical instance, typically a serial number or manufacturer number
    • Definition: The identifier for the physical instance, typically a serial number or manufacturer number.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    name?: StringType

    NutritionProduct.instance.name Element

    FHIR Specification

    • Short: The name for the specific product
    • Definition: The name for the specific product.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lotNumber?: StringType

    NutritionProduct.instance.lotNumber Element

    FHIR Specification

    • Short: The identification of the batch or lot of the product
    • Definition: The identification of the batch or lot of the product.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    expiry?: DateTimeType

    NutritionProduct.instance.expiry Element

    FHIR Specification

    • Short: The expiry date or date and time for the product
    • Definition: The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    useBy?: DateTimeType

    NutritionProduct.instance.useBy Element

    FHIR Specification

    • Short: The date until which the product is expected to be good for consumption
    • Definition: The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    biologicalSourceEvent?: Identifier

    NutritionProduct.instance.biologicalSourceEvent Element

    FHIR Specification

    • Short: An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
    • Definition: An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.
    • Comment: Necessary to support mandatory requirements for traceability from donor/source to recipient and vice versa, while also satisfying donor anonymity requirements. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. The identifier references an event that links to a single biological entity such as a blood donor, or to multiple biological entities (e.g. when the product is an embryo or a pooled platelet product). A single biologicalSourceEvent identifier may appear on multiple products of many types derived from a single donation event or source extraction. As an example, a single donation event may provide 2 kidneys and a liver for organ transplantation, 2 corneas for eye surgery, heart valves and arterial tissue for cardiovascular surgery, multiple skin grafts, tendons, multiple shaped bone grafts and a large number of bone putty/paste products; and each of them may be assigned to the same biological source event identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR NutritionProductInstanceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | NutritionProductInstanceComponent

      NutritionProductInstanceComponent data model or undefined for NutritionProductInstanceComponent

      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
    parsegetQuantitysetQuantityhasQuantitygetIdentifiersetIdentifieraddIdentifierhasIdentifiergetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetLotNumberElementsetLotNumberElementhasLotNumberElementgetLotNumbersetLotNumberhasLotNumbergetExpiryElementsetExpiryElementhasExpiryElementgetExpirysetExpiryhasExpirygetUseByElementsetUseByElementhasUseByElementgetUseBysetUseByhasUseBygetBiologicalSourceEventsetBiologicalSourceEventhasBiologicalSourceEventfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifier