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

Class BPX

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

Represents an HL7 BPX message segment (Blood product dispense status). This segment has the following fields:

  • BPX-1: Set ID - BPX (SI)
  • BPX-2: BP Dispense Status (CWE)
  • BPX-3: BP Status (ID)
  • BPX-4: BP Date/Time of Status (TS)
  • BPX-5: BC Donation ID (EI) optional
  • BPX-6: BC Component (CNE) optional
  • BPX-7: BC Donation Type / Intended Use (CNE) optional
  • BPX-8: CP Commercial Product (CWE) optional
  • BPX-9: CP Manufacturer (XON) optional
  • BPX-10: CP Lot Number (EI) optional
  • BPX-11: BP Blood Group (CNE) optional
  • BPX-12: BC Special Testing (CNE) optional repeating
  • BPX-13: BP Expiration Date/Time (TS) optional
  • BPX-14: BP Quantity (NM)
  • BPX-15: BP Amount (NM) optional
  • BPX-16: BP Units (CE) optional
  • BPX-17: BP Unique ID (EI) optional
  • BPX-18: BP Actual Dispensed To Location (PL) optional
  • BPX-19: BP Actual Dispensed To Address (XAD) optional
  • BPX-20: BP Dispensed to Receiver (XCN) optional
  • BPX-21: BP Dispensing Individual (XCN) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDBPX

      public SI getSetIDBPX()
      Returns BPX-1: "Set ID - BPX" - creates it if necessary

    • getBpx1_SetIDBPX

      public SI getBpx1_SetIDBPX()
      Returns BPX-1: "Set ID - BPX" - creates it if necessary

    • getBPDispenseStatus

      public CWE getBPDispenseStatus()
      Returns BPX-2: "BP Dispense Status" - creates it if necessary

    • getBpx2_BPDispenseStatus

      public CWE getBpx2_BPDispenseStatus()
      Returns BPX-2: "BP Dispense Status" - creates it if necessary

    • getBPStatus

      public ID getBPStatus()
      Returns BPX-3: "BP Status" - creates it if necessary

    • getBpx3_BPStatus

      public ID getBpx3_BPStatus()
      Returns BPX-3: "BP Status" - creates it if necessary

    • getBPDateTimeOfStatus

      public TS getBPDateTimeOfStatus()
      Returns BPX-4: "BP Date/Time of Status" - creates it if necessary

    • getBpx4_BPDateTimeOfStatus

      public TS getBpx4_BPDateTimeOfStatus()
      Returns BPX-4: "BP Date/Time of Status" - creates it if necessary

    • getBCDonationID

      public EI getBCDonationID()
      Returns BPX-5: "BC Donation ID" - creates it if necessary

    • getBpx5_BCDonationID

      public EI getBpx5_BCDonationID()
      Returns BPX-5: "BC Donation ID" - creates it if necessary

    • getBCComponent

      public CNE getBCComponent()
      Returns BPX-6: "BC Component" - creates it if necessary

    • getBpx6_BCComponent

      public CNE getBpx6_BCComponent()
      Returns BPX-6: "BC Component" - creates it if necessary

    • getBCDonationTypeIntendedUse

      public CNE getBCDonationTypeIntendedUse()
      Returns BPX-7: "BC Donation Type / Intended Use" - creates it if necessary

    • getBpx7_BCDonationTypeIntendedUse

      public CNE getBpx7_BCDonationTypeIntendedUse()
      Returns BPX-7: "BC Donation Type / Intended Use" - creates it if necessary

    • getCPCommercialProduct

      public CWE getCPCommercialProduct()
      Returns BPX-8: "CP Commercial Product" - creates it if necessary

    • getBpx8_CPCommercialProduct

      public CWE getBpx8_CPCommercialProduct()
      Returns BPX-8: "CP Commercial Product" - creates it if necessary

    • getCPManufacturer

      public XON getCPManufacturer()
      Returns BPX-9: "CP Manufacturer" - creates it if necessary

    • getBpx9_CPManufacturer

      public XON getBpx9_CPManufacturer()
      Returns BPX-9: "CP Manufacturer" - creates it if necessary

    • getCPLotNumber

      public EI getCPLotNumber()
      Returns BPX-10: "CP Lot Number" - creates it if necessary

    • getBpx10_CPLotNumber

      public EI getBpx10_CPLotNumber()
      Returns BPX-10: "CP Lot Number" - creates it if necessary

    • getBPBloodGroup

      public CNE getBPBloodGroup()
      Returns BPX-11: "BP Blood Group" - creates it if necessary

    • getBpx11_BPBloodGroup

      public CNE getBpx11_BPBloodGroup()
      Returns BPX-11: "BP Blood Group" - creates it if necessary

    • getBCSpecialTesting

      public CNE[] getBCSpecialTesting()
      Returns all repetitions of BC Special Testing (BPX-12).

    • getBpx12_BCSpecialTesting

      public CNE[] getBpx12_BCSpecialTesting()
      Returns all repetitions of BC Special Testing (BPX-12).

    • getBCSpecialTestingReps

      public int getBCSpecialTestingReps()
      Returns a count of the current number of repetitions of BC Special Testing (BPX-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getBCSpecialTesting

      public CNE getBCSpecialTesting(int rep)
      Returns a specific repetition of BPX-12: "BC Special Testing" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getBpx12_BCSpecialTesting

      public CNE getBpx12_BCSpecialTesting(int rep)
      Returns a specific repetition of BPX-12: "BC Special Testing" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getBpx12_BCSpecialTestingReps

      public int getBpx12_BCSpecialTestingReps()
      Returns a count of the current number of repetitions of BC Special Testing (BPX-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertBCSpecialTesting

      public CNE insertBCSpecialTesting(int rep) throws HL7Exception
      Inserts a repetition of BPX-12: "BC Special Testing" 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)

    • insertBpx12_BCSpecialTesting

      public CNE insertBpx12_BCSpecialTesting(int rep) throws HL7Exception
      Inserts a repetition of BPX-12: "BC Special Testing" 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)

    • removeBCSpecialTesting

      public CNE removeBCSpecialTesting(int rep) throws HL7Exception
      Removes a repetition of BPX-12: "BC Special Testing" 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)

    • removeBpx12_BCSpecialTesting

      public CNE removeBpx12_BCSpecialTesting(int rep) throws HL7Exception
      Removes a repetition of BPX-12: "BC Special Testing" 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)

    • getBPExpirationDateTime

      public TS getBPExpirationDateTime()
      Returns BPX-13: "BP Expiration Date/Time" - creates it if necessary

    • getBpx13_BPExpirationDateTime

      public TS getBpx13_BPExpirationDateTime()
      Returns BPX-13: "BP Expiration Date/Time" - creates it if necessary

    • getBPQuantity

      public NM getBPQuantity()
      Returns BPX-14: "BP Quantity" - creates it if necessary

    • getBpx14_BPQuantity

      public NM getBpx14_BPQuantity()
      Returns BPX-14: "BP Quantity" - creates it if necessary

    • getBPAmount

      public NM getBPAmount()
      Returns BPX-15: "BP Amount" - creates it if necessary

    • getBpx15_BPAmount

      public NM getBpx15_BPAmount()
      Returns BPX-15: "BP Amount" - creates it if necessary

    • getBPUnits

      public CE getBPUnits()
      Returns BPX-16: "BP Units" - creates it if necessary

    • getBpx16_BPUnits

      public CE getBpx16_BPUnits()
      Returns BPX-16: "BP Units" - creates it if necessary

    • getBPUniqueID

      public EI getBPUniqueID()
      Returns BPX-17: "BP Unique ID" - creates it if necessary

    • getBpx17_BPUniqueID

      public EI getBpx17_BPUniqueID()
      Returns BPX-17: "BP Unique ID" - creates it if necessary

    • getBPActualDispensedToLocation

      public PL getBPActualDispensedToLocation()
      Returns BPX-18: "BP Actual Dispensed To Location" - creates it if necessary

    • getBpx18_BPActualDispensedToLocation

      public PL getBpx18_BPActualDispensedToLocation()
      Returns BPX-18: "BP Actual Dispensed To Location" - creates it if necessary

    • getBPActualDispensedToAddress

      public XAD getBPActualDispensedToAddress()
      Returns BPX-19: "BP Actual Dispensed To Address" - creates it if necessary

    • getBpx19_BPActualDispensedToAddress

      public XAD getBpx19_BPActualDispensedToAddress()
      Returns BPX-19: "BP Actual Dispensed To Address" - creates it if necessary

    • getBPDispensedToReceiver

      public XCN getBPDispensedToReceiver()
      Returns BPX-20: "BP Dispensed to Receiver" - creates it if necessary

    • getBpx20_BPDispensedToReceiver

      public XCN getBpx20_BPDispensedToReceiver()
      Returns BPX-20: "BP Dispensed to Receiver" - creates it if necessary

    • getBPDispensingIndividual

      public XCN getBPDispensingIndividual()
      Returns BPX-21: "BP Dispensing Individual" - creates it if necessary

    • getBpx21_BPDispensingIndividual

      public XCN getBpx21_BPDispensingIndividual()
      Returns BPX-21: "BP Dispensing Individual" - creates it if necessary

    • createNewTypeWithoutReflection

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