Data Model Libraries
    Preparing search index...

    InventoryItemAssociationComponent Class

    FHIR Specification

    • Short: Association with other items or products
    • Definition: Association with other items or products.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    associationType: null | CodeableConcept

    InventoryItem.association.associationType Element

    FHIR Specification

    • Short: The type of association between the device and the other item
    • Definition: This attribute defined the type of association when establishing associations or relations between items, e.g. 'packaged within' or 'used with' or 'to be mixed with.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    relatedItem: null | Reference

    InventoryItem.association.relatedItem Element

    quantity: null | Ratio

    InventoryItem.association.quantity Element

    FHIR Specification

    • Short: The quantity of the product in this product
    • Definition: The quantity of the related product in this product - Numerator is the quantity of the related product. Denominator is the quantity of the present product. For example a value of 20 means that this product contains 20 units of the related product; a value of 1:20 means the inverse - that the contained product contains 20 units of the present product.
    • FHIR Type: Ratio
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR InventoryItemAssociationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | InventoryItemAssociationComponent

      InventoryItemAssociationComponent data model or undefined for InventoryItemAssociationComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided RelatedItem object value to the relatedItem property.

      Parameters

      • value: undefined | null | Reference

        the relatedItem object value

      Returns this

      this

      @ReferenceTargets('InventoryItem.association.relatedItem', ['InventoryItem','Medication','MedicationKnowledge','Device','DeviceDefinition','NutritionProduct','BiologicallyDerivedProduct',])

      InvalidTypeError for invalid data type or reference value

    • 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 the instance is a FHIR complex or primitive datatype; false otherwise