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

Class IN3

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v22.segment.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 (ST) optional
  • IN3-3: Certified by (CN) optional
  • 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 (CN) optional
  • 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 (CN) optional
  • IN3-15: Certification contact (ST) optional
  • IN3-16: Certification contact phone number (TN) optional repeating
  • IN3-17: Appeal reason (CE) optional
  • IN3-18: Certification agency (CE) optional
  • IN3-19: Certification agency phone number (TN) 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 (ID) optional
  • IN3-24: Second opinion documentation received (ID) optional
  • IN3-25: Second opinion practitioner (CN) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDInsuranceCertification

      public SI getSetIDInsuranceCertification()
      Returns IN3-1: "Set ID - insurance certification" - creates it if necessary

    • getIn31_SetIDInsuranceCertification

      public SI getIn31_SetIDInsuranceCertification()
      Returns IN3-1: "Set ID - insurance certification" - creates it if necessary

    • getCertificationNumber

      public ST getCertificationNumber()
      Returns IN3-2: "Certification number" - creates it if necessary

    • getIn32_CertificationNumber

      public ST getIn32_CertificationNumber()
      Returns IN3-2: "Certification number" - creates it if necessary

    • getCertifiedBy

      public CN getCertifiedBy()
      Returns IN3-3: "Certified by" - creates it if necessary

    • getIn33_CertifiedBy

      public CN getIn33_CertifiedBy()
      Returns IN3-3: "Certified by" - creates it if necessary

    • getCertificationRequired

      public ID getCertificationRequired()
      Returns IN3-4: "Certification required" - creates it if necessary

    • getIn34_CertificationRequired

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

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

    • getCertificationDateTime

      public TS getCertificationDateTime()
      Returns IN3-6: "Certification date / time" - creates it if necessary

    • getIn36_CertificationDateTime

      public TS getIn36_CertificationDateTime()
      Returns IN3-6: "Certification date / time" - creates it if necessary

    • getCertificationModifyDateTime

      public TS getCertificationModifyDateTime()
      Returns IN3-7: "Certification modify date / time" - creates it if necessary

    • getIn37_CertificationModifyDateTime

      public TS getIn37_CertificationModifyDateTime()
      Returns IN3-7: "Certification modify date / time" - creates it if necessary

    • getOperator

      public CN getOperator()
      Returns IN3-8: "Operator" - creates it if necessary

    • getIn38_Operator

      public CN getIn38_Operator()
      Returns IN3-8: "Operator" - creates it if necessary

    • getCertificationBeginDate

      public DT getCertificationBeginDate()
      Returns IN3-9: "Certification begin date" - creates it if necessary

    • getIn39_CertificationBeginDate

      public DT getIn39_CertificationBeginDate()
      Returns IN3-9: "Certification begin date" - creates it if necessary

    • getCertificationEndDate

      public DT getCertificationEndDate()
      Returns IN3-10: "Certification end date" - creates it if necessary

    • getIn310_CertificationEndDate

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

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

    • getNonConcurCodeDescription

      public CE getNonConcurCodeDescription()
      Returns IN3-12: "Non-concur code / description" - creates it if necessary

    • getIn312_NonConcurCodeDescription

      public CE getIn312_NonConcurCodeDescription()
      Returns IN3-12: "Non-concur code / description" - creates it if necessary

    • getNonConcurEffectiveDateTime

      public TS getNonConcurEffectiveDateTime()
      Returns IN3-13: "Non-concur effective date / time" - creates it if necessary

    • getIn313_NonConcurEffectiveDateTime

      public TS getIn313_NonConcurEffectiveDateTime()
      Returns IN3-13: "Non-concur effective date / time" - creates it if necessary

    • getPhysicianReviewer

      public CN getPhysicianReviewer()
      Returns IN3-14: "Physician reviewer" - creates it if necessary

    • getIn314_PhysicianReviewer

      public CN getIn314_PhysicianReviewer()
      Returns IN3-14: "Physician reviewer" - creates it if necessary

    • getCertificationContact

      public ST getCertificationContact()
      Returns IN3-15: "Certification contact" - creates it if necessary

    • getIn315_CertificationContact

      public ST getIn315_CertificationContact()
      Returns IN3-15: "Certification contact" - creates it if necessary

    • getCertificationContactPhoneNumber

      public TN[] getCertificationContactPhoneNumber()
      Returns all repetitions of Certification contact phone number (IN3-16).

    • getIn316_CertificationContactPhoneNumber

      public TN[] getIn316_CertificationContactPhoneNumber()
      Returns all repetitions of Certification contact phone number (IN3-16).

    • getCertificationContactPhoneNumberReps

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

      public TN getCertificationContactPhoneNumber(int rep)
      Returns a specific repetition of IN3-16: "Certification contact phone number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn316_CertificationContactPhoneNumber

      public TN getIn316_CertificationContactPhoneNumber(int rep)
      Returns a specific repetition of IN3-16: "Certification contact phone number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn316_CertificationContactPhoneNumberReps

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

      public TN insertCertificationContactPhoneNumber(int rep) throws HL7Exception
      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

      public TN insertIn316_CertificationContactPhoneNumber(int rep) throws HL7Exception
      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

      public TN removeCertificationContactPhoneNumber(int rep) throws HL7Exception
      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

      public TN removeIn316_CertificationContactPhoneNumber(int rep) throws HL7Exception
      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

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

    • getCertificationAgency

      public CE getCertificationAgency()
      Returns IN3-18: "Certification agency" - creates it if necessary

    • getIn318_CertificationAgency

      public CE getIn318_CertificationAgency()
      Returns IN3-18: "Certification agency" - creates it if necessary

    • getCertificationAgencyPhoneNumber

      public TN[] getCertificationAgencyPhoneNumber()
      Returns all repetitions of Certification agency phone number (IN3-19).

    • getIn319_CertificationAgencyPhoneNumber

      public TN[] getIn319_CertificationAgencyPhoneNumber()
      Returns all repetitions of Certification agency phone number (IN3-19).

    • getCertificationAgencyPhoneNumberReps

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

      public TN getCertificationAgencyPhoneNumber(int rep)
      Returns a specific repetition of IN3-19: "Certification agency phone number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn319_CertificationAgencyPhoneNumber

      public TN getIn319_CertificationAgencyPhoneNumber(int rep)
      Returns a specific repetition of IN3-19: "Certification agency phone number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn319_CertificationAgencyPhoneNumberReps

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

      public TN insertCertificationAgencyPhoneNumber(int rep) throws HL7Exception
      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

      public TN insertIn319_CertificationAgencyPhoneNumber(int rep) throws HL7Exception
      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

      public TN removeCertificationAgencyPhoneNumber(int rep) throws HL7Exception
      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

      public TN removeIn319_CertificationAgencyPhoneNumber(int rep) throws HL7Exception
      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

      public CM_PCF[] getPreCertificationRequiredWindow()
      Returns all repetitions of Pre-certification required / window (IN3-20).

    • getIn320_PreCertificationRequiredWindow

      public CM_PCF[] getIn320_PreCertificationRequiredWindow()
      Returns all repetitions of Pre-certification required / window (IN3-20).

    • getPreCertificationRequiredWindowReps

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

      public CM_PCF getPreCertificationRequiredWindow(int rep)
      Returns a specific repetition of IN3-20: "Pre-certification required / window" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn320_PreCertificationRequiredWindow

      public CM_PCF getIn320_PreCertificationRequiredWindow(int rep)
      Returns a specific repetition of IN3-20: "Pre-certification required / window" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIn320_PreCertificationRequiredWindowReps

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

      public CM_PCF insertPreCertificationRequiredWindow(int rep) throws HL7Exception
      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

      public CM_PCF insertIn320_PreCertificationRequiredWindow(int rep) throws HL7Exception
      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

      public CM_PCF removePreCertificationRequiredWindow(int rep) throws HL7Exception
      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

      public CM_PCF removeIn320_PreCertificationRequiredWindow(int rep) throws HL7Exception
      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

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

    • getSecondOpinionDate

      public DT getSecondOpinionDate()
      Returns IN3-22: "Second opinion date" - creates it if necessary

    • getIn322_SecondOpinionDate

      public DT getIn322_SecondOpinionDate()
      Returns IN3-22: "Second opinion date" - creates it if necessary

    • getSecondOpinionStatus

      public ID getSecondOpinionStatus()
      Returns IN3-23: "Second opinion status" - creates it if necessary

    • getIn323_SecondOpinionStatus

      public ID getIn323_SecondOpinionStatus()
      Returns IN3-23: "Second opinion status" - creates it if necessary

    • getSecondOpinionDocumentationReceived

      public ID getSecondOpinionDocumentationReceived()
      Returns IN3-24: "Second opinion documentation received" - creates it if necessary

    • getIn324_SecondOpinionDocumentationReceived

      public ID getIn324_SecondOpinionDocumentationReceived()
      Returns IN3-24: "Second opinion documentation received" - creates it if necessary

    • getSecondOpinionPractitioner

      public CN getSecondOpinionPractitioner()
      Returns IN3-25: "Second opinion practitioner" - creates it if necessary

    • getIn325_SecondOpinionPractitioner

      public CN getIn325_SecondOpinionPractitioner()
      Returns IN3-25: "Second opinion practitioner" - creates it if necessary

    • createNewTypeWithoutReflection

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