BTX (HAPI - Java HL7 API - Generated Structures v2.5 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractSegment
  - - ca.uhn.hl7v2.model.v25.segment.BTX

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable
```
public class BTX
extends AbstractSegment
```
Represents an HL7 BTX message segment (Blood Product Transfusion/Disposition). This segment has the following fields:
- BTX-1: Set ID _ BTX (SI)
- BTX-2: BC Donation ID (EI) optional
- BTX-3: BC Component (CNE) optional
- BTX-4: BC Blood Group (CNE) optional
- BTX-5: CP Commercial Product (CWE) optional
- BTX-6: CP Manufacturer (XON) optional
- BTX-7: CP Lot Number (EI) optional
- BTX-8: BP Quantity (NM)
- BTX-9: BP Amount (NM) optional
- BTX-10: BP Units (CE) optional
- BTX-11: BP Transfusion/Disposition Status (CWE)
- BTX-12: BP Message Status (ID)
- BTX-13: BP Date/Time of Status (TS)
- BTX-14: BP Administrator (XCN) optional
- BTX-15: BP Verifier (XCN) optional
- BTX-16: BP Transfusion Start Date/Time of Status (TS) optional
- BTX-17: BP Transfusion End Date/Time of Status (TS) optional
- BTX-18: BP Adverse Reaction Type (CWE) optional repeating
- BTX-19: BP Transfusion Interrupted Reason (CWE) optional
See Also:

Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`BTX(Group parent, ModelClassFactory factory)` Creates a new BTX segment

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Type`	`createNewTypeWithoutReflection(int field)`
`CNE`	`getBCBloodGroup()` Returns BTX-4: "BC Blood Group" - creates it if necessary
`CNE`	`getBCComponent()` Returns BTX-3: "BC Component" - creates it if necessary
`EI`	`getBCDonationID()` Returns BTX-2: "BC Donation ID" - creates it if necessary
`XCN`	`getBPAdministrator()` Returns BTX-14: "BP Administrator" - creates it if necessary
`CWE[]`	`getBPAdverseReactionType()` Returns all repetitions of BP Adverse Reaction Type (BTX-18).
`CWE`	`getBPAdverseReactionType(int rep)` Returns a specific repetition of BTX-18: "BP Adverse Reaction Type" - creates it if necessary
`int`	`getBPAdverseReactionTypeReps()` Returns a count of the current number of repetitions of BP Adverse Reaction Type (BTX-18).
`NM`	`getBPAmount()` Returns BTX-9: "BP Amount" - creates it if necessary
`TS`	`getBPDateTimeOfStatus()` Returns BTX-13: "BP Date/Time of Status" - creates it if necessary
`ID`	`getBPMessageStatus()` Returns BTX-12: "BP Message Status" - creates it if necessary
`NM`	`getBPQuantity()` Returns BTX-8: "BP Quantity" - creates it if necessary
`CWE`	`getBPTransfusionDispositionStatus()` Returns BTX-11: "BP Transfusion/Disposition Status" - creates it if necessary
`TS`	`getBPTransfusionEndDateTimeOfStatus()` Returns BTX-17: "BP Transfusion End Date/Time of Status" - creates it if necessary
`CWE`	`getBPTransfusionInterruptedReason()` Returns BTX-19: "BP Transfusion Interrupted Reason" - creates it if necessary
`TS`	`getBPTransfusionStartDateTimeOfStatus()` Returns BTX-16: "BP Transfusion Start Date/Time of Status" - creates it if necessary
`CE`	`getBPUnits()` Returns BTX-10: "BP Units" - creates it if necessary
`XCN`	`getBPVerifier()` Returns BTX-15: "BP Verifier" - creates it if necessary
`SI`	`getBtx1_SetIDBTX()` Returns BTX-1: "Set ID _ BTX" - creates it if necessary
`CE`	`getBtx10_BPUnits()` Returns BTX-10: "BP Units" - creates it if necessary
`CWE`	`getBtx11_BPTransfusionDispositionStatus()` Returns BTX-11: "BP Transfusion/Disposition Status" - creates it if necessary
`ID`	`getBtx12_BPMessageStatus()` Returns BTX-12: "BP Message Status" - creates it if necessary
`TS`	`getBtx13_BPDateTimeOfStatus()` Returns BTX-13: "BP Date/Time of Status" - creates it if necessary
`XCN`	`getBtx14_BPAdministrator()` Returns BTX-14: "BP Administrator" - creates it if necessary
`XCN`	`getBtx15_BPVerifier()` Returns BTX-15: "BP Verifier" - creates it if necessary
`TS`	`getBtx16_BPTransfusionStartDateTimeOfStatus()` Returns BTX-16: "BP Transfusion Start Date/Time of Status" - creates it if necessary
`TS`	`getBtx17_BPTransfusionEndDateTimeOfStatus()` Returns BTX-17: "BP Transfusion End Date/Time of Status" - creates it if necessary
`CWE[]`	`getBtx18_BPAdverseReactionType()` Returns all repetitions of BP Adverse Reaction Type (BTX-18).
`CWE`	`getBtx18_BPAdverseReactionType(int rep)` Returns a specific repetition of BTX-18: "BP Adverse Reaction Type" - creates it if necessary
`int`	`getBtx18_BPAdverseReactionTypeReps()` Returns a count of the current number of repetitions of BP Adverse Reaction Type (BTX-18).
`CWE`	`getBtx19_BPTransfusionInterruptedReason()` Returns BTX-19: "BP Transfusion Interrupted Reason" - creates it if necessary
`EI`	`getBtx2_BCDonationID()` Returns BTX-2: "BC Donation ID" - creates it if necessary
`CNE`	`getBtx3_BCComponent()` Returns BTX-3: "BC Component" - creates it if necessary
`CNE`	`getBtx4_BCBloodGroup()` Returns BTX-4: "BC Blood Group" - creates it if necessary
`CWE`	`getBtx5_CPCommercialProduct()` Returns BTX-5: "CP Commercial Product" - creates it if necessary
`XON`	`getBtx6_CPManufacturer()` Returns BTX-6: "CP Manufacturer" - creates it if necessary
`EI`	`getBtx7_CPLotNumber()` Returns BTX-7: "CP Lot Number" - creates it if necessary
`NM`	`getBtx8_BPQuantity()` Returns BTX-8: "BP Quantity" - creates it if necessary
`NM`	`getBtx9_BPAmount()` Returns BTX-9: "BP Amount" - creates it if necessary
`CWE`	`getCPCommercialProduct()` Returns BTX-5: "CP Commercial Product" - creates it if necessary
`EI`	`getCPLotNumber()` Returns BTX-7: "CP Lot Number" - creates it if necessary
`XON`	`getCPManufacturer()` Returns BTX-6: "CP Manufacturer" - creates it if necessary
`SI`	`getSetIDBTX()` Returns BTX-1: "Set ID _ BTX" - creates it if necessary
`CWE`	`insertBPAdverseReactionType(int rep)` Inserts a repetition of BTX-18: "BP Adverse Reaction Type" at a specific index
`CWE`	`insertBtx18_BPAdverseReactionType(int rep)` Inserts a repetition of BTX-18: "BP Adverse Reaction Type" at a specific index
`CWE`	`removeBPAdverseReactionType(int rep)` Removes a repetition of BTX-18: "BP Adverse Reaction Type" at a specific index
`CWE`	`removeBtx18_BPAdverseReactionType(int rep)` Removes a repetition of BTX-18: "BP Adverse Reaction Type" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment
accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure
getMessage, getParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure
getMessage, getParent

- Constructor Detail
  - BTX
```
public BTX(Group parent,
           ModelClassFactory factory)
```
    Creates a new BTX segment
- Method Detail
  - getSetIDBTX
```
public SI getSetIDBTX()
```
    Returns BTX-1: "Set ID _ BTX" - creates it if necessary
  - getBtx1_SetIDBTX
```
public SI getBtx1_SetIDBTX()
```
    Returns BTX-1: "Set ID _ BTX" - creates it if necessary
  - getBCDonationID
```
public EI getBCDonationID()
```
    Returns BTX-2: "BC Donation ID" - creates it if necessary
  - getBtx2_BCDonationID
```
public EI getBtx2_BCDonationID()
```
    Returns BTX-2: "BC Donation ID" - creates it if necessary
  - getBCComponent
```
public CNE getBCComponent()
```
    Returns BTX-3: "BC Component" - creates it if necessary
  - getBtx3_BCComponent
```
public CNE getBtx3_BCComponent()
```
    Returns BTX-3: "BC Component" - creates it if necessary
  - getBCBloodGroup
```
public CNE getBCBloodGroup()
```
    Returns BTX-4: "BC Blood Group" - creates it if necessary
  - getBtx4_BCBloodGroup
```
public CNE getBtx4_BCBloodGroup()
```
    Returns BTX-4: "BC Blood Group" - creates it if necessary
  - getCPCommercialProduct
```
public CWE getCPCommercialProduct()
```
    Returns BTX-5: "CP Commercial Product" - creates it if necessary
  - getBtx5_CPCommercialProduct
```
public CWE getBtx5_CPCommercialProduct()
```
    Returns BTX-5: "CP Commercial Product" - creates it if necessary
  - getCPManufacturer
```
public XON getCPManufacturer()
```
    Returns BTX-6: "CP Manufacturer" - creates it if necessary
  - getBtx6_CPManufacturer
```
public XON getBtx6_CPManufacturer()
```
    Returns BTX-6: "CP Manufacturer" - creates it if necessary
  - getCPLotNumber
```
public EI getCPLotNumber()
```
    Returns BTX-7: "CP Lot Number" - creates it if necessary
  - getBtx7_CPLotNumber
```
public EI getBtx7_CPLotNumber()
```
    Returns BTX-7: "CP Lot Number" - creates it if necessary
  - getBPQuantity
```
public NM getBPQuantity()
```
    Returns BTX-8: "BP Quantity" - creates it if necessary
  - getBtx8_BPQuantity
```
public NM getBtx8_BPQuantity()
```
    Returns BTX-8: "BP Quantity" - creates it if necessary
  - getBPAmount
```
public NM getBPAmount()
```
    Returns BTX-9: "BP Amount" - creates it if necessary
  - getBtx9_BPAmount
```
public NM getBtx9_BPAmount()
```
    Returns BTX-9: "BP Amount" - creates it if necessary
  - getBPUnits
```
public CE getBPUnits()
```
    Returns BTX-10: "BP Units" - creates it if necessary
  - getBtx10_BPUnits
```
public CE getBtx10_BPUnits()
```
    Returns BTX-10: "BP Units" - creates it if necessary
  - getBPTransfusionDispositionStatus
```
public CWE getBPTransfusionDispositionStatus()
```
    Returns BTX-11: "BP Transfusion/Disposition Status" - creates it if necessary
  - getBtx11_BPTransfusionDispositionStatus
```
public CWE getBtx11_BPTransfusionDispositionStatus()
```
    Returns BTX-11: "BP Transfusion/Disposition Status" - creates it if necessary
  - getBPMessageStatus
```
public ID getBPMessageStatus()
```
    Returns BTX-12: "BP Message Status" - creates it if necessary
  - getBtx12_BPMessageStatus
```
public ID getBtx12_BPMessageStatus()
```
    Returns BTX-12: "BP Message Status" - creates it if necessary
  - getBPDateTimeOfStatus
```
public TS getBPDateTimeOfStatus()
```
    Returns BTX-13: "BP Date/Time of Status" - creates it if necessary
  - getBtx13_BPDateTimeOfStatus
```
public TS getBtx13_BPDateTimeOfStatus()
```
    Returns BTX-13: "BP Date/Time of Status" - creates it if necessary
  - getBPAdministrator
```
public XCN getBPAdministrator()
```
    Returns BTX-14: "BP Administrator" - creates it if necessary
  - getBtx14_BPAdministrator
```
public XCN getBtx14_BPAdministrator()
```
    Returns BTX-14: "BP Administrator" - creates it if necessary
  - getBPVerifier
```
public XCN getBPVerifier()
```
    Returns BTX-15: "BP Verifier" - creates it if necessary
  - getBtx15_BPVerifier
```
public XCN getBtx15_BPVerifier()
```
    Returns BTX-15: "BP Verifier" - creates it if necessary
  - getBPTransfusionStartDateTimeOfStatus
```
public TS getBPTransfusionStartDateTimeOfStatus()
```
    Returns BTX-16: "BP Transfusion Start Date/Time of Status" - creates it if necessary
  - getBtx16_BPTransfusionStartDateTimeOfStatus
```
public TS getBtx16_BPTransfusionStartDateTimeOfStatus()
```
    Returns BTX-16: "BP Transfusion Start Date/Time of Status" - creates it if necessary
  - getBPTransfusionEndDateTimeOfStatus
```
public TS getBPTransfusionEndDateTimeOfStatus()
```
    Returns BTX-17: "BP Transfusion End Date/Time of Status" - creates it if necessary
  - getBtx17_BPTransfusionEndDateTimeOfStatus
```
public TS getBtx17_BPTransfusionEndDateTimeOfStatus()
```
    Returns BTX-17: "BP Transfusion End Date/Time of Status" - creates it if necessary
  - getBPAdverseReactionType
```
public CWE[] getBPAdverseReactionType()
```
    Returns all repetitions of BP Adverse Reaction Type (BTX-18).
  - getBtx18_BPAdverseReactionType
```
public CWE[] getBtx18_BPAdverseReactionType()
```
    Returns all repetitions of BP Adverse Reaction Type (BTX-18).
  - getBPAdverseReactionTypeReps
```
public int getBPAdverseReactionTypeReps()
```
    Returns a count of the current number of repetitions of BP Adverse Reaction Type (BTX-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - getBPAdverseReactionType
```
public CWE getBPAdverseReactionType(int rep)
```
    Returns a specific repetition of BTX-18: "BP Adverse Reaction Type" - creates it if necessary
    
    Parameters:
    
    rep - The repetition index (0-indexed)
  - getBtx18_BPAdverseReactionType
```
public CWE getBtx18_BPAdverseReactionType(int rep)
```
    Returns a specific repetition of BTX-18: "BP Adverse Reaction Type" - creates it if necessary
    
    Parameters:
    
    rep - The repetition index (0-indexed)
  - getBtx18_BPAdverseReactionTypeReps
```
public int getBtx18_BPAdverseReactionTypeReps()
```
    Returns a count of the current number of repetitions of BP Adverse Reaction Type (BTX-18). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
  - insertBPAdverseReactionType
```
public CWE insertBPAdverseReactionType(int rep)
                                throws HL7Exception
```
    Inserts a repetition of BTX-18: "BP Adverse Reaction Type" 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)
  - insertBtx18_BPAdverseReactionType
```
public CWE insertBtx18_BPAdverseReactionType(int rep)
                                      throws HL7Exception
```
    Inserts a repetition of BTX-18: "BP Adverse Reaction Type" 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)
  - removeBPAdverseReactionType
```
public CWE removeBPAdverseReactionType(int rep)
                                throws HL7Exception
```
    Removes a repetition of BTX-18: "BP Adverse Reaction Type" 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)
  - removeBtx18_BPAdverseReactionType
```
public CWE removeBtx18_BPAdverseReactionType(int rep)
                                      throws HL7Exception
```
    Removes a repetition of BTX-18: "BP Adverse Reaction Type" 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)
  - getBPTransfusionInterruptedReason
```
public CWE getBPTransfusionInterruptedReason()
```
    Returns BTX-19: "BP Transfusion Interrupted Reason" - creates it if necessary
  - getBtx19_BPTransfusionInterruptedReason
```
public CWE getBtx19_BPTransfusionInterruptedReason()
```
    Returns BTX-19: "BP Transfusion Interrupted Reason" - creates it if necessary
  - createNewTypeWithoutReflection
```
protected Type createNewTypeWithoutReflection(int field)
```
    Overrides:
    
    createNewTypeWithoutReflection in class AbstractSegment

Class BTX

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.hl7v2.model.Structure

Constructor Detail

BTX

Method Detail

getSetIDBTX

getBtx1_SetIDBTX

getBCDonationID

getBtx2_BCDonationID

getBCComponent

getBtx3_BCComponent

getBCBloodGroup

getBtx4_BCBloodGroup

getCPCommercialProduct

getBtx5_CPCommercialProduct

getCPManufacturer

getBtx6_CPManufacturer

getCPLotNumber

getBtx7_CPLotNumber

getBPQuantity

getBtx8_BPQuantity

getBPAmount

getBtx9_BPAmount

getBPUnits

getBtx10_BPUnits

getBPTransfusionDispositionStatus

getBtx11_BPTransfusionDispositionStatus

getBPMessageStatus

getBtx12_BPMessageStatus

getBPDateTimeOfStatus

getBtx13_BPDateTimeOfStatus

getBPAdministrator

getBtx14_BPAdministrator

getBPVerifier

getBtx15_BPVerifier

getBPTransfusionStartDateTimeOfStatus

getBtx16_BPTransfusionStartDateTimeOfStatus

getBPTransfusionEndDateTimeOfStatus

getBtx17_BPTransfusionEndDateTimeOfStatus

getBPAdverseReactionType

getBtx18_BPAdverseReactionType

getBPAdverseReactionTypeReps

getBPAdverseReactionType

getBtx18_BPAdverseReactionType

getBtx18_BPAdverseReactionTypeReps

insertBPAdverseReactionType

insertBtx18_BPAdverseReactionType

removeBPAdverseReactionType

removeBtx18_BPAdverseReactionType

getBPTransfusionInterruptedReason

getBtx19_BPTransfusionInterruptedReason

createNewTypeWithoutReflection