Class IN3

All Implemented Interfaces:
Segment, Structure, Visitable, Serializable

public class IN3 extends AbstractSegment

Represents an HL7 IN3 message segment (Insurance additional info - certification). This segment has the following fields:

  • IN3-1: Set ID - Insurance Certification (SI)
  • IN3-2: Certification Number (CX) optional
  • IN3-3: Certified By (XCN) optional repeating
  • IN3-4: Certification Required (ID) optional
  • IN3-5: Penalty (CM_PEN) optional
  • IN3-6: Certification Date/Time (TS) optional
  • IN3-7: Certification Modify Date/Time (TS) optional
  • IN3-8: Operator (XCN) optional repeating
  • IN3-9: Certification Begin Date (DT) optional
  • IN3-10: Certification End Date (DT) optional
  • IN3-11: Days (CM_DTN) optional
  • IN3-12: Non-Concur Code/Description (CE) optional
  • IN3-13: Non-Concur Effective Date/Time (TS) optional
  • IN3-14: Physician Reviewer (XCN) optional repeating
  • IN3-15: Certification Contact (ST) optional
  • IN3-16: Certification Contact Phone Number (XTN) optional repeating
  • IN3-17: Appeal Reason (CE) optional
  • IN3-18: Certification Agency (CE) optional
  • IN3-19: Certification Agency Phone Number (XTN) optional repeating
  • IN3-20: Pre-Certification required/Window (CM_PCF) optional repeating
  • IN3-21: Case Manager (ST) optional
  • IN3-22: Second Opinion Date (DT) optional
  • IN3-23: Second Opinion Status (IS) optional
  • IN3-24: Second Opinion Documentation Received (IS) optional repeating
  • IN3-25: Second Opinion Physician (XCN) optional repeating
See Also:
  • Constructor Details

  • Method Details

    • getSetIDInsuranceCertification

      Returns IN3-1: "Set ID - Insurance Certification" - creates it if necessary
    • getIn31_SetIDInsuranceCertification

      Returns IN3-1: "Set ID - Insurance Certification" - creates it if necessary
    • getCertificationNumber

      Returns IN3-2: "Certification Number" - creates it if necessary
    • getIn32_CertificationNumber

      Returns IN3-2: "Certification Number" - creates it if necessary
    • getCertifiedBy

      public XCN[] getCertifiedBy()
      Returns all repetitions of Certified By (IN3-3).
    • getIn33_CertifiedBy

      Returns all repetitions of Certified By (IN3-3).
    • getCertifiedByReps

      public int getCertifiedByReps()
      Returns a count of the current number of repetitions of Certified By (IN3-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getCertifiedBy

      public XCN getCertifiedBy(int rep)
      Returns a specific repetition of IN3-3: "Certified By" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn33_CertifiedBy

      public XCN getIn33_CertifiedBy(int rep)
      Returns a specific repetition of IN3-3: "Certified By" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn33_CertifiedByReps

      Returns a count of the current number of repetitions of Certified By (IN3-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertCertifiedBy

      public XCN insertCertifiedBy(int rep) throws HL7Exception
      Inserts a repetition of IN3-3: "Certified By" 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)
    • insertIn33_CertifiedBy

      public XCN insertIn33_CertifiedBy(int rep) throws HL7Exception
      Inserts a repetition of IN3-3: "Certified By" 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)
    • removeCertifiedBy

      public XCN removeCertifiedBy(int rep) throws HL7Exception
      Removes a repetition of IN3-3: "Certified By" 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)
    • removeIn33_CertifiedBy

      public XCN removeIn33_CertifiedBy(int rep) throws HL7Exception
      Removes a repetition of IN3-3: "Certified By" 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)
    • getCertificationRequired

      Returns IN3-4: "Certification Required" - creates it if necessary
    • getIn34_CertificationRequired

      Returns IN3-4: "Certification Required" - creates it if necessary
    • getPenalty

      public CM_PEN getPenalty()
      Returns IN3-5: "Penalty" - creates it if necessary
    • getIn35_Penalty

      Returns IN3-5: "Penalty" - creates it if necessary
    • getCertificationDateTime

      Returns IN3-6: "Certification Date/Time" - creates it if necessary
    • getIn36_CertificationDateTime

      Returns IN3-6: "Certification Date/Time" - creates it if necessary
    • getCertificationModifyDateTime

      Returns IN3-7: "Certification Modify Date/Time" - creates it if necessary
    • getIn37_CertificationModifyDateTime

      Returns IN3-7: "Certification Modify Date/Time" - creates it if necessary
    • getOperator

      public XCN[] getOperator()
      Returns all repetitions of Operator (IN3-8).
    • getIn38_Operator

      public XCN[] getIn38_Operator()
      Returns all repetitions of Operator (IN3-8).
    • getOperatorReps

      public int getOperatorReps()
      Returns a count of the current number of repetitions of Operator (IN3-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getOperator

      public XCN getOperator(int rep)
      Returns a specific repetition of IN3-8: "Operator" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn38_Operator

      public XCN getIn38_Operator(int rep)
      Returns a specific repetition of IN3-8: "Operator" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn38_OperatorReps

      public int getIn38_OperatorReps()
      Returns a count of the current number of repetitions of Operator (IN3-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertOperator

      public XCN insertOperator(int rep) throws HL7Exception
      Inserts a repetition of IN3-8: "Operator" 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)
    • insertIn38_Operator

      public XCN insertIn38_Operator(int rep) throws HL7Exception
      Inserts a repetition of IN3-8: "Operator" 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)
    • removeOperator

      public XCN removeOperator(int rep) throws HL7Exception
      Removes a repetition of IN3-8: "Operator" 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)
    • removeIn38_Operator

      public XCN removeIn38_Operator(int rep) throws HL7Exception
      Removes a repetition of IN3-8: "Operator" 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)
    • getCertificationBeginDate

      Returns IN3-9: "Certification Begin Date" - creates it if necessary
    • getIn39_CertificationBeginDate

      Returns IN3-9: "Certification Begin Date" - creates it if necessary
    • getCertificationEndDate

      Returns IN3-10: "Certification End Date" - creates it if necessary
    • getIn310_CertificationEndDate

      Returns IN3-10: "Certification End Date" - creates it if necessary
    • getDays

      public CM_DTN getDays()
      Returns IN3-11: "Days" - creates it if necessary
    • getIn311_Days

      Returns IN3-11: "Days" - creates it if necessary
    • getNonConcurCodeDescription

      Returns IN3-12: "Non-Concur Code/Description" - creates it if necessary
    • getIn312_NonConcurCodeDescription

      Returns IN3-12: "Non-Concur Code/Description" - creates it if necessary
    • getNonConcurEffectiveDateTime

      Returns IN3-13: "Non-Concur Effective Date/Time" - creates it if necessary
    • getIn313_NonConcurEffectiveDateTime

      Returns IN3-13: "Non-Concur Effective Date/Time" - creates it if necessary
    • getPhysicianReviewer

      Returns all repetitions of Physician Reviewer (IN3-14).
    • getIn314_PhysicianReviewer

      Returns all repetitions of Physician Reviewer (IN3-14).
    • getPhysicianReviewerReps

      Returns a count of the current number of repetitions of Physician Reviewer (IN3-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getPhysicianReviewer

      public XCN getPhysicianReviewer(int rep)
      Returns a specific repetition of IN3-14: "Physician Reviewer" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn314_PhysicianReviewer

      public XCN getIn314_PhysicianReviewer(int rep)
      Returns a specific repetition of IN3-14: "Physician Reviewer" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn314_PhysicianReviewerReps

      Returns a count of the current number of repetitions of Physician Reviewer (IN3-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertPhysicianReviewer

      public XCN insertPhysicianReviewer(int rep) throws HL7Exception
      Inserts a repetition of IN3-14: "Physician Reviewer" 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)
    • insertIn314_PhysicianReviewer

      Inserts a repetition of IN3-14: "Physician Reviewer" 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)
    • removePhysicianReviewer

      public XCN removePhysicianReviewer(int rep) throws HL7Exception
      Removes a repetition of IN3-14: "Physician Reviewer" 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)
    • removeIn314_PhysicianReviewer

      Removes a repetition of IN3-14: "Physician Reviewer" 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)
    • getCertificationContact

      Returns IN3-15: "Certification Contact" - creates it if necessary
    • getIn315_CertificationContact

      Returns IN3-15: "Certification Contact" - creates it if necessary
    • getCertificationContactPhoneNumber

      Returns all repetitions of Certification Contact Phone Number (IN3-16).
    • getIn316_CertificationContactPhoneNumber

      Returns all repetitions of Certification Contact Phone Number (IN3-16).
    • getCertificationContactPhoneNumberReps

      Returns a count of the current number of repetitions of Certification Contact Phone Number (IN3-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getCertificationContactPhoneNumber

      Returns a specific repetition of IN3-16: "Certification Contact Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn316_CertificationContactPhoneNumber

      Returns a specific repetition of IN3-16: "Certification Contact Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn316_CertificationContactPhoneNumberReps

      Returns a count of the current number of repetitions of Certification Contact Phone Number (IN3-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertCertificationContactPhoneNumber

      Inserts a repetition of IN3-16: "Certification Contact 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)
    • insertIn316_CertificationContactPhoneNumber

      Inserts a repetition of IN3-16: "Certification Contact 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)
    • removeCertificationContactPhoneNumber

      Removes a repetition of IN3-16: "Certification Contact 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)
    • removeIn316_CertificationContactPhoneNumber

      Removes a repetition of IN3-16: "Certification Contact 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)
    • getAppealReason

      public CE getAppealReason()
      Returns IN3-17: "Appeal Reason" - creates it if necessary
    • getIn317_AppealReason

      Returns IN3-17: "Appeal Reason" - creates it if necessary
    • getCertificationAgency

      Returns IN3-18: "Certification Agency" - creates it if necessary
    • getIn318_CertificationAgency

      Returns IN3-18: "Certification Agency" - creates it if necessary
    • getCertificationAgencyPhoneNumber

      Returns all repetitions of Certification Agency Phone Number (IN3-19).
    • getIn319_CertificationAgencyPhoneNumber

      Returns all repetitions of Certification Agency Phone Number (IN3-19).
    • getCertificationAgencyPhoneNumberReps

      Returns a count of the current number of repetitions of Certification Agency Phone Number (IN3-19). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getCertificationAgencyPhoneNumber

      Returns a specific repetition of IN3-19: "Certification Agency Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn319_CertificationAgencyPhoneNumber

      Returns a specific repetition of IN3-19: "Certification Agency Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn319_CertificationAgencyPhoneNumberReps

      Returns a count of the current number of repetitions of Certification Agency Phone Number (IN3-19). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertCertificationAgencyPhoneNumber

      Inserts a repetition of IN3-19: "Certification Agency 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)
    • insertIn319_CertificationAgencyPhoneNumber

      Inserts a repetition of IN3-19: "Certification Agency 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)
    • removeCertificationAgencyPhoneNumber

      Removes a repetition of IN3-19: "Certification Agency 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)
    • removeIn319_CertificationAgencyPhoneNumber

      Removes a repetition of IN3-19: "Certification Agency 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)
    • getPreCertificationRequiredWindow

      Returns all repetitions of Pre-Certification required/Window (IN3-20).
    • getIn320_PreCertificationRequiredWindow

      Returns all repetitions of Pre-Certification required/Window (IN3-20).
    • getPreCertificationRequiredWindowReps

      Returns a count of the current number of repetitions of Pre-Certification required/Window (IN3-20). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getPreCertificationRequiredWindow

      Returns a specific repetition of IN3-20: "Pre-Certification required/Window" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn320_PreCertificationRequiredWindow

      Returns a specific repetition of IN3-20: "Pre-Certification required/Window" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn320_PreCertificationRequiredWindowReps

      Returns a count of the current number of repetitions of Pre-Certification required/Window (IN3-20). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertPreCertificationRequiredWindow

      Inserts a repetition of IN3-20: "Pre-Certification required/Window" 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)
    • insertIn320_PreCertificationRequiredWindow

      Inserts a repetition of IN3-20: "Pre-Certification required/Window" 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)
    • removePreCertificationRequiredWindow

      Removes a repetition of IN3-20: "Pre-Certification required/Window" 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)
    • removeIn320_PreCertificationRequiredWindow

      Removes a repetition of IN3-20: "Pre-Certification required/Window" 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)
    • getCaseManager

      public ST getCaseManager()
      Returns IN3-21: "Case Manager" - creates it if necessary
    • getIn321_CaseManager

      Returns IN3-21: "Case Manager" - creates it if necessary
    • getSecondOpinionDate

      Returns IN3-22: "Second Opinion Date" - creates it if necessary
    • getIn322_SecondOpinionDate

      Returns IN3-22: "Second Opinion Date" - creates it if necessary
    • getSecondOpinionStatus

      Returns IN3-23: "Second Opinion Status" - creates it if necessary
    • getIn323_SecondOpinionStatus

      Returns IN3-23: "Second Opinion Status" - creates it if necessary
    • getSecondOpinionDocumentationReceived

      Returns all repetitions of Second Opinion Documentation Received (IN3-24).
    • getIn324_SecondOpinionDocumentationReceived

      Returns all repetitions of Second Opinion Documentation Received (IN3-24).
    • getSecondOpinionDocumentationReceivedReps

      Returns a count of the current number of repetitions of Second Opinion Documentation Received (IN3-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getSecondOpinionDocumentationReceived

      Returns a specific repetition of IN3-24: "Second Opinion Documentation Received" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn324_SecondOpinionDocumentationReceived

      Returns a specific repetition of IN3-24: "Second Opinion Documentation Received" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn324_SecondOpinionDocumentationReceivedReps

      Returns a count of the current number of repetitions of Second Opinion Documentation Received (IN3-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertSecondOpinionDocumentationReceived

      Inserts a repetition of IN3-24: "Second Opinion Documentation Received" 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)
    • insertIn324_SecondOpinionDocumentationReceived

      Inserts a repetition of IN3-24: "Second Opinion Documentation Received" 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)
    • removeSecondOpinionDocumentationReceived

      Removes a repetition of IN3-24: "Second Opinion Documentation Received" 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)
    • removeIn324_SecondOpinionDocumentationReceived

      Removes a repetition of IN3-24: "Second Opinion Documentation Received" 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)
    • getSecondOpinionPhysician

      Returns all repetitions of Second Opinion Physician (IN3-25).
    • getIn325_SecondOpinionPhysician

      Returns all repetitions of Second Opinion Physician (IN3-25).
    • getSecondOpinionPhysicianReps

      Returns a count of the current number of repetitions of Second Opinion Physician (IN3-25). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getSecondOpinionPhysician

      public XCN getSecondOpinionPhysician(int rep)
      Returns a specific repetition of IN3-25: "Second Opinion Physician" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn325_SecondOpinionPhysician

      Returns a specific repetition of IN3-25: "Second Opinion Physician" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getIn325_SecondOpinionPhysicianReps

      Returns a count of the current number of repetitions of Second Opinion Physician (IN3-25). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertSecondOpinionPhysician

      Inserts a repetition of IN3-25: "Second Opinion Physician" 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)
    • insertIn325_SecondOpinionPhysician

      Inserts a repetition of IN3-25: "Second Opinion Physician" 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)
    • removeSecondOpinionPhysician

      Removes a repetition of IN3-25: "Second Opinion Physician" 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)
    • removeIn325_SecondOpinionPhysician

      Removes a repetition of IN3-25: "Second Opinion Physician" 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