Package ca.uhn.hl7v2.model.v251.segment

Class IIM

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v251.segment.IIM
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class IIM extends AbstractSegment

Represents an HL7 IIM message segment (Inventory Item Master). This segment has the following fields:

  • IIM-1: Primary Key Value - IIM (CWE)
  • IIM-2: Service Item Code (CWE)
  • IIM-3: Inventory Lot Number (ST) optional
  • IIM-4: Inventory Expiration Date (TS) optional
  • IIM-5: Inventory Manufacturer Name (CWE) optional
  • IIM-6: Inventory Location (CWE) optional
  • IIM-7: Inventory Received Date (TS) optional
  • IIM-8: Inventory Received Quantity (NM) optional
  • IIM-9: Inventory Received Quantity Unit (CWE) optional
  • IIM-10: Inventory Received Item Cost (MO) optional
  • IIM-11: Inventory On Hand Date (TS) optional
  • IIM-12: Inventory On Hand Quantity (NM) optional
  • IIM-13: Inventory On Hand Quantity Unit (CWE) optional
  • IIM-14: Procedure Code (CE) optional
  • IIM-15: Procedure Code Modifier (CE) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getPrimaryKeyValueIIM

      public CWE getPrimaryKeyValueIIM()
      Returns IIM-1: "Primary Key Value - IIM" - creates it if necessary

    • getIim1_PrimaryKeyValueIIM

      public CWE getIim1_PrimaryKeyValueIIM()
      Returns IIM-1: "Primary Key Value - IIM" - creates it if necessary

    • getServiceItemCode

      public CWE getServiceItemCode()
      Returns IIM-2: "Service Item Code" - creates it if necessary

    • getIim2_ServiceItemCode

      public CWE getIim2_ServiceItemCode()
      Returns IIM-2: "Service Item Code" - creates it if necessary

    • getInventoryLotNumber

      public ST getInventoryLotNumber()
      Returns IIM-3: "Inventory Lot Number" - creates it if necessary

    • getIim3_InventoryLotNumber

      public ST getIim3_InventoryLotNumber()
      Returns IIM-3: "Inventory Lot Number" - creates it if necessary

    • getInventoryExpirationDate

      public TS getInventoryExpirationDate()
      Returns IIM-4: "Inventory Expiration Date" - creates it if necessary

    • getIim4_InventoryExpirationDate

      public TS getIim4_InventoryExpirationDate()
      Returns IIM-4: "Inventory Expiration Date" - creates it if necessary

    • getInventoryManufacturerName

      public CWE getInventoryManufacturerName()
      Returns IIM-5: "Inventory Manufacturer Name" - creates it if necessary

    • getIim5_InventoryManufacturerName

      public CWE getIim5_InventoryManufacturerName()
      Returns IIM-5: "Inventory Manufacturer Name" - creates it if necessary

    • getInventoryLocation

      public CWE getInventoryLocation()
      Returns IIM-6: "Inventory Location" - creates it if necessary

    • getIim6_InventoryLocation

      public CWE getIim6_InventoryLocation()
      Returns IIM-6: "Inventory Location" - creates it if necessary

    • getInventoryReceivedDate

      public TS getInventoryReceivedDate()
      Returns IIM-7: "Inventory Received Date" - creates it if necessary

    • getIim7_InventoryReceivedDate

      public TS getIim7_InventoryReceivedDate()
      Returns IIM-7: "Inventory Received Date" - creates it if necessary

    • getInventoryReceivedQuantity

      public NM getInventoryReceivedQuantity()
      Returns IIM-8: "Inventory Received Quantity" - creates it if necessary

    • getIim8_InventoryReceivedQuantity

      public NM getIim8_InventoryReceivedQuantity()
      Returns IIM-8: "Inventory Received Quantity" - creates it if necessary

    • getInventoryReceivedQuantityUnit

      public CWE getInventoryReceivedQuantityUnit()
      Returns IIM-9: "Inventory Received Quantity Unit" - creates it if necessary

    • getIim9_InventoryReceivedQuantityUnit

      public CWE getIim9_InventoryReceivedQuantityUnit()
      Returns IIM-9: "Inventory Received Quantity Unit" - creates it if necessary

    • getInventoryReceivedItemCost

      public MO getInventoryReceivedItemCost()
      Returns IIM-10: "Inventory Received Item Cost" - creates it if necessary

    • getIim10_InventoryReceivedItemCost

      public MO getIim10_InventoryReceivedItemCost()
      Returns IIM-10: "Inventory Received Item Cost" - creates it if necessary

    • getInventoryOnHandDate

      public TS getInventoryOnHandDate()
      Returns IIM-11: "Inventory On Hand Date" - creates it if necessary

    • getIim11_InventoryOnHandDate

      public TS getIim11_InventoryOnHandDate()
      Returns IIM-11: "Inventory On Hand Date" - creates it if necessary

    • getInventoryOnHandQuantity

      public NM getInventoryOnHandQuantity()
      Returns IIM-12: "Inventory On Hand Quantity" - creates it if necessary

    • getIim12_InventoryOnHandQuantity

      public NM getIim12_InventoryOnHandQuantity()
      Returns IIM-12: "Inventory On Hand Quantity" - creates it if necessary

    • getInventoryOnHandQuantityUnit

      public CWE getInventoryOnHandQuantityUnit()
      Returns IIM-13: "Inventory On Hand Quantity Unit" - creates it if necessary

    • getIim13_InventoryOnHandQuantityUnit

      public CWE getIim13_InventoryOnHandQuantityUnit()
      Returns IIM-13: "Inventory On Hand Quantity Unit" - creates it if necessary

    • getProcedureCode

      public CE getProcedureCode()
      Returns IIM-14: "Procedure Code" - creates it if necessary

    • getIim14_ProcedureCode

      public CE getIim14_ProcedureCode()
      Returns IIM-14: "Procedure Code" - creates it if necessary

    • getProcedureCodeModifier

      public CE[] getProcedureCodeModifier()
      Returns all repetitions of Procedure Code Modifier (IIM-15).

    • getIim15_ProcedureCodeModifier

      public CE[] getIim15_ProcedureCodeModifier()
      Returns all repetitions of Procedure Code Modifier (IIM-15).

    • getProcedureCodeModifierReps

      public int getProcedureCodeModifierReps()
      Returns a count of the current number of repetitions of Procedure Code Modifier (IIM-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getProcedureCodeModifier

      public CE getProcedureCodeModifier(int rep)
      Returns a specific repetition of IIM-15: "Procedure Code Modifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIim15_ProcedureCodeModifier

      public CE getIim15_ProcedureCodeModifier(int rep)
      Returns a specific repetition of IIM-15: "Procedure Code Modifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIim15_ProcedureCodeModifierReps

      public int getIim15_ProcedureCodeModifierReps()
      Returns a count of the current number of repetitions of Procedure Code Modifier (IIM-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertProcedureCodeModifier

      public CE insertProcedureCodeModifier(int rep) throws HL7Exception
      Inserts a repetition of IIM-15: "Procedure Code Modifier" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertIim15_ProcedureCodeModifier

      public CE insertIim15_ProcedureCodeModifier(int rep) throws HL7Exception
      Inserts a repetition of IIM-15: "Procedure Code Modifier" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeProcedureCodeModifier

      public CE removeProcedureCodeModifier(int rep) throws HL7Exception
      Removes a repetition of IIM-15: "Procedure Code Modifier" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeIim15_ProcedureCodeModifier

      public CE removeIim15_ProcedureCodeModifier(int rep) throws HL7Exception
      Removes a repetition of IIM-15: "Procedure Code Modifier" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment