Package ca.uhn.hl7v2.model.v22.segment

Class FT1

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v22.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 - financial transaction (SI) optional
  • FT1-2: Transaction ID (ST) optional
  • FT1-3: Transaction batch ID (ST) optional
  • FT1-4: Transaction date (DT)
  • FT1-5: Transaction posting date (DT) optional
  • FT1-6: Transaction type (ID)
  • FT1-7: Transaction code (CE)
  • FT1-8: Transaction description (ST) optional
  • FT1-9: Transaction description - alternate (ST) optional
  • FT1-10: Transaction quantity (NM) optional
  • FT1-11: Transaction amount - extended (NM) optional
  • FT1-12: Transaction amount - unit (NM) optional
  • FT1-13: Department code (CE) optional
  • FT1-14: Insurance plan ID (ID)
  • FT1-15: Insurance amount (NM) optional
  • FT1-16: Assigned Patient Location (CM_INTERNAL_LOCATION) optional
  • FT1-17: Fee schedule (ID) optional
  • FT1-18: Patient type (ID) optional
  • FT1-19: Diagnosis code (CE) optional repeating
  • FT1-20: Performed by code (CN) optional
  • FT1-21: Ordered by code (CN) optional
  • FT1-22: Unit cost (NM) optional
  • FT1-23: Filler Order Number (CM_FILLER) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDFinancialTransaction

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

    • getFt11_SetIDFinancialTransaction

      public SI getFt11_SetIDFinancialTransaction()
      Returns FT1-1: "Set ID - financial transaction" - 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 DT getTransactionDate()
      Returns FT1-4: "Transaction date" - creates it if necessary

    • getFt14_TransactionDate

      public DT getFt14_TransactionDate()
      Returns FT1-4: "Transaction date" - creates it if necessary

    • getTransactionPostingDate

      public DT getTransactionPostingDate()
      Returns FT1-5: "Transaction posting date" - creates it if necessary

    • getFt15_TransactionPostingDate

      public DT getFt15_TransactionPostingDate()
      Returns FT1-5: "Transaction posting date" - creates it if necessary

    • getTransactionType

      public ID getTransactionType()
      Returns FT1-6: "Transaction type" - creates it if necessary

    • getFt16_TransactionType

      public ID 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

    • getTransactionDescriptionAlternate

      public ST getTransactionDescriptionAlternate()
      Returns FT1-9: "Transaction description - alternate" - creates it if necessary

    • getFt19_TransactionDescriptionAlternate

      public ST getFt19_TransactionDescriptionAlternate()
      Returns FT1-9: "Transaction description - alternate" - 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 NM getTransactionAmountExtended()
      Returns FT1-11: "Transaction amount - extended" - creates it if necessary

    • getFt111_TransactionAmountExtended

      public NM getFt111_TransactionAmountExtended()
      Returns FT1-11: "Transaction amount - extended" - creates it if necessary

    • getTransactionAmountUnit

      public NM getTransactionAmountUnit()
      Returns FT1-12: "Transaction amount - unit" - creates it if necessary

    • getFt112_TransactionAmountUnit

      public NM 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 ID getInsurancePlanID()
      Returns FT1-14: "Insurance plan ID" - creates it if necessary

    • getFt114_InsurancePlanID

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

    • getInsuranceAmount

      public NM getInsuranceAmount()
      Returns FT1-15: "Insurance amount" - creates it if necessary

    • getFt115_InsuranceAmount

      public NM getFt115_InsuranceAmount()
      Returns FT1-15: "Insurance amount" - creates it if necessary

    • getAssignedPatientLocation

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

    • getFt116_AssignedPatientLocation

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

    • getFeeSchedule

      public ID getFeeSchedule()
      Returns FT1-17: "Fee schedule" - creates it if necessary

    • getFt117_FeeSchedule

      public ID getFt117_FeeSchedule()
      Returns FT1-17: "Fee schedule" - creates it if necessary

    • getPatientType

      public ID getPatientType()
      Returns FT1-18: "Patient type" - creates it if necessary

    • getFt118_PatientType

      public ID getFt118_PatientType()
      Returns FT1-18: "Patient type" - creates it if necessary

    • getDiagnosisCode

      public CE[] getDiagnosisCode()
      Returns all repetitions of Diagnosis code (FT1-19).

    • getFt119_DiagnosisCode

      public CE[] getFt119_DiagnosisCode()
      Returns all repetitions of Diagnosis code (FT1-19).

    • getDiagnosisCodeReps

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

    • getDiagnosisCode

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

    • getFt119_DiagnosisCode

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

    • getFt119_DiagnosisCodeReps

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

    • insertDiagnosisCode

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

    • insertFt119_DiagnosisCode

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

    • removeDiagnosisCode

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

    • removeFt119_DiagnosisCode

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

    • getPerformedByCode

      public CN getPerformedByCode()
      Returns FT1-20: "Performed by code" - creates it if necessary

    • getFt120_PerformedByCode

      public CN getFt120_PerformedByCode()
      Returns FT1-20: "Performed by code" - creates it if necessary

    • getOrderedByCode

      public CN getOrderedByCode()
      Returns FT1-21: "Ordered by code" - creates it if necessary

    • getFt121_OrderedByCode

      public CN getFt121_OrderedByCode()
      Returns FT1-21: "Ordered by code" - creates it if necessary

    • getUnitCost

      public NM getUnitCost()
      Returns FT1-22: "Unit cost" - creates it if necessary

    • getFt122_UnitCost

      public NM getFt122_UnitCost()
      Returns FT1-22: "Unit cost" - creates it if necessary

    • getFillerOrderNumber

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

    • getFt123_FillerOrderNumber

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

    • createNewTypeWithoutReflection

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