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

Class IN1

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v22.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 (ID)
  • IN1-3: Insurance company ID (ST)
  • IN1-4: Insurance company name (ST) optional
  • IN1-5: Insurance company address (AD) optional
  • IN1-6: Insurance company contact pers (PN) optional
  • IN1-7: Insurance company phone number (TN) optional repeating
  • IN1-8: Group number (ST) optional
  • IN1-9: Group name (ST) optional
  • IN1-10: Insured's group employer ID (ST) optional
  • IN1-11: Insured's group employer name (ST) 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 (ID) optional
  • IN1-16: Name of insured (PN) optional
  • IN1-17: Insured's relationship to patient (ID) optional
  • IN1-18: Insured's date of birth (DT) optional
  • IN1-19: Insured's address (AD) optional
  • IN1-20: Assignment of benefits (ID) optional
  • IN1-21: Coordination of benefits (ID) optional
  • IN1-22: Coordination of benefits - priority (ST) optional
  • IN1-23: Notice of admission code (ID) optional
  • IN1-24: Notice of admission date (DT) optional
  • IN1-25: Report of eligibility code (ID) optional
  • IN1-26: Report of eligibility date (DT) optional
  • IN1-27: Release information code (ID) optional
  • IN1-28: Pre-admit certification (PAC) (ST) optional
  • IN1-29: Verification date / time (TS) optional
  • IN1-30: Verification by (CN) optional
  • IN1-31: Type of agreement code (ID) optional
  • IN1-32: Billing status (ID) optional
  • IN1-33: Lifetime reserve days (NM) optional
  • IN1-34: Delay before lifetime reserve days (NM) optional
  • IN1-35: Company plan code (ID) optional
  • IN1-36: Policy number (ST) optional
  • IN1-37: Policy deductible (NM) optional
  • IN1-38: Policy limit - amount (NM) optional
  • IN1-39: Policy limit - days (NM) optional
  • IN1-40: Room rate - semi-private (NM) optional
  • IN1-41: Room rate - private (NM) optional
  • IN1-42: Insured's employment status (CE) optional
  • IN1-43: Insured's sex (ID) optional
  • IN1-44: Insured's employer address (AD) optional
  • IN1-45: Verification status (ST) optional
  • IN1-46: Prior insurance plan ID (ID) 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 ID getInsurancePlanID()
      Returns IN1-2: "Insurance plan ID" - creates it if necessary

    • getIn12_InsurancePlanID

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

    • getInsuranceCompanyID

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

    • getIn13_InsuranceCompanyID

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

    • getInsuranceCompanyName

      public ST getInsuranceCompanyName()
      Returns IN1-4: "Insurance company name" - creates it if necessary

    • getIn14_InsuranceCompanyName

      public ST getIn14_InsuranceCompanyName()
      Returns IN1-4: "Insurance company name" - creates it if necessary

    • getInsuranceCompanyAddress

      public AD getInsuranceCompanyAddress()
      Returns IN1-5: "Insurance company address" - creates it if necessary

    • getIn15_InsuranceCompanyAddress

      public AD getIn15_InsuranceCompanyAddress()
      Returns IN1-5: "Insurance company address" - creates it if necessary

    • getInsuranceCompanyContactPers

      public PN getInsuranceCompanyContactPers()
      Returns IN1-6: "Insurance company contact pers" - creates it if necessary

    • getIn16_InsuranceCompanyContactPers

      public PN getIn16_InsuranceCompanyContactPers()
      Returns IN1-6: "Insurance company contact pers" - creates it if necessary

    • getInsuranceCompanyPhoneNumber

      public TN[] getInsuranceCompanyPhoneNumber()
      Returns all repetitions of Insurance company phone number (IN1-7).

    • getIn17_InsuranceCompanyPhoneNumber

      public TN[] getIn17_InsuranceCompanyPhoneNumber()
      Returns all repetitions of Insurance company phone number (IN1-7).

    • getInsuranceCompanyPhoneNumberReps

      public int getInsuranceCompanyPhoneNumberReps()
      Returns a count of the current number of repetitions of Insurance company 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.

    • getInsuranceCompanyPhoneNumber

      public TN getInsuranceCompanyPhoneNumber(int rep)
      Returns a specific repetition of IN1-7: "Insurance company phone number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn17_InsuranceCompanyPhoneNumber

      public TN getIn17_InsuranceCompanyPhoneNumber(int rep)
      Returns a specific repetition of IN1-7: "Insurance company phone number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn17_InsuranceCompanyPhoneNumberReps

      public int getIn17_InsuranceCompanyPhoneNumberReps()
      Returns a count of the current number of repetitions of Insurance company 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.

    • insertInsuranceCompanyPhoneNumber

      public TN insertInsuranceCompanyPhoneNumber(int rep) throws HL7Exception
      Inserts a repetition of IN1-7: "Insurance company 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_InsuranceCompanyPhoneNumber

      public TN insertIn17_InsuranceCompanyPhoneNumber(int rep) throws HL7Exception
      Inserts a repetition of IN1-7: "Insurance company 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)

    • removeInsuranceCompanyPhoneNumber

      public TN removeInsuranceCompanyPhoneNumber(int rep) throws HL7Exception
      Removes a repetition of IN1-7: "Insurance company 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_InsuranceCompanyPhoneNumber

      public TN removeIn17_InsuranceCompanyPhoneNumber(int rep) throws HL7Exception
      Removes a repetition of IN1-7: "Insurance company 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 ST getGroupName()
      Returns IN1-9: "Group name" - creates it if necessary

    • getIn19_GroupName

      public ST getIn19_GroupName()
      Returns IN1-9: "Group name" - creates it if necessary

    • getInsuredSGroupEmployerID

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

    • getIn110_InsuredSGroupEmployerID

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

    • getInsuredSGroupEmployerName

      public ST getInsuredSGroupEmployerName()
      Returns IN1-11: "Insured's group employer name" - creates it if necessary

    • getIn111_InsuredSGroupEmployerName

      public ST getIn111_InsuredSGroupEmployerName()
      Returns IN1-11: "Insured's group employer 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 ID getPlanType()
      Returns IN1-15: "Plan type" - creates it if necessary

    • getIn115_PlanType

      public ID getIn115_PlanType()
      Returns IN1-15: "Plan type" - creates it if necessary

    • getNameOfInsured

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

    • getIn116_NameOfInsured

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

    • getInsuredSRelationshipToPatient

      public ID getInsuredSRelationshipToPatient()
      Returns IN1-17: "Insured's relationship to patient" - creates it if necessary

    • getIn117_InsuredSRelationshipToPatient

      public ID getIn117_InsuredSRelationshipToPatient()
      Returns IN1-17: "Insured's relationship to patient" - creates it if necessary

    • getInsuredSDateOfBirth

      public DT getInsuredSDateOfBirth()
      Returns IN1-18: "Insured's date of birth" - creates it if necessary

    • getIn118_InsuredSDateOfBirth

      public DT getIn118_InsuredSDateOfBirth()
      Returns IN1-18: "Insured's date of birth" - creates it if necessary

    • getInsuredSAddress

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

    • getIn119_InsuredSAddress

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

    • getAssignmentOfBenefits

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

    • getIn120_AssignmentOfBenefits

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

    • getCoordinationOfBenefits

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

    • getIn121_CoordinationOfBenefits

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

    • getCoordinationOfBenefitsPriority

      public ST getCoordinationOfBenefitsPriority()
      Returns IN1-22: "Coordination of benefits - priority" - creates it if necessary

    • getIn122_CoordinationOfBenefitsPriority

      public ST getIn122_CoordinationOfBenefitsPriority()
      Returns IN1-22: "Coordination of benefits - 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

    • getReportOfEligibilityCode

      public ID getReportOfEligibilityCode()
      Returns IN1-25: "Report of eligibility code" - creates it if necessary

    • getIn125_ReportOfEligibilityCode

      public ID getIn125_ReportOfEligibilityCode()
      Returns IN1-25: "Report of eligibility code" - creates it if necessary

    • getReportOfEligibilityDate

      public DT getReportOfEligibilityDate()
      Returns IN1-26: "Report of eligibility date" - creates it if necessary

    • getIn126_ReportOfEligibilityDate

      public DT getIn126_ReportOfEligibilityDate()
      Returns IN1-26: "Report of eligibility date" - creates it if necessary

    • getReleaseInformationCode

      public ID getReleaseInformationCode()
      Returns IN1-27: "Release information code" - creates it if necessary

    • getIn127_ReleaseInformationCode

      public ID getIn127_ReleaseInformationCode()
      Returns IN1-27: "Release information code" - creates it if necessary

    • getPreAdmitCertification

      public ST getPreAdmitCertification()
      Returns IN1-28: "Pre-admit certification (PAC)" - creates it if necessary

    • getIn128_PreAdmitCertification

      public ST getIn128_PreAdmitCertification()
      Returns IN1-28: "Pre-admit certification (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 CN getVerificationBy()
      Returns IN1-30: "Verification by" - creates it if necessary

    • getIn130_VerificationBy

      public CN getIn130_VerificationBy()
      Returns IN1-30: "Verification by" - creates it if necessary

    • getTypeOfAgreementCode

      public ID getTypeOfAgreementCode()
      Returns IN1-31: "Type of agreement code" - creates it if necessary

    • getIn131_TypeOfAgreementCode

      public ID getIn131_TypeOfAgreementCode()
      Returns IN1-31: "Type of agreement code" - creates it if necessary

    • getBillingStatus

      public ID getBillingStatus()
      Returns IN1-32: "Billing status" - creates it if necessary

    • getIn132_BillingStatus

      public ID 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 ID getCompanyPlanCode()
      Returns IN1-35: "Company plan code" - creates it if necessary

    • getIn135_CompanyPlanCode

      public ID 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 NM getPolicyDeductible()
      Returns IN1-37: "Policy deductible" - creates it if necessary

    • getIn137_PolicyDeductible

      public NM getIn137_PolicyDeductible()
      Returns IN1-37: "Policy deductible" - creates it if necessary

    • getPolicyLimitAmount

      public NM getPolicyLimitAmount()
      Returns IN1-38: "Policy limit - amount" - creates it if necessary

    • getIn138_PolicyLimitAmount

      public NM 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 NM getRoomRateSemiPrivate()
      Returns IN1-40: "Room rate - semi-private" - creates it if necessary

    • getIn140_RoomRateSemiPrivate

      public NM getIn140_RoomRateSemiPrivate()
      Returns IN1-40: "Room rate - semi-private" - creates it if necessary

    • getRoomRatePrivate

      public NM getRoomRatePrivate()
      Returns IN1-41: "Room rate - private" - creates it if necessary

    • getIn141_RoomRatePrivate

      public NM 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 ID getInsuredSSex()
      Returns IN1-43: "Insured's sex" - creates it if necessary

    • getIn143_InsuredSSex

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

    • getInsuredSEmployerAddress

      public AD getInsuredSEmployerAddress()
      Returns IN1-44: "Insured's employer address" - creates it if necessary

    • getIn144_InsuredSEmployerAddress

      public AD 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 ID getPriorInsurancePlanID()
      Returns IN1-46: "Prior insurance plan ID" - creates it if necessary

    • getIn146_PriorInsurancePlanID

      public ID getIn146_PriorInsurancePlanID()
      Returns IN1-46: "Prior insurance plan ID" - creates it if necessary

    • createNewTypeWithoutReflection

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