Data Model Libraries
    Preparing search index...

    InventoryItemInstanceComponent Class

    FHIR Specification

    • Short: Instances or occurrences of the product
    • Definition: Instances or occurrences of the product.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    identifier?: Identifier[]

    InventoryItem.instance.identifier Element

    FHIR Specification

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

    InventoryItem.instance.lotNumber Element

    FHIR Specification

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

    InventoryItem.instance.expiry Element

    FHIR Specification

    • Short: The expiry date or date and time for the product
    • Definition: The expiry date or date and time for the product.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    subject?: Reference

    InventoryItem.instance.subject Element

    FHIR Specification

    location?: Reference

    InventoryItem.instance.location Element

    FHIR Specification

    • Short: The location that the item is associated with
    • Definition: The location that the item is associated with.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR InventoryItemInstanceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | InventoryItemInstanceComponent

      InventoryItemInstanceComponent data model or undefined for InventoryItemInstanceComponent

      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