Package ca.uhn.hl7v2.model.v24.segment

Class FT1

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

Represents an HL7 FT1 message segment (Financial Transaction). This segment has the following fields:

  • FT1-1: Set ID - FT1 (SI) optional
  • FT1-2: Transaction ID (ST) optional
  • FT1-3: Transaction Batch ID (ST) optional
  • FT1-4: Transaction Date (TS)
  • FT1-5: Transaction Posting Date (TS) optional
  • FT1-6: Transaction Type (IS)
  • FT1-7: Transaction Code (CE)
  • FT1-8: Transaction Description (ST) optional
  • FT1-9: Transaction Description - Alt (ST) optional
  • FT1-10: Transaction Quantity (NM) optional
  • FT1-11: Transaction Amount - Extended (CP) optional
  • FT1-12: Transaction Amount - Unit (CP) optional
  • FT1-13: Department Code (CE) optional
  • FT1-14: Insurance Plan ID (CE) optional
  • FT1-15: Insurance Amount (CP) optional
  • FT1-16: Assigned Patient Location (PL) optional
  • FT1-17: Fee Schedule (IS) optional
  • FT1-18: Patient Type (IS) optional
  • FT1-19: Diagnosis Code - FT1 (CE) optional repeating
  • FT1-20: Performed By Code (XCN) optional repeating
  • FT1-21: Ordered By Code (XCN) optional repeating
  • FT1-22: Unit Cost (CP) optional
  • FT1-23: Filler Order Number (EI) optional
  • FT1-24: Entered By Code (XCN) optional repeating
  • FT1-25: Procedure Code (CE) optional
  • FT1-26: Procedure Code Modifier (CE) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getSetIDFT1

      public SI getSetIDFT1()
      Returns FT1-1: "Set ID - FT1" - creates it if necessary

    • getFt11_SetIDFT1

      public SI getFt11_SetIDFT1()
      Returns FT1-1: "Set ID - FT1" - creates it if necessary

    • getTransactionID

      public ST getTransactionID()
      Returns FT1-2: "Transaction ID" - creates it if necessary

    • getFt12_TransactionID

      public ST getFt12_TransactionID()
      Returns FT1-2: "Transaction ID" - creates it if necessary

    • getTransactionBatchID

      public ST getTransactionBatchID()
      Returns FT1-3: "Transaction Batch ID" - creates it if necessary

    • getFt13_TransactionBatchID

      public ST getFt13_TransactionBatchID()
      Returns FT1-3: "Transaction Batch ID" - creates it if necessary

    • getTransactionDate

      public TS getTransactionDate()
      Returns FT1-4: "Transaction Date" - creates it if necessary

    • getFt14_TransactionDate

      public TS getFt14_TransactionDate()
      Returns FT1-4: "Transaction Date" - creates it if necessary

    • getTransactionPostingDate

      public TS getTransactionPostingDate()
      Returns FT1-5: "Transaction Posting Date" - creates it if necessary

    • getFt15_TransactionPostingDate

      public TS getFt15_TransactionPostingDate()
      Returns FT1-5: "Transaction Posting Date" - creates it if necessary

    • getTransactionType

      public IS getTransactionType()
      Returns FT1-6: "Transaction Type" - creates it if necessary

    • getFt16_TransactionType

      public IS getFt16_TransactionType()
      Returns FT1-6: "Transaction Type" - creates it if necessary

    • getTransactionCode

      public CE getTransactionCode()
      Returns FT1-7: "Transaction Code" - creates it if necessary

    • getFt17_TransactionCode

      public CE getFt17_TransactionCode()
      Returns FT1-7: "Transaction Code" - creates it if necessary

    • getTransactionDescription

      public ST getTransactionDescription()
      Returns FT1-8: "Transaction Description" - creates it if necessary

    • getFt18_TransactionDescription

      public ST getFt18_TransactionDescription()
      Returns FT1-8: "Transaction Description" - creates it if necessary

    • getTransactionDescriptionAlt

      public ST getTransactionDescriptionAlt()
      Returns FT1-9: "Transaction Description - Alt" - creates it if necessary

    • getFt19_TransactionDescriptionAlt

      public ST getFt19_TransactionDescriptionAlt()
      Returns FT1-9: "Transaction Description - Alt" - creates it if necessary

    • getTransactionQuantity

      public NM getTransactionQuantity()
      Returns FT1-10: "Transaction Quantity" - creates it if necessary

    • getFt110_TransactionQuantity

      public NM getFt110_TransactionQuantity()
      Returns FT1-10: "Transaction Quantity" - creates it if necessary

    • getTransactionAmountExtended

      public CP getTransactionAmountExtended()
      Returns FT1-11: "Transaction Amount - Extended" - creates it if necessary

    • getFt111_TransactionAmountExtended

      public CP getFt111_TransactionAmountExtended()
      Returns FT1-11: "Transaction Amount - Extended" - creates it if necessary

    • getTransactionAmountUnit

      public CP getTransactionAmountUnit()
      Returns FT1-12: "Transaction Amount - Unit" - creates it if necessary

    • getFt112_TransactionAmountUnit

      public CP getFt112_TransactionAmountUnit()
      Returns FT1-12: "Transaction Amount - Unit" - creates it if necessary

    • getDepartmentCode

      public CE getDepartmentCode()
      Returns FT1-13: "Department Code" - creates it if necessary

    • getFt113_DepartmentCode

      public CE getFt113_DepartmentCode()
      Returns FT1-13: "Department Code" - creates it if necessary

    • getInsurancePlanID

      public CE getInsurancePlanID()
      Returns FT1-14: "Insurance Plan ID" - creates it if necessary

    • getFt114_InsurancePlanID

      public CE getFt114_InsurancePlanID()
      Returns FT1-14: "Insurance Plan ID" - creates it if necessary

    • getInsuranceAmount

      public CP getInsuranceAmount()
      Returns FT1-15: "Insurance Amount" - creates it if necessary

    • getFt115_InsuranceAmount

      public CP getFt115_InsuranceAmount()
      Returns FT1-15: "Insurance Amount" - creates it if necessary

    • getAssignedPatientLocation

      public PL getAssignedPatientLocation()
      Returns FT1-16: "Assigned Patient Location" - creates it if necessary

    • getFt116_AssignedPatientLocation

      public PL getFt116_AssignedPatientLocation()
      Returns FT1-16: "Assigned Patient Location" - creates it if necessary

    • getFeeSchedule

      public IS getFeeSchedule()
      Returns FT1-17: "Fee Schedule" - creates it if necessary

    • getFt117_FeeSchedule

      public IS getFt117_FeeSchedule()
      Returns FT1-17: "Fee Schedule" - creates it if necessary

    • getPatientType

      public IS getPatientType()
      Returns FT1-18: "Patient Type" - creates it if necessary

    • getFt118_PatientType

      public IS getFt118_PatientType()
      Returns FT1-18: "Patient Type" - creates it if necessary

    • getDiagnosisCodeFT1

      public CE[] getDiagnosisCodeFT1()
      Returns all repetitions of Diagnosis Code - FT1 (FT1-19).

    • getFt119_DiagnosisCodeFT1

      public CE[] getFt119_DiagnosisCodeFT1()
      Returns all repetitions of Diagnosis Code - FT1 (FT1-19).

    • getDiagnosisCodeFT1Reps

      public int getDiagnosisCodeFT1Reps()
      Returns a count of the current number of repetitions of Diagnosis Code - FT1 (FT1-19). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getDiagnosisCodeFT1

      public CE getDiagnosisCodeFT1(int rep)
      Returns a specific repetition of FT1-19: "Diagnosis Code - FT1" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFt119_DiagnosisCodeFT1

      public CE getFt119_DiagnosisCodeFT1(int rep)
      Returns a specific repetition of FT1-19: "Diagnosis Code - FT1" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFt119_DiagnosisCodeFT1Reps

      public int getFt119_DiagnosisCodeFT1Reps()
      Returns a count of the current number of repetitions of Diagnosis Code - FT1 (FT1-19). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertDiagnosisCodeFT1

      public CE insertDiagnosisCodeFT1(int rep) throws HL7Exception
      Inserts a repetition of FT1-19: "Diagnosis Code - FT1" 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)

    • insertFt119_DiagnosisCodeFT1

      public CE insertFt119_DiagnosisCodeFT1(int rep) throws HL7Exception
      Inserts a repetition of FT1-19: "Diagnosis Code - FT1" 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)

    • removeDiagnosisCodeFT1

      public CE removeDiagnosisCodeFT1(int rep) throws HL7Exception
      Removes a repetition of FT1-19: "Diagnosis Code - FT1" 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)

    • removeFt119_DiagnosisCodeFT1

      public CE removeFt119_DiagnosisCodeFT1(int rep) throws HL7Exception
      Removes a repetition of FT1-19: "Diagnosis Code - FT1" 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)

    • getPerformedByCode

      public XCN[] getPerformedByCode()
      Returns all repetitions of Performed By Code (FT1-20).

    • getFt120_PerformedByCode

      public XCN[] getFt120_PerformedByCode()
      Returns all repetitions of Performed By Code (FT1-20).

    • getPerformedByCodeReps

      public int getPerformedByCodeReps()
      Returns a count of the current number of repetitions of Performed By Code (FT1-20). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getPerformedByCode

      public XCN getPerformedByCode(int rep)
      Returns a specific repetition of FT1-20: "Performed By Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFt120_PerformedByCode

      public XCN getFt120_PerformedByCode(int rep)
      Returns a specific repetition of FT1-20: "Performed By Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFt120_PerformedByCodeReps

      public int getFt120_PerformedByCodeReps()
      Returns a count of the current number of repetitions of Performed By Code (FT1-20). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertPerformedByCode

      public XCN insertPerformedByCode(int rep) throws HL7Exception
      Inserts a repetition of FT1-20: "Performed By Code" 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)

    • insertFt120_PerformedByCode

      public XCN insertFt120_PerformedByCode(int rep) throws HL7Exception
      Inserts a repetition of FT1-20: "Performed By Code" 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)

    • removePerformedByCode

      public XCN removePerformedByCode(int rep) throws HL7Exception
      Removes a repetition of FT1-20: "Performed By Code" 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)

    • removeFt120_PerformedByCode

      public XCN removeFt120_PerformedByCode(int rep) throws HL7Exception
      Removes a repetition of FT1-20: "Performed By Code" 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)

    • getOrderedByCode

      public XCN[] getOrderedByCode()
      Returns all repetitions of Ordered By Code (FT1-21).

    • getFt121_OrderedByCode

      public XCN[] getFt121_OrderedByCode()
      Returns all repetitions of Ordered By Code (FT1-21).

    • getOrderedByCodeReps

      public int getOrderedByCodeReps()
      Returns a count of the current number of repetitions of Ordered By Code (FT1-21). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getOrderedByCode

      public XCN getOrderedByCode(int rep)
      Returns a specific repetition of FT1-21: "Ordered By Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFt121_OrderedByCode

      public XCN getFt121_OrderedByCode(int rep)
      Returns a specific repetition of FT1-21: "Ordered By Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFt121_OrderedByCodeReps

      public int getFt121_OrderedByCodeReps()
      Returns a count of the current number of repetitions of Ordered By Code (FT1-21). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertOrderedByCode

      public XCN insertOrderedByCode(int rep) throws HL7Exception
      Inserts a repetition of FT1-21: "Ordered By Code" 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)

    • insertFt121_OrderedByCode

      public XCN insertFt121_OrderedByCode(int rep) throws HL7Exception
      Inserts a repetition of FT1-21: "Ordered By Code" 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)

    • removeOrderedByCode

      public XCN removeOrderedByCode(int rep) throws HL7Exception
      Removes a repetition of FT1-21: "Ordered By Code" 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)

    • removeFt121_OrderedByCode

      public XCN removeFt121_OrderedByCode(int rep) throws HL7Exception
      Removes a repetition of FT1-21: "Ordered By Code" 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)

    • getUnitCost

      public CP getUnitCost()
      Returns FT1-22: "Unit Cost" - creates it if necessary

    • getFt122_UnitCost

      public CP getFt122_UnitCost()
      Returns FT1-22: "Unit Cost" - creates it if necessary

    • getFillerOrderNumber

      public EI getFillerOrderNumber()
      Returns FT1-23: "Filler Order Number" - creates it if necessary

    • getFt123_FillerOrderNumber

      public EI getFt123_FillerOrderNumber()
      Returns FT1-23: "Filler Order Number" - creates it if necessary

    • getEnteredByCode

      public XCN[] getEnteredByCode()
      Returns all repetitions of Entered By Code (FT1-24).

    • getFt124_EnteredByCode

      public XCN[] getFt124_EnteredByCode()
      Returns all repetitions of Entered By Code (FT1-24).

    • getEnteredByCodeReps

      public int getEnteredByCodeReps()
      Returns a count of the current number of repetitions of Entered By Code (FT1-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getEnteredByCode

      public XCN getEnteredByCode(int rep)
      Returns a specific repetition of FT1-24: "Entered By Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFt124_EnteredByCode

      public XCN getFt124_EnteredByCode(int rep)
      Returns a specific repetition of FT1-24: "Entered By Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFt124_EnteredByCodeReps

      public int getFt124_EnteredByCodeReps()
      Returns a count of the current number of repetitions of Entered By Code (FT1-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertEnteredByCode

      public XCN insertEnteredByCode(int rep) throws HL7Exception
      Inserts a repetition of FT1-24: "Entered By Code" 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)

    • insertFt124_EnteredByCode

      public XCN insertFt124_EnteredByCode(int rep) throws HL7Exception
      Inserts a repetition of FT1-24: "Entered By Code" 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)

    • removeEnteredByCode

      public XCN removeEnteredByCode(int rep) throws HL7Exception
      Removes a repetition of FT1-24: "Entered By Code" 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)

    • removeFt124_EnteredByCode

      public XCN removeFt124_EnteredByCode(int rep) throws HL7Exception
      Removes a repetition of FT1-24: "Entered By Code" 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)

    • getProcedureCode

      public CE getProcedureCode()
      Returns FT1-25: "Procedure Code" - creates it if necessary

    • getFt125_ProcedureCode

      public CE getFt125_ProcedureCode()
      Returns FT1-25: "Procedure Code" - creates it if necessary

    • getProcedureCodeModifier

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

    • getFt126_ProcedureCodeModifier

      public CE[] getFt126_ProcedureCodeModifier()
      Returns all repetitions of Procedure Code Modifier (FT1-26).

    • getProcedureCodeModifierReps

      public int getProcedureCodeModifierReps()
      Returns a count of the current number of repetitions of Procedure Code Modifier (FT1-26). 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 FT1-26: "Procedure Code Modifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getFt126_ProcedureCodeModifier

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

    • getFt126_ProcedureCodeModifierReps

      public int getFt126_ProcedureCodeModifierReps()
      Returns a count of the current number of repetitions of Procedure Code Modifier (FT1-26). 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 FT1-26: "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)

    • insertFt126_ProcedureCodeModifier

      public CE insertFt126_ProcedureCodeModifier(int rep) throws HL7Exception
      Inserts a repetition of FT1-26: "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 FT1-26: "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)

    • removeFt126_ProcedureCodeModifier

      public CE removeFt126_ProcedureCodeModifier(int rep) throws HL7Exception
      Removes a repetition of FT1-26: "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