ca.uhn.hl7v2.model.v24.segment
Class INV

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.INV

All Implemented Interfaces:

Segment, Structure, Serializable

public class INV
extends AbstractSegment

Represents an HL7 INV message segment (Inventory Detail). This segment has the following fields:

• INV-1: Substance Identifier (CE)
• INV-2: Substance Status (CE) repeating
• INV-3: Substance Type (CE) optional
• INV-4: Inventory Container Identifier (CE) optional
• INV-5: Container Carrier Identifier (CE) optional
• INV-6: Position on Carrier (CE) optional
• INV-7: Initial Quantity (NM) optional
• INV-8: Current Quantity (NM) optional
• INV-9: Available Quantity (NM) optional
• INV-10: Consumption Quantity (NM) optional
• INV-11: Quantity Units (CE) optional
• INV-12: Expiration Date/Time (TS) optional
• INV-13: First Used Date/Time (TS) optional
• INV-14: On Board Stability Duration (TQ) optional
• INV-15: Test/Fluid Identifier(s) (CE) optional repeating
• INV-16: Manufacturer Lot Number (ST) optional
• INV-17: Manufacturer Identifier (CE) optional
• INV-18: Supplier Identifier (CE) optional

See Also:

Serialized Form

Constructor Summary

INV(Group parent, ModelClassFactory factory)
Creates a new INV segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
NM	getAvailableQuantity() Returns INV-9: "Available Quantity" - creates it if necessary
NM	getConsumptionQuantity() Returns INV-10: "Consumption Quantity" - creates it if necessary
CE	getContainerCarrierIdentifier() Returns INV-5: "Container Carrier Identifier" - creates it if necessary
NM	getCurrentQuantity() Returns INV-8: "Current Quantity" - creates it if necessary
TS	getExpirationDateTime() Returns INV-12: "Expiration Date/Time" - creates it if necessary
TS	getFirstUsedDateTime() Returns INV-13: "First Used Date/Time" - creates it if necessary
NM	getInitialQuantity() Returns INV-7: "Initial Quantity" - creates it if necessary
CE	getInv1_SubstanceIdentifier() Returns INV-1: "Substance Identifier" - creates it if necessary
NM	getInv10_ConsumptionQuantity() Returns INV-10: "Consumption Quantity" - creates it if necessary
CE	getInv11_QuantityUnits() Returns INV-11: "Quantity Units" - creates it if necessary
TS	getInv12_ExpirationDateTime() Returns INV-12: "Expiration Date/Time" - creates it if necessary
TS	getInv13_FirstUsedDateTime() Returns INV-13: "First Used Date/Time" - creates it if necessary
TQ	getInv14_OnBoardStabilityDuration() Returns INV-14: "On Board Stability Duration" - creates it if necessary
CE	getInv15_TestFluidIdentifierS(int rep) Returns a specific repetition of INV-15: "Test/Fluid Identifier(s)" - creates it if necessary
int	getInv15_TestFluidIdentifierSReps() Returns a count of the current number of repetitions of Test/Fluid Identifier(s) (INV-15).
ST	getInv16_ManufacturerLotNumber() Returns INV-16: "Manufacturer Lot Number" - creates it if necessary
CE	getInv17_ManufacturerIdentifier() Returns INV-17: "Manufacturer Identifier" - creates it if necessary
CE	getInv18_SupplierIdentifier() Returns INV-18: "Supplier Identifier" - creates it if necessary
CE	getInv2_SubstanceStatus(int rep) Returns a specific repetition of INV-2: "Substance Status" - creates it if necessary
int	getInv2_SubstanceStatusReps() Returns a count of the current number of repetitions of Substance Status (INV-2).
CE	getInv3_SubstanceType() Returns INV-3: "Substance Type" - creates it if necessary
CE	getInv4_InventoryContainerIdentifier() Returns INV-4: "Inventory Container Identifier" - creates it if necessary
CE	getInv5_ContainerCarrierIdentifier() Returns INV-5: "Container Carrier Identifier" - creates it if necessary
CE	getInv6_PositionOnCarrier() Returns INV-6: "Position on Carrier" - creates it if necessary
NM	getInv7_InitialQuantity() Returns INV-7: "Initial Quantity" - creates it if necessary
NM	getInv8_CurrentQuantity() Returns INV-8: "Current Quantity" - creates it if necessary
NM	getInv9_AvailableQuantity() Returns INV-9: "Available Quantity" - creates it if necessary
CE	getInventoryContainerIdentifier() Returns INV-4: "Inventory Container Identifier" - creates it if necessary
CE	getManufacturerIdentifier() Returns INV-17: "Manufacturer Identifier" - creates it if necessary
ST	getManufacturerLotNumber() Returns INV-16: "Manufacturer Lot Number" - creates it if necessary
TQ	getOnBoardStabilityDuration() Returns INV-14: "On Board Stability Duration" - creates it if necessary
CE	getPositionOnCarrier() Returns INV-6: "Position on Carrier" - creates it if necessary
CE	getQuantityUnits() Returns INV-11: "Quantity Units" - creates it if necessary
CE	getSubstanceIdentifier() Returns INV-1: "Substance Identifier" - creates it if necessary
CE[]	getSubstanceStatus() Returns all repetitions of Substance Status (INV-2).
CE	getSubstanceStatus(int rep) Returns a specific repetition of INV-2: "Substance Status" - creates it if necessary
int	getSubstanceStatusReps() Returns a count of the current number of repetitions of Substance Status (INV-2).
CE	getSubstanceType() Returns INV-3: "Substance Type" - creates it if necessary
CE	getSupplierIdentifier() Returns INV-18: "Supplier Identifier" - creates it if necessary
CE[]	getTestFluidIdentifierS() Returns all repetitions of Test/Fluid Identifier(s) (INV-15).
CE	getTestFluidIdentifierS(int rep) Returns a specific repetition of INV-15: "Test/Fluid Identifier(s)" - creates it if necessary
int	getTestFluidIdentifierSReps() Returns a count of the current number of repetitions of Test/Fluid Identifier(s) (INV-15).
CE	insertInv15_TestFluidIdentifierS(int rep) Inserts a repetition of INV-15: "Test/Fluid Identifier(s)" at a specific index
CE	insertInv2_SubstanceStatus(int rep) Inserts a repetition of INV-2: "Substance Status" at a specific index
CE	insertSubstanceStatus(int rep) Inserts a repetition of INV-2: "Substance Status" at a specific index
CE	insertTestFluidIdentifierS(int rep) Inserts a repetition of INV-15: "Test/Fluid Identifier(s)" at a specific index
CE	removeInv15_TestFluidIdentifierS(int rep) Removes a repetition of INV-15: "Test/Fluid Identifier(s)" at a specific index
CE	removeInv2_SubstanceStatus(int rep) Removes a repetition of INV-2: "Substance Status" at a specific index
CE	removeSubstanceStatus(int rep) Removes a repetition of INV-2: "Substance Status" at a specific index
CE	removeTestFluidIdentifierS(int rep) Removes a repetition of INV-15: "Test/Fluid Identifier(s)" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

INV

public INV(Group parent,
           ModelClassFactory factory)

Creates a new INV segment

Method Detail

getSubstanceIdentifier

public CE getSubstanceIdentifier()

Returns INV-1: "Substance Identifier" - creates it if necessary

getInv1_SubstanceIdentifier

public CE getInv1_SubstanceIdentifier()

Returns INV-1: "Substance Identifier" - creates it if necessary

getSubstanceStatus

public CE[] getSubstanceStatus()

Returns all repetitions of Substance Status (INV-2).

getSubstanceStatusReps

public int getSubstanceStatusReps()

Returns a count of the current number of repetitions of Substance Status (INV-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getSubstanceStatus

public CE getSubstanceStatus(int rep)

Returns a specific repetition of INV-2: "Substance Status" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getInv2_SubstanceStatus

public CE getInv2_SubstanceStatus(int rep)

Returns a specific repetition of INV-2: "Substance Status" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getInv2_SubstanceStatusReps

public int getInv2_SubstanceStatusReps()

Returns a count of the current number of repetitions of Substance Status (INV-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertSubstanceStatus

public CE insertSubstanceStatus(int rep)
                         throws HL7Exception

Inserts a repetition of INV-2: "Substance Status" 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)

insertInv2_SubstanceStatus

public CE insertInv2_SubstanceStatus(int rep)
                              throws HL7Exception

Inserts a repetition of INV-2: "Substance Status" 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)

removeSubstanceStatus

public CE removeSubstanceStatus(int rep)
                         throws HL7Exception

Removes a repetition of INV-2: "Substance Status" 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)

removeInv2_SubstanceStatus

public CE removeInv2_SubstanceStatus(int rep)
                              throws HL7Exception

Removes a repetition of INV-2: "Substance Status" 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)

getSubstanceType

public CE getSubstanceType()

Returns INV-3: "Substance Type" - creates it if necessary

getInv3_SubstanceType

public CE getInv3_SubstanceType()

Returns INV-3: "Substance Type" - creates it if necessary

getInventoryContainerIdentifier

public CE getInventoryContainerIdentifier()

Returns INV-4: "Inventory Container Identifier" - creates it if necessary

getInv4_InventoryContainerIdentifier

public CE getInv4_InventoryContainerIdentifier()

Returns INV-4: "Inventory Container Identifier" - creates it if necessary

getContainerCarrierIdentifier

public CE getContainerCarrierIdentifier()

Returns INV-5: "Container Carrier Identifier" - creates it if necessary

getInv5_ContainerCarrierIdentifier

public CE getInv5_ContainerCarrierIdentifier()

Returns INV-5: "Container Carrier Identifier" - creates it if necessary

getPositionOnCarrier

public CE getPositionOnCarrier()

Returns INV-6: "Position on Carrier" - creates it if necessary

getInv6_PositionOnCarrier

public CE getInv6_PositionOnCarrier()

Returns INV-6: "Position on Carrier" - creates it if necessary

getInitialQuantity

public NM getInitialQuantity()

Returns INV-7: "Initial Quantity" - creates it if necessary

getInv7_InitialQuantity

public NM getInv7_InitialQuantity()

Returns INV-7: "Initial Quantity" - creates it if necessary

getCurrentQuantity

public NM getCurrentQuantity()

Returns INV-8: "Current Quantity" - creates it if necessary

getInv8_CurrentQuantity

public NM getInv8_CurrentQuantity()

Returns INV-8: "Current Quantity" - creates it if necessary

getAvailableQuantity

public NM getAvailableQuantity()

Returns INV-9: "Available Quantity" - creates it if necessary

getInv9_AvailableQuantity

public NM getInv9_AvailableQuantity()

Returns INV-9: "Available Quantity" - creates it if necessary

getConsumptionQuantity

public NM getConsumptionQuantity()

Returns INV-10: "Consumption Quantity" - creates it if necessary

getInv10_ConsumptionQuantity

public NM getInv10_ConsumptionQuantity()

Returns INV-10: "Consumption Quantity" - creates it if necessary

getQuantityUnits

public CE getQuantityUnits()

Returns INV-11: "Quantity Units" - creates it if necessary

getInv11_QuantityUnits

public CE getInv11_QuantityUnits()

Returns INV-11: "Quantity Units" - creates it if necessary

getExpirationDateTime

public TS getExpirationDateTime()

Returns INV-12: "Expiration Date/Time" - creates it if necessary

getInv12_ExpirationDateTime

public TS getInv12_ExpirationDateTime()

Returns INV-12: "Expiration Date/Time" - creates it if necessary

getFirstUsedDateTime

public TS getFirstUsedDateTime()

Returns INV-13: "First Used Date/Time" - creates it if necessary

getInv13_FirstUsedDateTime

public TS getInv13_FirstUsedDateTime()

Returns INV-13: "First Used Date/Time" - creates it if necessary

getOnBoardStabilityDuration

public TQ getOnBoardStabilityDuration()

Returns INV-14: "On Board Stability Duration" - creates it if necessary

getInv14_OnBoardStabilityDuration

public TQ getInv14_OnBoardStabilityDuration()

Returns INV-14: "On Board Stability Duration" - creates it if necessary

getTestFluidIdentifierS

public CE[] getTestFluidIdentifierS()

Returns all repetitions of Test/Fluid Identifier(s) (INV-15).

getTestFluidIdentifierSReps

public int getTestFluidIdentifierSReps()

Returns a count of the current number of repetitions of Test/Fluid Identifier(s) (INV-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getTestFluidIdentifierS

public CE getTestFluidIdentifierS(int rep)

Returns a specific repetition of INV-15: "Test/Fluid Identifier(s)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getInv15_TestFluidIdentifierS

public CE getInv15_TestFluidIdentifierS(int rep)

Returns a specific repetition of INV-15: "Test/Fluid Identifier(s)" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getInv15_TestFluidIdentifierSReps

public int getInv15_TestFluidIdentifierSReps()

Returns a count of the current number of repetitions of Test/Fluid Identifier(s) (INV-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertTestFluidIdentifierS

public CE insertTestFluidIdentifierS(int rep)
                              throws HL7Exception

Inserts a repetition of INV-15: "Test/Fluid Identifier(s)" 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)

insertInv15_TestFluidIdentifierS

public CE insertInv15_TestFluidIdentifierS(int rep)
                                    throws HL7Exception

Inserts a repetition of INV-15: "Test/Fluid Identifier(s)" 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)

removeTestFluidIdentifierS

public CE removeTestFluidIdentifierS(int rep)
                              throws HL7Exception

Removes a repetition of INV-15: "Test/Fluid Identifier(s)" 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)

removeInv15_TestFluidIdentifierS

public CE removeInv15_TestFluidIdentifierS(int rep)
                                    throws HL7Exception

Removes a repetition of INV-15: "Test/Fluid Identifier(s)" 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)

getManufacturerLotNumber

public ST getManufacturerLotNumber()

Returns INV-16: "Manufacturer Lot Number" - creates it if necessary

getInv16_ManufacturerLotNumber

public ST getInv16_ManufacturerLotNumber()

Returns INV-16: "Manufacturer Lot Number" - creates it if necessary

getManufacturerIdentifier

public CE getManufacturerIdentifier()

Returns INV-17: "Manufacturer Identifier" - creates it if necessary

getInv17_ManufacturerIdentifier

public CE getInv17_ManufacturerIdentifier()

Returns INV-17: "Manufacturer Identifier" - creates it if necessary

getSupplierIdentifier

public CE getSupplierIdentifier()

Returns INV-18: "Supplier Identifier" - creates it if necessary

getInv18_SupplierIdentifier

public CE getInv18_SupplierIdentifier()

Returns INV-18: "Supplier Identifier" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment