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

Class IN2

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

Represents an HL7 IN2 message segment (INSURANCE ADDITIONAL INFO). This segment has the following fields:

  • IN2-1: Insured's employee ID (ST) optional
  • IN2-2: Insured's social security number (ST) optional
  • IN2-3: Insured's employer name (CN) optional
  • IN2-4: Employer information data (ID) optional
  • IN2-5: Mail claim party (ID) optional
  • IN2-6: Medicare health insurance card number (NM) optional
  • IN2-7: Medicaid case name (PN) optional
  • IN2-8: Medicaid case number (NM) optional
  • IN2-9: Champus sponsor name (PN) optional
  • IN2-10: Champus ID number (NM) optional
  • IN2-11: Dependent of champus recipient (ID) optional
  • IN2-12: Champus organization (ST) optional
  • IN2-13: Champus station (ST) optional
  • IN2-14: Champus service (ID) optional
  • IN2-15: Champus rank / grade (ID) optional
  • IN2-16: Champus status (ID) optional
  • IN2-17: Champus retire date (DT) optional
  • IN2-18: Champus non-availability certification on file (ID) optional
  • IN2-19: Baby coverage (ID) optional
  • IN2-20: Combine baby bill (ID) optional
  • IN2-21: Blood deductible (NM) optional
  • IN2-22: Special coverage approval name (PN) optional
  • IN2-23: Special coverage approval title (ST) optional
  • IN2-24: Non-covered insurance code (ID) optional repeating
  • IN2-25: Payor ID (ST) optional
  • IN2-26: Payor subscriber ID (ST) optional
  • IN2-27: Eligibility source (ID) optional
  • IN2-28: Room coverage type / amount (CM_RMC) optional repeating
  • IN2-29: Policy type / amount (CM_PTA) optional repeating
  • IN2-30: Daily deductible (CM_DDI) optional
See Also:

  • Constructor Details

  • Method Details

    • getInsuredSEmployeeID

      public ST getInsuredSEmployeeID()
      Returns IN2-1: "Insured's employee ID" - creates it if necessary

    • getIn21_InsuredSEmployeeID

      public ST getIn21_InsuredSEmployeeID()
      Returns IN2-1: "Insured's employee ID" - creates it if necessary

    • getInsuredSSocialSecurityNumber

      public ST getInsuredSSocialSecurityNumber()
      Returns IN2-2: "Insured's social security number" - creates it if necessary

    • getIn22_InsuredSSocialSecurityNumber

      public ST getIn22_InsuredSSocialSecurityNumber()
      Returns IN2-2: "Insured's social security number" - creates it if necessary

    • getInsuredSEmployerName

      public CN getInsuredSEmployerName()
      Returns IN2-3: "Insured's employer name" - creates it if necessary

    • getIn23_InsuredSEmployerName

      public CN getIn23_InsuredSEmployerName()
      Returns IN2-3: "Insured's employer name" - creates it if necessary

    • getEmployerInformationData

      public ID getEmployerInformationData()
      Returns IN2-4: "Employer information data" - creates it if necessary

    • getIn24_EmployerInformationData

      public ID getIn24_EmployerInformationData()
      Returns IN2-4: "Employer information data" - creates it if necessary

    • getMailClaimParty

      public ID getMailClaimParty()
      Returns IN2-5: "Mail claim party" - creates it if necessary

    • getIn25_MailClaimParty

      public ID getIn25_MailClaimParty()
      Returns IN2-5: "Mail claim party" - creates it if necessary

    • getMedicareHealthInsuranceCardNumber

      public NM getMedicareHealthInsuranceCardNumber()
      Returns IN2-6: "Medicare health insurance card number" - creates it if necessary

    • getIn26_MedicareHealthInsuranceCardNumber

      public NM getIn26_MedicareHealthInsuranceCardNumber()
      Returns IN2-6: "Medicare health insurance card number" - creates it if necessary

    • getMedicaidCaseName

      public PN getMedicaidCaseName()
      Returns IN2-7: "Medicaid case name" - creates it if necessary

    • getIn27_MedicaidCaseName

      public PN getIn27_MedicaidCaseName()
      Returns IN2-7: "Medicaid case name" - creates it if necessary

    • getMedicaidCaseNumber

      public NM getMedicaidCaseNumber()
      Returns IN2-8: "Medicaid case number" - creates it if necessary

    • getIn28_MedicaidCaseNumber

      public NM getIn28_MedicaidCaseNumber()
      Returns IN2-8: "Medicaid case number" - creates it if necessary

    • getChampusSponsorName

      public PN getChampusSponsorName()
      Returns IN2-9: "Champus sponsor name" - creates it if necessary

    • getIn29_ChampusSponsorName

      public PN getIn29_ChampusSponsorName()
      Returns IN2-9: "Champus sponsor name" - creates it if necessary

    • getChampusIDNumber

      public NM getChampusIDNumber()
      Returns IN2-10: "Champus ID number" - creates it if necessary

    • getIn210_ChampusIDNumber

      public NM getIn210_ChampusIDNumber()
      Returns IN2-10: "Champus ID number" - creates it if necessary

    • getDependentOfChampusRecipient

      public ID getDependentOfChampusRecipient()
      Returns IN2-11: "Dependent of champus recipient" - creates it if necessary

    • getIn211_DependentOfChampusRecipient

      public ID getIn211_DependentOfChampusRecipient()
      Returns IN2-11: "Dependent of champus recipient" - creates it if necessary

    • getChampusOrganization

      public ST getChampusOrganization()
      Returns IN2-12: "Champus organization" - creates it if necessary

    • getIn212_ChampusOrganization

      public ST getIn212_ChampusOrganization()
      Returns IN2-12: "Champus organization" - creates it if necessary

    • getChampusStation

      public ST getChampusStation()
      Returns IN2-13: "Champus station" - creates it if necessary

    • getIn213_ChampusStation

      public ST getIn213_ChampusStation()
      Returns IN2-13: "Champus station" - creates it if necessary

    • getChampusService

      public ID getChampusService()
      Returns IN2-14: "Champus service" - creates it if necessary

    • getIn214_ChampusService

      public ID getIn214_ChampusService()
      Returns IN2-14: "Champus service" - creates it if necessary

    • getChampusRankGrade

      public ID getChampusRankGrade()
      Returns IN2-15: "Champus rank / grade" - creates it if necessary

    • getIn215_ChampusRankGrade

      public ID getIn215_ChampusRankGrade()
      Returns IN2-15: "Champus rank / grade" - creates it if necessary

    • getChampusStatus

      public ID getChampusStatus()
      Returns IN2-16: "Champus status" - creates it if necessary

    • getIn216_ChampusStatus

      public ID getIn216_ChampusStatus()
      Returns IN2-16: "Champus status" - creates it if necessary

    • getChampusRetireDate

      public DT getChampusRetireDate()
      Returns IN2-17: "Champus retire date" - creates it if necessary

    • getIn217_ChampusRetireDate

      public DT getIn217_ChampusRetireDate()
      Returns IN2-17: "Champus retire date" - creates it if necessary

    • getChampusNonAvailabilityCertificationOnFile

      public ID getChampusNonAvailabilityCertificationOnFile()
      Returns IN2-18: "Champus non-availability certification on file" - creates it if necessary

    • getIn218_ChampusNonAvailabilityCertificationOnFile

      public ID getIn218_ChampusNonAvailabilityCertificationOnFile()
      Returns IN2-18: "Champus non-availability certification on file" - creates it if necessary

    • getBabyCoverage

      public ID getBabyCoverage()
      Returns IN2-19: "Baby coverage" - creates it if necessary

    • getIn219_BabyCoverage

      public ID getIn219_BabyCoverage()
      Returns IN2-19: "Baby coverage" - creates it if necessary

    • getCombineBabyBill

      public ID getCombineBabyBill()
      Returns IN2-20: "Combine baby bill" - creates it if necessary

    • getIn220_CombineBabyBill

      public ID getIn220_CombineBabyBill()
      Returns IN2-20: "Combine baby bill" - creates it if necessary

    • getBloodDeductible

      public NM getBloodDeductible()
      Returns IN2-21: "Blood deductible" - creates it if necessary

    • getIn221_BloodDeductible

      public NM getIn221_BloodDeductible()
      Returns IN2-21: "Blood deductible" - creates it if necessary

    • getSpecialCoverageApprovalName

      public PN getSpecialCoverageApprovalName()
      Returns IN2-22: "Special coverage approval name" - creates it if necessary

    • getIn222_SpecialCoverageApprovalName

      public PN getIn222_SpecialCoverageApprovalName()
      Returns IN2-22: "Special coverage approval name" - creates it if necessary

    • getSpecialCoverageApprovalTitle

      public ST getSpecialCoverageApprovalTitle()
      Returns IN2-23: "Special coverage approval title" - creates it if necessary

    • getIn223_SpecialCoverageApprovalTitle

      public ST getIn223_SpecialCoverageApprovalTitle()
      Returns IN2-23: "Special coverage approval title" - creates it if necessary

    • getNonCoveredInsuranceCode

      public ID[] getNonCoveredInsuranceCode()
      Returns all repetitions of Non-covered insurance code (IN2-24).

    • getIn224_NonCoveredInsuranceCode

      public ID[] getIn224_NonCoveredInsuranceCode()
      Returns all repetitions of Non-covered insurance code (IN2-24).

    • getNonCoveredInsuranceCodeReps

      public int getNonCoveredInsuranceCodeReps()
      Returns a count of the current number of repetitions of Non-covered insurance code (IN2-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getNonCoveredInsuranceCode

      public ID getNonCoveredInsuranceCode(int rep)
      Returns a specific repetition of IN2-24: "Non-covered insurance code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn224_NonCoveredInsuranceCode

      public ID getIn224_NonCoveredInsuranceCode(int rep)
      Returns a specific repetition of IN2-24: "Non-covered insurance code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn224_NonCoveredInsuranceCodeReps

      public int getIn224_NonCoveredInsuranceCodeReps()
      Returns a count of the current number of repetitions of Non-covered insurance code (IN2-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertNonCoveredInsuranceCode

      public ID insertNonCoveredInsuranceCode(int rep) throws HL7Exception
      Inserts a repetition of IN2-24: "Non-covered insurance 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)

    • insertIn224_NonCoveredInsuranceCode

      public ID insertIn224_NonCoveredInsuranceCode(int rep) throws HL7Exception
      Inserts a repetition of IN2-24: "Non-covered insurance 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)

    • removeNonCoveredInsuranceCode

      public ID removeNonCoveredInsuranceCode(int rep) throws HL7Exception
      Removes a repetition of IN2-24: "Non-covered insurance 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)

    • removeIn224_NonCoveredInsuranceCode

      public ID removeIn224_NonCoveredInsuranceCode(int rep) throws HL7Exception
      Removes a repetition of IN2-24: "Non-covered insurance 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)

    • getPayorID

      public ST getPayorID()
      Returns IN2-25: "Payor ID" - creates it if necessary

    • getIn225_PayorID

      public ST getIn225_PayorID()
      Returns IN2-25: "Payor ID" - creates it if necessary

    • getPayorSubscriberID

      public ST getPayorSubscriberID()
      Returns IN2-26: "Payor subscriber ID" - creates it if necessary

    • getIn226_PayorSubscriberID

      public ST getIn226_PayorSubscriberID()
      Returns IN2-26: "Payor subscriber ID" - creates it if necessary

    • getEligibilitySource

      public ID getEligibilitySource()
      Returns IN2-27: "Eligibility source" - creates it if necessary

    • getIn227_EligibilitySource

      public ID getIn227_EligibilitySource()
      Returns IN2-27: "Eligibility source" - creates it if necessary

    • getRoomCoverageTypeAmount

      public CM_RMC[] getRoomCoverageTypeAmount()
      Returns all repetitions of Room coverage type / amount (IN2-28).

    • getIn228_RoomCoverageTypeAmount

      public CM_RMC[] getIn228_RoomCoverageTypeAmount()
      Returns all repetitions of Room coverage type / amount (IN2-28).

    • getRoomCoverageTypeAmountReps

      public int getRoomCoverageTypeAmountReps()
      Returns a count of the current number of repetitions of Room coverage type / amount (IN2-28). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getRoomCoverageTypeAmount

      public CM_RMC getRoomCoverageTypeAmount(int rep)
      Returns a specific repetition of IN2-28: "Room coverage type / amount" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn228_RoomCoverageTypeAmount

      public CM_RMC getIn228_RoomCoverageTypeAmount(int rep)
      Returns a specific repetition of IN2-28: "Room coverage type / amount" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn228_RoomCoverageTypeAmountReps

      public int getIn228_RoomCoverageTypeAmountReps()
      Returns a count of the current number of repetitions of Room coverage type / amount (IN2-28). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertRoomCoverageTypeAmount

      public CM_RMC insertRoomCoverageTypeAmount(int rep) throws HL7Exception
      Inserts a repetition of IN2-28: "Room coverage type / amount" 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)

    • insertIn228_RoomCoverageTypeAmount

      public CM_RMC insertIn228_RoomCoverageTypeAmount(int rep) throws HL7Exception
      Inserts a repetition of IN2-28: "Room coverage type / amount" 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)

    • removeRoomCoverageTypeAmount

      public CM_RMC removeRoomCoverageTypeAmount(int rep) throws HL7Exception
      Removes a repetition of IN2-28: "Room coverage type / amount" 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)

    • removeIn228_RoomCoverageTypeAmount

      public CM_RMC removeIn228_RoomCoverageTypeAmount(int rep) throws HL7Exception
      Removes a repetition of IN2-28: "Room coverage type / amount" 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)

    • getPolicyTypeAmount

      public CM_PTA[] getPolicyTypeAmount()
      Returns all repetitions of Policy type / amount (IN2-29).

    • getIn229_PolicyTypeAmount

      public CM_PTA[] getIn229_PolicyTypeAmount()
      Returns all repetitions of Policy type / amount (IN2-29).

    • getPolicyTypeAmountReps

      public int getPolicyTypeAmountReps()
      Returns a count of the current number of repetitions of Policy type / amount (IN2-29). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getPolicyTypeAmount

      public CM_PTA getPolicyTypeAmount(int rep)
      Returns a specific repetition of IN2-29: "Policy type / amount" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn229_PolicyTypeAmount

      public CM_PTA getIn229_PolicyTypeAmount(int rep)
      Returns a specific repetition of IN2-29: "Policy type / amount" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn229_PolicyTypeAmountReps

      public int getIn229_PolicyTypeAmountReps()
      Returns a count of the current number of repetitions of Policy type / amount (IN2-29). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertPolicyTypeAmount

      public CM_PTA insertPolicyTypeAmount(int rep) throws HL7Exception
      Inserts a repetition of IN2-29: "Policy type / amount" 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)

    • insertIn229_PolicyTypeAmount

      public CM_PTA insertIn229_PolicyTypeAmount(int rep) throws HL7Exception
      Inserts a repetition of IN2-29: "Policy type / amount" 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)

    • removePolicyTypeAmount

      public CM_PTA removePolicyTypeAmount(int rep) throws HL7Exception
      Removes a repetition of IN2-29: "Policy type / amount" 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)

    • removeIn229_PolicyTypeAmount

      public CM_PTA removeIn229_PolicyTypeAmount(int rep) throws HL7Exception
      Removes a repetition of IN2-29: "Policy type / amount" 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)

    • getDailyDeductible

      public CM_DDI getDailyDeductible()
      Returns IN2-30: "Daily deductible" - creates it if necessary

    • getIn230_DailyDeductible

      public CM_DDI getIn230_DailyDeductible()
      Returns IN2-30: "Daily deductible" - creates it if necessary

    • createNewTypeWithoutReflection

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