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

Class BPO

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

Represents an HL7 BPO message segment (Blood product order). This segment has the following fields:

  • BPO-1: Set ID - BPO (SI)
  • BPO-2: BP Universal Service ID (CWE)
  • BPO-3: BP Processing Requirements (CWE) optional repeating
  • BPO-4: BP Quantity (NM)
  • BPO-5: BP Amount (NM) optional
  • BPO-6: BP Units (CE) optional
  • BPO-7: BP Intended Use Date/Time (TS) optional
  • BPO-8: BP Intended Dispense From Location (PL) optional
  • BPO-9: BP Intended Dispense From Address (XAD) optional
  • BPO-10: BP Requested Dispense Date/Time (TS) optional
  • BPO-11: BP Requested Dispense To Location (PL) optional
  • BPO-12: BP Requested Dispense To Address (XAD) optional
  • BPO-13: BP Indication for Use (CWE) optional repeating
  • BPO-14: BP Informed Consent Indicator (ID) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDBPO

      public SI getSetIDBPO()
      Returns BPO-1: "Set ID - BPO" - creates it if necessary

    • getBpo1_SetIDBPO

      public SI getBpo1_SetIDBPO()
      Returns BPO-1: "Set ID - BPO" - creates it if necessary

    • getBPUniversalServiceID

      public CWE getBPUniversalServiceID()
      Returns BPO-2: "BP Universal Service ID" - creates it if necessary

    • getBpo2_BPUniversalServiceID

      public CWE getBpo2_BPUniversalServiceID()
      Returns BPO-2: "BP Universal Service ID" - creates it if necessary

    • getBPProcessingRequirements

      public CWE[] getBPProcessingRequirements()
      Returns all repetitions of BP Processing Requirements (BPO-3).

    • getBpo3_BPProcessingRequirements

      public CWE[] getBpo3_BPProcessingRequirements()
      Returns all repetitions of BP Processing Requirements (BPO-3).

    • getBPProcessingRequirementsReps

      public int getBPProcessingRequirementsReps()
      Returns a count of the current number of repetitions of BP Processing Requirements (BPO-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getBPProcessingRequirements

      public CWE getBPProcessingRequirements(int rep)
      Returns a specific repetition of BPO-3: "BP Processing Requirements" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getBpo3_BPProcessingRequirements

      public CWE getBpo3_BPProcessingRequirements(int rep)
      Returns a specific repetition of BPO-3: "BP Processing Requirements" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getBpo3_BPProcessingRequirementsReps

      public int getBpo3_BPProcessingRequirementsReps()
      Returns a count of the current number of repetitions of BP Processing Requirements (BPO-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertBPProcessingRequirements

      public CWE insertBPProcessingRequirements(int rep) throws HL7Exception
      Inserts a repetition of BPO-3: "BP Processing Requirements" 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)

    • insertBpo3_BPProcessingRequirements

      public CWE insertBpo3_BPProcessingRequirements(int rep) throws HL7Exception
      Inserts a repetition of BPO-3: "BP Processing Requirements" 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)

    • removeBPProcessingRequirements

      public CWE removeBPProcessingRequirements(int rep) throws HL7Exception
      Removes a repetition of BPO-3: "BP Processing Requirements" 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)

    • removeBpo3_BPProcessingRequirements

      public CWE removeBpo3_BPProcessingRequirements(int rep) throws HL7Exception
      Removes a repetition of BPO-3: "BP Processing Requirements" 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)

    • getBPQuantity

      public NM getBPQuantity()
      Returns BPO-4: "BP Quantity" - creates it if necessary

    • getBpo4_BPQuantity

      public NM getBpo4_BPQuantity()
      Returns BPO-4: "BP Quantity" - creates it if necessary

    • getBPAmount

      public NM getBPAmount()
      Returns BPO-5: "BP Amount" - creates it if necessary

    • getBpo5_BPAmount

      public NM getBpo5_BPAmount()
      Returns BPO-5: "BP Amount" - creates it if necessary

    • getBPUnits

      public CE getBPUnits()
      Returns BPO-6: "BP Units" - creates it if necessary

    • getBpo6_BPUnits

      public CE getBpo6_BPUnits()
      Returns BPO-6: "BP Units" - creates it if necessary

    • getBPIntendedUseDateTime

      public TS getBPIntendedUseDateTime()
      Returns BPO-7: "BP Intended Use Date/Time" - creates it if necessary

    • getBpo7_BPIntendedUseDateTime

      public TS getBpo7_BPIntendedUseDateTime()
      Returns BPO-7: "BP Intended Use Date/Time" - creates it if necessary

    • getBPIntendedDispenseFromLocation

      public PL getBPIntendedDispenseFromLocation()
      Returns BPO-8: "BP Intended Dispense From Location" - creates it if necessary

    • getBpo8_BPIntendedDispenseFromLocation

      public PL getBpo8_BPIntendedDispenseFromLocation()
      Returns BPO-8: "BP Intended Dispense From Location" - creates it if necessary

    • getBPIntendedDispenseFromAddress

      public XAD getBPIntendedDispenseFromAddress()
      Returns BPO-9: "BP Intended Dispense From Address" - creates it if necessary

    • getBpo9_BPIntendedDispenseFromAddress

      public XAD getBpo9_BPIntendedDispenseFromAddress()
      Returns BPO-9: "BP Intended Dispense From Address" - creates it if necessary

    • getBPRequestedDispenseDateTime

      public TS getBPRequestedDispenseDateTime()
      Returns BPO-10: "BP Requested Dispense Date/Time" - creates it if necessary

    • getBpo10_BPRequestedDispenseDateTime

      public TS getBpo10_BPRequestedDispenseDateTime()
      Returns BPO-10: "BP Requested Dispense Date/Time" - creates it if necessary

    • getBPRequestedDispenseToLocation

      public PL getBPRequestedDispenseToLocation()
      Returns BPO-11: "BP Requested Dispense To Location" - creates it if necessary

    • getBpo11_BPRequestedDispenseToLocation

      public PL getBpo11_BPRequestedDispenseToLocation()
      Returns BPO-11: "BP Requested Dispense To Location" - creates it if necessary

    • getBPRequestedDispenseToAddress

      public XAD getBPRequestedDispenseToAddress()
      Returns BPO-12: "BP Requested Dispense To Address" - creates it if necessary

    • getBpo12_BPRequestedDispenseToAddress

      public XAD getBpo12_BPRequestedDispenseToAddress()
      Returns BPO-12: "BP Requested Dispense To Address" - creates it if necessary

    • getBPIndicationForUse

      public CWE[] getBPIndicationForUse()
      Returns all repetitions of BP Indication for Use (BPO-13).

    • getBpo13_BPIndicationForUse

      public CWE[] getBpo13_BPIndicationForUse()
      Returns all repetitions of BP Indication for Use (BPO-13).

    • getBPIndicationForUseReps

      public int getBPIndicationForUseReps()
      Returns a count of the current number of repetitions of BP Indication for Use (BPO-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getBPIndicationForUse

      public CWE getBPIndicationForUse(int rep)
      Returns a specific repetition of BPO-13: "BP Indication for Use" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getBpo13_BPIndicationForUse

      public CWE getBpo13_BPIndicationForUse(int rep)
      Returns a specific repetition of BPO-13: "BP Indication for Use" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getBpo13_BPIndicationForUseReps

      public int getBpo13_BPIndicationForUseReps()
      Returns a count of the current number of repetitions of BP Indication for Use (BPO-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertBPIndicationForUse

      public CWE insertBPIndicationForUse(int rep) throws HL7Exception
      Inserts a repetition of BPO-13: "BP Indication for Use" 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)

    • insertBpo13_BPIndicationForUse

      public CWE insertBpo13_BPIndicationForUse(int rep) throws HL7Exception
      Inserts a repetition of BPO-13: "BP Indication for Use" 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)

    • removeBPIndicationForUse

      public CWE removeBPIndicationForUse(int rep) throws HL7Exception
      Removes a repetition of BPO-13: "BP Indication for Use" 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)

    • removeBpo13_BPIndicationForUse

      public CWE removeBpo13_BPIndicationForUse(int rep) throws HL7Exception
      Removes a repetition of BPO-13: "BP Indication for Use" 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)

    • getBPInformedConsentIndicator

      public ID getBPInformedConsentIndicator()
      Returns BPO-14: "BP Informed Consent Indicator" - creates it if necessary

    • getBpo14_BPInformedConsentIndicator

      public ID getBpo14_BPInformedConsentIndicator()
      Returns BPO-14: "BP Informed Consent Indicator" - creates it if necessary

    • createNewTypeWithoutReflection

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