Package ca.uhn.hl7v2.model.v23.segment

Class IN1

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

Represents an HL7 IN1 message segment (Insurance). This segment has the following fields:

  • IN1-1: Set ID - Insurance (SI)
  • IN1-2: Insurance Plan ID (CE) optional
  • IN1-3: Insurance Company ID (CX)
  • IN1-4: Insurance Company Name (XON) optional
  • IN1-5: Insurance Company Address (XAD) optional
  • IN1-6: Insurance Co. Contact Ppers (XPN) optional
  • IN1-7: Insurance Co Phone Number (XTN) optional repeating
  • IN1-8: Group Number (ST) optional
  • IN1-9: Group Name (XON) optional
  • IN1-10: Insured's group employer ID (CX) optional
  • IN1-11: Insured's Group Emp Name (XON) optional
  • IN1-12: Plan Effective Date (DT) optional
  • IN1-13: Plan Expiration Date (DT) optional
  • IN1-14: Authorization Information (CM_AUI) optional
  • IN1-15: Plan Type (IS) optional
  • IN1-16: Name of Insured (XPN) optional
  • IN1-17: Insured's Relationship to Patient (IS) optional
  • IN1-18: Insured's Date of Birth (TS) optional
  • IN1-19: Insured's Address (XAD) optional
  • IN1-20: Assignment of Benefits (IS) optional
  • IN1-21: Coordination of Benefits (IS) optional
  • IN1-22: Coord of Ben. Priority (ST) optional
  • IN1-23: Notice of Admission Code (ID) optional
  • IN1-24: Notice of Admission Date (DT) optional
  • IN1-25: Rpt of Eigibility Code (ID) optional
  • IN1-26: Rpt of Eligibility Date (DT) optional
  • IN1-27: Release Information Code (IS) optional
  • IN1-28: Pre-Admit Cert (PAC) (ST) optional
  • IN1-29: Verification Date/Time (TS) optional
  • IN1-30: Verification By (XPN) optional
  • IN1-31: Type of Agreement Code (IS) optional
  • IN1-32: Billing Status (IS) optional
  • IN1-33: Lifetime Reserve Days (NM) optional
  • IN1-34: Delay before lifetime reserve days (NM) optional
  • IN1-35: Company Plan Code (IS) optional
  • IN1-36: Policy Number (ST) optional
  • IN1-37: Policy Deductible (CP) optional
  • IN1-38: Policy Limit - Amount (CP) optional
  • IN1-39: Policy Limit - Days (NM) optional
  • IN1-40: Room Rate - Semi-Private (CP) optional
  • IN1-41: Room Rate - Private (CP) optional
  • IN1-42: Insured's Employment Status (CE) optional
  • IN1-43: Insured's Sex (IS) optional
  • IN1-44: Insured's Employer Address (XAD) optional
  • IN1-45: Verification Status (ST) optional
  • IN1-46: Prior Insurance Plan ID (IS) optional
  • IN1-47: Coverage Type (IS) optional
  • IN1-48: Handicap (IS) optional
  • IN1-49: Insured's ID Number (CX) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDInsurance

      public SI getSetIDInsurance()
      Returns IN1-1: "Set ID - Insurance" - creates it if necessary

    • getIn11_SetIDInsurance

      public SI getIn11_SetIDInsurance()
      Returns IN1-1: "Set ID - Insurance" - creates it if necessary

    • getInsurancePlanID

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

    • getIn12_InsurancePlanID

      public CE getIn12_InsurancePlanID()
      Returns IN1-2: "Insurance Plan ID" - creates it if necessary

    • getInsuranceCompanyID

      public CX getInsuranceCompanyID()
      Returns IN1-3: "Insurance Company ID" - creates it if necessary

    • getIn13_InsuranceCompanyID

      public CX getIn13_InsuranceCompanyID()
      Returns IN1-3: "Insurance Company ID" - creates it if necessary

    • getInsuranceCompanyName

      public XON getInsuranceCompanyName()
      Returns IN1-4: "Insurance Company Name" - creates it if necessary

    • getIn14_InsuranceCompanyName

      public XON getIn14_InsuranceCompanyName()
      Returns IN1-4: "Insurance Company Name" - creates it if necessary

    • getInsuranceCompanyAddress

      public XAD getInsuranceCompanyAddress()
      Returns IN1-5: "Insurance Company Address" - creates it if necessary

    • getIn15_InsuranceCompanyAddress

      public XAD getIn15_InsuranceCompanyAddress()
      Returns IN1-5: "Insurance Company Address" - creates it if necessary

    • getInsuranceCoContactPpers

      public XPN getInsuranceCoContactPpers()
      Returns IN1-6: "Insurance Co. Contact Ppers" - creates it if necessary

    • getIn16_InsuranceCoContactPpers

      public XPN getIn16_InsuranceCoContactPpers()
      Returns IN1-6: "Insurance Co. Contact Ppers" - creates it if necessary

    • getInsuranceCoPhoneNumber

      public XTN[] getInsuranceCoPhoneNumber()
      Returns all repetitions of Insurance Co Phone Number (IN1-7).

    • getIn17_InsuranceCoPhoneNumber

      public XTN[] getIn17_InsuranceCoPhoneNumber()
      Returns all repetitions of Insurance Co Phone Number (IN1-7).

    • getInsuranceCoPhoneNumberReps

      public int getInsuranceCoPhoneNumberReps()
      Returns a count of the current number of repetitions of Insurance Co Phone Number (IN1-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getInsuranceCoPhoneNumber

      public XTN getInsuranceCoPhoneNumber(int rep)
      Returns a specific repetition of IN1-7: "Insurance Co Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn17_InsuranceCoPhoneNumber

      public XTN getIn17_InsuranceCoPhoneNumber(int rep)
      Returns a specific repetition of IN1-7: "Insurance Co Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn17_InsuranceCoPhoneNumberReps

      public int getIn17_InsuranceCoPhoneNumberReps()
      Returns a count of the current number of repetitions of Insurance Co Phone Number (IN1-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertInsuranceCoPhoneNumber

      public XTN insertInsuranceCoPhoneNumber(int rep) throws HL7Exception
      Inserts a repetition of IN1-7: "Insurance Co Phone Number" 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)

    • insertIn17_InsuranceCoPhoneNumber

      public XTN insertIn17_InsuranceCoPhoneNumber(int rep) throws HL7Exception
      Inserts a repetition of IN1-7: "Insurance Co Phone Number" 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)

    • removeInsuranceCoPhoneNumber

      public XTN removeInsuranceCoPhoneNumber(int rep) throws HL7Exception
      Removes a repetition of IN1-7: "Insurance Co Phone Number" 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)

    • removeIn17_InsuranceCoPhoneNumber

      public XTN removeIn17_InsuranceCoPhoneNumber(int rep) throws HL7Exception
      Removes a repetition of IN1-7: "Insurance Co Phone Number" 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)

    • getGroupNumber

      public ST getGroupNumber()
      Returns IN1-8: "Group Number" - creates it if necessary

    • getIn18_GroupNumber

      public ST getIn18_GroupNumber()
      Returns IN1-8: "Group Number" - creates it if necessary

    • getGroupName

      public XON getGroupName()
      Returns IN1-9: "Group Name" - creates it if necessary

    • getIn19_GroupName

      public XON getIn19_GroupName()
      Returns IN1-9: "Group Name" - creates it if necessary

    • getInsuredSGroupEmployerID

      public CX getInsuredSGroupEmployerID()
      Returns IN1-10: "Insured's group employer ID" - creates it if necessary

    • getIn110_InsuredSGroupEmployerID

      public CX getIn110_InsuredSGroupEmployerID()
      Returns IN1-10: "Insured's group employer ID" - creates it if necessary

    • getInsuredSGroupEmpName

      public XON getInsuredSGroupEmpName()
      Returns IN1-11: "Insured's Group Emp Name" - creates it if necessary

    • getIn111_InsuredSGroupEmpName

      public XON getIn111_InsuredSGroupEmpName()
      Returns IN1-11: "Insured's Group Emp Name" - creates it if necessary

    • getPlanEffectiveDate

      public DT getPlanEffectiveDate()
      Returns IN1-12: "Plan Effective Date" - creates it if necessary

    • getIn112_PlanEffectiveDate

      public DT getIn112_PlanEffectiveDate()
      Returns IN1-12: "Plan Effective Date" - creates it if necessary

    • getPlanExpirationDate

      public DT getPlanExpirationDate()
      Returns IN1-13: "Plan Expiration Date" - creates it if necessary

    • getIn113_PlanExpirationDate

      public DT getIn113_PlanExpirationDate()
      Returns IN1-13: "Plan Expiration Date" - creates it if necessary

    • getAuthorizationInformation

      public CM_AUI getAuthorizationInformation()
      Returns IN1-14: "Authorization Information" - creates it if necessary

    • getIn114_AuthorizationInformation

      public CM_AUI getIn114_AuthorizationInformation()
      Returns IN1-14: "Authorization Information" - creates it if necessary

    • getPlanType

      public IS getPlanType()
      Returns IN1-15: "Plan Type" - creates it if necessary

    • getIn115_PlanType

      public IS getIn115_PlanType()
      Returns IN1-15: "Plan Type" - creates it if necessary

    • getNameOfInsured

      public XPN getNameOfInsured()
      Returns IN1-16: "Name of Insured" - creates it if necessary

    • getIn116_NameOfInsured

      public XPN getIn116_NameOfInsured()
      Returns IN1-16: "Name of Insured" - creates it if necessary

    • getInsuredSRelationshipToPatient

      public IS getInsuredSRelationshipToPatient()
      Returns IN1-17: "Insured's Relationship to Patient" - creates it if necessary

    • getIn117_InsuredSRelationshipToPatient

      public IS getIn117_InsuredSRelationshipToPatient()
      Returns IN1-17: "Insured's Relationship to Patient" - creates it if necessary

    • getInsuredSDateOfBirth

      public TS getInsuredSDateOfBirth()
      Returns IN1-18: "Insured's Date of Birth" - creates it if necessary

    • getIn118_InsuredSDateOfBirth

      public TS getIn118_InsuredSDateOfBirth()
      Returns IN1-18: "Insured's Date of Birth" - creates it if necessary

    • getInsuredSAddress

      public XAD getInsuredSAddress()
      Returns IN1-19: "Insured's Address" - creates it if necessary

    • getIn119_InsuredSAddress

      public XAD getIn119_InsuredSAddress()
      Returns IN1-19: "Insured's Address" - creates it if necessary

    • getAssignmentOfBenefits

      public IS getAssignmentOfBenefits()
      Returns IN1-20: "Assignment of Benefits" - creates it if necessary

    • getIn120_AssignmentOfBenefits

      public IS getIn120_AssignmentOfBenefits()
      Returns IN1-20: "Assignment of Benefits" - creates it if necessary

    • getCoordinationOfBenefits

      public IS getCoordinationOfBenefits()
      Returns IN1-21: "Coordination of Benefits" - creates it if necessary

    • getIn121_CoordinationOfBenefits

      public IS getIn121_CoordinationOfBenefits()
      Returns IN1-21: "Coordination of Benefits" - creates it if necessary

    • getCoordOfBenPriority

      public ST getCoordOfBenPriority()
      Returns IN1-22: "Coord of Ben. Priority" - creates it if necessary

    • getIn122_CoordOfBenPriority

      public ST getIn122_CoordOfBenPriority()
      Returns IN1-22: "Coord of Ben. Priority" - creates it if necessary

    • getNoticeOfAdmissionCode

      public ID getNoticeOfAdmissionCode()
      Returns IN1-23: "Notice of Admission Code" - creates it if necessary

    • getIn123_NoticeOfAdmissionCode

      public ID getIn123_NoticeOfAdmissionCode()
      Returns IN1-23: "Notice of Admission Code" - creates it if necessary

    • getNoticeOfAdmissionDate

      public DT getNoticeOfAdmissionDate()
      Returns IN1-24: "Notice of Admission Date" - creates it if necessary

    • getIn124_NoticeOfAdmissionDate

      public DT getIn124_NoticeOfAdmissionDate()
      Returns IN1-24: "Notice of Admission Date" - creates it if necessary

    • getRptOfEigibilityCode

      public ID getRptOfEigibilityCode()
      Returns IN1-25: "Rpt of Eigibility Code" - creates it if necessary

    • getIn125_RptOfEigibilityCode

      public ID getIn125_RptOfEigibilityCode()
      Returns IN1-25: "Rpt of Eigibility Code" - creates it if necessary

    • getRptOfEligibilityDate

      public DT getRptOfEligibilityDate()
      Returns IN1-26: "Rpt of Eligibility Date" - creates it if necessary

    • getIn126_RptOfEligibilityDate

      public DT getIn126_RptOfEligibilityDate()
      Returns IN1-26: "Rpt of Eligibility Date" - creates it if necessary

    • getReleaseInformationCode

      public IS getReleaseInformationCode()
      Returns IN1-27: "Release Information Code" - creates it if necessary

    • getIn127_ReleaseInformationCode

      public IS getIn127_ReleaseInformationCode()
      Returns IN1-27: "Release Information Code" - creates it if necessary

    • getPreAdmitCert

      public ST getPreAdmitCert()
      Returns IN1-28: "Pre-Admit Cert (PAC)" - creates it if necessary

    • getIn128_PreAdmitCert

      public ST getIn128_PreAdmitCert()
      Returns IN1-28: "Pre-Admit Cert (PAC)" - creates it if necessary

    • getVerificationDateTime

      public TS getVerificationDateTime()
      Returns IN1-29: "Verification Date/Time" - creates it if necessary

    • getIn129_VerificationDateTime

      public TS getIn129_VerificationDateTime()
      Returns IN1-29: "Verification Date/Time" - creates it if necessary

    • getVerificationBy

      public XPN getVerificationBy()
      Returns IN1-30: "Verification By" - creates it if necessary

    • getIn130_VerificationBy

      public XPN getIn130_VerificationBy()
      Returns IN1-30: "Verification By" - creates it if necessary

    • getTypeOfAgreementCode

      public IS getTypeOfAgreementCode()
      Returns IN1-31: "Type of Agreement Code" - creates it if necessary

    • getIn131_TypeOfAgreementCode

      public IS getIn131_TypeOfAgreementCode()
      Returns IN1-31: "Type of Agreement Code" - creates it if necessary

    • getBillingStatus

      public IS getBillingStatus()
      Returns IN1-32: "Billing Status" - creates it if necessary

    • getIn132_BillingStatus

      public IS getIn132_BillingStatus()
      Returns IN1-32: "Billing Status" - creates it if necessary

    • getLifetimeReserveDays

      public NM getLifetimeReserveDays()
      Returns IN1-33: "Lifetime Reserve Days" - creates it if necessary

    • getIn133_LifetimeReserveDays

      public NM getIn133_LifetimeReserveDays()
      Returns IN1-33: "Lifetime Reserve Days" - creates it if necessary

    • getDelayBeforeLifetimeReserveDays

      public NM getDelayBeforeLifetimeReserveDays()
      Returns IN1-34: "Delay before lifetime reserve days" - creates it if necessary

    • getIn134_DelayBeforeLifetimeReserveDays

      public NM getIn134_DelayBeforeLifetimeReserveDays()
      Returns IN1-34: "Delay before lifetime reserve days" - creates it if necessary

    • getCompanyPlanCode

      public IS getCompanyPlanCode()
      Returns IN1-35: "Company Plan Code" - creates it if necessary

    • getIn135_CompanyPlanCode

      public IS getIn135_CompanyPlanCode()
      Returns IN1-35: "Company Plan Code" - creates it if necessary

    • getPolicyNumber

      public ST getPolicyNumber()
      Returns IN1-36: "Policy Number" - creates it if necessary

    • getIn136_PolicyNumber

      public ST getIn136_PolicyNumber()
      Returns IN1-36: "Policy Number" - creates it if necessary

    • getPolicyDeductible

      public CP getPolicyDeductible()
      Returns IN1-37: "Policy Deductible" - creates it if necessary

    • getIn137_PolicyDeductible

      public CP getIn137_PolicyDeductible()
      Returns IN1-37: "Policy Deductible" - creates it if necessary

    • getPolicyLimitAmount

      public CP getPolicyLimitAmount()
      Returns IN1-38: "Policy Limit - Amount" - creates it if necessary

    • getIn138_PolicyLimitAmount

      public CP getIn138_PolicyLimitAmount()
      Returns IN1-38: "Policy Limit - Amount" - creates it if necessary

    • getPolicyLimitDays

      public NM getPolicyLimitDays()
      Returns IN1-39: "Policy Limit - Days" - creates it if necessary

    • getIn139_PolicyLimitDays

      public NM getIn139_PolicyLimitDays()
      Returns IN1-39: "Policy Limit - Days" - creates it if necessary

    • getRoomRateSemiPrivate

      public CP getRoomRateSemiPrivate()
      Returns IN1-40: "Room Rate - Semi-Private" - creates it if necessary

    • getIn140_RoomRateSemiPrivate

      public CP getIn140_RoomRateSemiPrivate()
      Returns IN1-40: "Room Rate - Semi-Private" - creates it if necessary

    • getRoomRatePrivate

      public CP getRoomRatePrivate()
      Returns IN1-41: "Room Rate - Private" - creates it if necessary

    • getIn141_RoomRatePrivate

      public CP getIn141_RoomRatePrivate()
      Returns IN1-41: "Room Rate - Private" - creates it if necessary

    • getInsuredSEmploymentStatus

      public CE getInsuredSEmploymentStatus()
      Returns IN1-42: "Insured's Employment Status" - creates it if necessary

    • getIn142_InsuredSEmploymentStatus

      public CE getIn142_InsuredSEmploymentStatus()
      Returns IN1-42: "Insured's Employment Status" - creates it if necessary

    • getInsuredSSex

      public IS getInsuredSSex()
      Returns IN1-43: "Insured's Sex" - creates it if necessary

    • getIn143_InsuredSSex

      public IS getIn143_InsuredSSex()
      Returns IN1-43: "Insured's Sex" - creates it if necessary

    • getInsuredSEmployerAddress

      public XAD getInsuredSEmployerAddress()
      Returns IN1-44: "Insured's Employer Address" - creates it if necessary

    • getIn144_InsuredSEmployerAddress

      public XAD getIn144_InsuredSEmployerAddress()
      Returns IN1-44: "Insured's Employer Address" - creates it if necessary

    • getVerificationStatus

      public ST getVerificationStatus()
      Returns IN1-45: "Verification Status" - creates it if necessary

    • getIn145_VerificationStatus

      public ST getIn145_VerificationStatus()
      Returns IN1-45: "Verification Status" - creates it if necessary

    • getPriorInsurancePlanID

      public IS getPriorInsurancePlanID()
      Returns IN1-46: "Prior Insurance Plan ID" - creates it if necessary

    • getIn146_PriorInsurancePlanID

      public IS getIn146_PriorInsurancePlanID()
      Returns IN1-46: "Prior Insurance Plan ID" - creates it if necessary

    • getCoverageType

      public IS getCoverageType()
      Returns IN1-47: "Coverage Type" - creates it if necessary

    • getIn147_CoverageType

      public IS getIn147_CoverageType()
      Returns IN1-47: "Coverage Type" - creates it if necessary

    • getHandicap

      public IS getHandicap()
      Returns IN1-48: "Handicap" - creates it if necessary

    • getIn148_Handicap

      public IS getIn148_Handicap()
      Returns IN1-48: "Handicap" - creates it if necessary

    • getInsuredSIDNumber

      public CX getInsuredSIDNumber()
      Returns IN1-49: "Insured's ID Number" - creates it if necessary

    • getIn149_InsuredSIDNumber

      public CX getIn149_InsuredSIDNumber()
      Returns IN1-49: "Insured's ID Number" - creates it if necessary

    • createNewTypeWithoutReflection

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