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

Class PV2

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

Represents an HL7 PV2 message segment (Patient visit - additional information). This segment has the following fields:

  • PV2-1: Prior Pending Location (PL) optional
  • PV2-2: Accommodation Code (CE) optional
  • PV2-3: Admit Reason (CE) optional
  • PV2-4: Transfer Reason (CE) optional
  • PV2-5: Patient Valuables (ST) optional repeating
  • PV2-6: Patient Valuables Location (ST) optional
  • PV2-7: Visit User Code (IS) optional
  • PV2-8: Expected Admit Date (TS) optional
  • PV2-9: Expected Discharge Date (TS) optional
  • PV2-10: Estimated Length of Inpatient Stay (NM) optional
  • PV2-11: Actual Length of Inpatient Stay (NM) optional
  • PV2-12: Visit Description (ST) optional
  • PV2-13: Referral Source Code (XCN) optional
  • PV2-14: Previous Service Date (DT) optional
  • PV2-15: Employment Illness Related Indicator (ID) optional
  • PV2-16: Purge Status Code (IS) optional
  • PV2-17: Purge Status Date (DT) optional
  • PV2-18: Special Program Code (IS) optional
  • PV2-19: Retention Indicator (ID) optional
  • PV2-20: Expected Number of Insurance Plans (NM) optional
  • PV2-21: Visit Publicity Code (IS) optional
  • PV2-22: Visit Protection Indicator (ID) optional
  • PV2-23: Clinic Organization Name (XON) optional repeating
  • PV2-24: Patient Status Code (IS) optional
  • PV2-25: Visit Priority Code (IS) optional
  • PV2-26: Previous Treatment Date (DT) optional
  • PV2-27: Expected Discharge Disposition (IS) optional
  • PV2-28: Signature on File Date (DT) optional
  • PV2-29: First Similar Illness Date (DT) optional
  • PV2-30: Patient Charge Adjustment Code (IS) optional
  • PV2-31: Recurring Service Code (IS) optional
  • PV2-32: Billing Media Code (ID) optional
  • PV2-33: Expected Surgery Date & Time (TS) optional
  • PV2-34: Military Partnership Code (ID) optional
  • PV2-35: Military Non-Availabiltiy Code (ID) optional
  • PV2-36: Newborn Baby Indicator (ID) optional
  • PV2-37: Baby Detained Indicator (ID) optional
See Also:

  • Constructor Details

  • Method Details

    • getPriorPendingLocation

      public PL getPriorPendingLocation()
      Returns PV2-1: "Prior Pending Location" - creates it if necessary

    • getPv21_PriorPendingLocation

      public PL getPv21_PriorPendingLocation()
      Returns PV2-1: "Prior Pending Location" - creates it if necessary

    • getAccommodationCode

      public CE getAccommodationCode()
      Returns PV2-2: "Accommodation Code" - creates it if necessary

    • getPv22_AccommodationCode

      public CE getPv22_AccommodationCode()
      Returns PV2-2: "Accommodation Code" - creates it if necessary

    • getAdmitReason

      public CE getAdmitReason()
      Returns PV2-3: "Admit Reason" - creates it if necessary

    • getPv23_AdmitReason

      public CE getPv23_AdmitReason()
      Returns PV2-3: "Admit Reason" - creates it if necessary

    • getTransferReason

      public CE getTransferReason()
      Returns PV2-4: "Transfer Reason" - creates it if necessary

    • getPv24_TransferReason

      public CE getPv24_TransferReason()
      Returns PV2-4: "Transfer Reason" - creates it if necessary

    • getPatientValuables

      public ST[] getPatientValuables()
      Returns all repetitions of Patient Valuables (PV2-5).

    • getPv25_PatientValuables

      public ST[] getPv25_PatientValuables()
      Returns all repetitions of Patient Valuables (PV2-5).

    • getPatientValuablesReps

      public int getPatientValuablesReps()
      Returns a count of the current number of repetitions of Patient Valuables (PV2-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getPatientValuables

      public ST getPatientValuables(int rep)
      Returns a specific repetition of PV2-5: "Patient Valuables" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPv25_PatientValuables

      public ST getPv25_PatientValuables(int rep)
      Returns a specific repetition of PV2-5: "Patient Valuables" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPv25_PatientValuablesReps

      public int getPv25_PatientValuablesReps()
      Returns a count of the current number of repetitions of Patient Valuables (PV2-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertPatientValuables

      public ST insertPatientValuables(int rep) throws HL7Exception
      Inserts a repetition of PV2-5: "Patient Valuables" 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)

    • insertPv25_PatientValuables

      public ST insertPv25_PatientValuables(int rep) throws HL7Exception
      Inserts a repetition of PV2-5: "Patient Valuables" 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)

    • removePatientValuables

      public ST removePatientValuables(int rep) throws HL7Exception
      Removes a repetition of PV2-5: "Patient Valuables" 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)

    • removePv25_PatientValuables

      public ST removePv25_PatientValuables(int rep) throws HL7Exception
      Removes a repetition of PV2-5: "Patient Valuables" 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)

    • getPatientValuablesLocation

      public ST getPatientValuablesLocation()
      Returns PV2-6: "Patient Valuables Location" - creates it if necessary

    • getPv26_PatientValuablesLocation

      public ST getPv26_PatientValuablesLocation()
      Returns PV2-6: "Patient Valuables Location" - creates it if necessary

    • getVisitUserCode

      public IS getVisitUserCode()
      Returns PV2-7: "Visit User Code" - creates it if necessary

    • getPv27_VisitUserCode

      public IS getPv27_VisitUserCode()
      Returns PV2-7: "Visit User Code" - creates it if necessary

    • getExpectedAdmitDate

      public TS getExpectedAdmitDate()
      Returns PV2-8: "Expected Admit Date" - creates it if necessary

    • getPv28_ExpectedAdmitDate

      public TS getPv28_ExpectedAdmitDate()
      Returns PV2-8: "Expected Admit Date" - creates it if necessary

    • getExpectedDischargeDate

      public TS getExpectedDischargeDate()
      Returns PV2-9: "Expected Discharge Date" - creates it if necessary

    • getPv29_ExpectedDischargeDate

      public TS getPv29_ExpectedDischargeDate()
      Returns PV2-9: "Expected Discharge Date" - creates it if necessary

    • getEstimatedLengthOfInpatientStay

      public NM getEstimatedLengthOfInpatientStay()
      Returns PV2-10: "Estimated Length of Inpatient Stay" - creates it if necessary

    • getPv210_EstimatedLengthOfInpatientStay

      public NM getPv210_EstimatedLengthOfInpatientStay()
      Returns PV2-10: "Estimated Length of Inpatient Stay" - creates it if necessary

    • getActualLengthOfInpatientStay

      public NM getActualLengthOfInpatientStay()
      Returns PV2-11: "Actual Length of Inpatient Stay" - creates it if necessary

    • getPv211_ActualLengthOfInpatientStay

      public NM getPv211_ActualLengthOfInpatientStay()
      Returns PV2-11: "Actual Length of Inpatient Stay" - creates it if necessary

    • getVisitDescription

      public ST getVisitDescription()
      Returns PV2-12: "Visit Description" - creates it if necessary

    • getPv212_VisitDescription

      public ST getPv212_VisitDescription()
      Returns PV2-12: "Visit Description" - creates it if necessary

    • getReferralSourceCode

      public XCN getReferralSourceCode()
      Returns PV2-13: "Referral Source Code" - creates it if necessary

    • getPv213_ReferralSourceCode

      public XCN getPv213_ReferralSourceCode()
      Returns PV2-13: "Referral Source Code" - creates it if necessary

    • getPreviousServiceDate

      public DT getPreviousServiceDate()
      Returns PV2-14: "Previous Service Date" - creates it if necessary

    • getPv214_PreviousServiceDate

      public DT getPv214_PreviousServiceDate()
      Returns PV2-14: "Previous Service Date" - creates it if necessary

    • getEmploymentIllnessRelatedIndicator

      public ID getEmploymentIllnessRelatedIndicator()
      Returns PV2-15: "Employment Illness Related Indicator" - creates it if necessary

    • getPv215_EmploymentIllnessRelatedIndicator

      public ID getPv215_EmploymentIllnessRelatedIndicator()
      Returns PV2-15: "Employment Illness Related Indicator" - creates it if necessary

    • getPurgeStatusCode

      public IS getPurgeStatusCode()
      Returns PV2-16: "Purge Status Code" - creates it if necessary

    • getPv216_PurgeStatusCode

      public IS getPv216_PurgeStatusCode()
      Returns PV2-16: "Purge Status Code" - creates it if necessary

    • getPurgeStatusDate

      public DT getPurgeStatusDate()
      Returns PV2-17: "Purge Status Date" - creates it if necessary

    • getPv217_PurgeStatusDate

      public DT getPv217_PurgeStatusDate()
      Returns PV2-17: "Purge Status Date" - creates it if necessary

    • getSpecialProgramCode

      public IS getSpecialProgramCode()
      Returns PV2-18: "Special Program Code" - creates it if necessary

    • getPv218_SpecialProgramCode

      public IS getPv218_SpecialProgramCode()
      Returns PV2-18: "Special Program Code" - creates it if necessary

    • getRetentionIndicator

      public ID getRetentionIndicator()
      Returns PV2-19: "Retention Indicator" - creates it if necessary

    • getPv219_RetentionIndicator

      public ID getPv219_RetentionIndicator()
      Returns PV2-19: "Retention Indicator" - creates it if necessary

    • getExpectedNumberOfInsurancePlans

      public NM getExpectedNumberOfInsurancePlans()
      Returns PV2-20: "Expected Number of Insurance Plans" - creates it if necessary

    • getPv220_ExpectedNumberOfInsurancePlans

      public NM getPv220_ExpectedNumberOfInsurancePlans()
      Returns PV2-20: "Expected Number of Insurance Plans" - creates it if necessary

    • getVisitPublicityCode

      public IS getVisitPublicityCode()
      Returns PV2-21: "Visit Publicity Code" - creates it if necessary

    • getPv221_VisitPublicityCode

      public IS getPv221_VisitPublicityCode()
      Returns PV2-21: "Visit Publicity Code" - creates it if necessary

    • getVisitProtectionIndicator

      public ID getVisitProtectionIndicator()
      Returns PV2-22: "Visit Protection Indicator" - creates it if necessary

    • getPv222_VisitProtectionIndicator

      public ID getPv222_VisitProtectionIndicator()
      Returns PV2-22: "Visit Protection Indicator" - creates it if necessary

    • getClinicOrganizationName

      public XON[] getClinicOrganizationName()
      Returns all repetitions of Clinic Organization Name (PV2-23).

    • getPv223_ClinicOrganizationName

      public XON[] getPv223_ClinicOrganizationName()
      Returns all repetitions of Clinic Organization Name (PV2-23).

    • getClinicOrganizationNameReps

      public int getClinicOrganizationNameReps()
      Returns a count of the current number of repetitions of Clinic Organization Name (PV2-23). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getClinicOrganizationName

      public XON getClinicOrganizationName(int rep)
      Returns a specific repetition of PV2-23: "Clinic Organization Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPv223_ClinicOrganizationName

      public XON getPv223_ClinicOrganizationName(int rep)
      Returns a specific repetition of PV2-23: "Clinic Organization Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPv223_ClinicOrganizationNameReps

      public int getPv223_ClinicOrganizationNameReps()
      Returns a count of the current number of repetitions of Clinic Organization Name (PV2-23). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertClinicOrganizationName

      public XON insertClinicOrganizationName(int rep) throws HL7Exception
      Inserts a repetition of PV2-23: "Clinic Organization Name" 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)

    • insertPv223_ClinicOrganizationName

      public XON insertPv223_ClinicOrganizationName(int rep) throws HL7Exception
      Inserts a repetition of PV2-23: "Clinic Organization Name" 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)

    • removeClinicOrganizationName

      public XON removeClinicOrganizationName(int rep) throws HL7Exception
      Removes a repetition of PV2-23: "Clinic Organization Name" 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)

    • removePv223_ClinicOrganizationName

      public XON removePv223_ClinicOrganizationName(int rep) throws HL7Exception
      Removes a repetition of PV2-23: "Clinic Organization Name" 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)

    • getPatientStatusCode

      public IS getPatientStatusCode()
      Returns PV2-24: "Patient Status Code" - creates it if necessary

    • getPv224_PatientStatusCode

      public IS getPv224_PatientStatusCode()
      Returns PV2-24: "Patient Status Code" - creates it if necessary

    • getVisitPriorityCode

      public IS getVisitPriorityCode()
      Returns PV2-25: "Visit Priority Code" - creates it if necessary

    • getPv225_VisitPriorityCode

      public IS getPv225_VisitPriorityCode()
      Returns PV2-25: "Visit Priority Code" - creates it if necessary

    • getPreviousTreatmentDate

      public DT getPreviousTreatmentDate()
      Returns PV2-26: "Previous Treatment Date" - creates it if necessary

    • getPv226_PreviousTreatmentDate

      public DT getPv226_PreviousTreatmentDate()
      Returns PV2-26: "Previous Treatment Date" - creates it if necessary

    • getExpectedDischargeDisposition

      public IS getExpectedDischargeDisposition()
      Returns PV2-27: "Expected Discharge Disposition" - creates it if necessary

    • getPv227_ExpectedDischargeDisposition

      public IS getPv227_ExpectedDischargeDisposition()
      Returns PV2-27: "Expected Discharge Disposition" - creates it if necessary

    • getSignatureOnFileDate

      public DT getSignatureOnFileDate()
      Returns PV2-28: "Signature on File Date" - creates it if necessary

    • getPv228_SignatureOnFileDate

      public DT getPv228_SignatureOnFileDate()
      Returns PV2-28: "Signature on File Date" - creates it if necessary

    • getFirstSimilarIllnessDate

      public DT getFirstSimilarIllnessDate()
      Returns PV2-29: "First Similar Illness Date" - creates it if necessary

    • getPv229_FirstSimilarIllnessDate

      public DT getPv229_FirstSimilarIllnessDate()
      Returns PV2-29: "First Similar Illness Date" - creates it if necessary

    • getPatientChargeAdjustmentCode

      public IS getPatientChargeAdjustmentCode()
      Returns PV2-30: "Patient Charge Adjustment Code" - creates it if necessary

    • getPv230_PatientChargeAdjustmentCode

      public IS getPv230_PatientChargeAdjustmentCode()
      Returns PV2-30: "Patient Charge Adjustment Code" - creates it if necessary

    • getRecurringServiceCode

      public IS getRecurringServiceCode()
      Returns PV2-31: "Recurring Service Code" - creates it if necessary

    • getPv231_RecurringServiceCode

      public IS getPv231_RecurringServiceCode()
      Returns PV2-31: "Recurring Service Code" - creates it if necessary

    • getBillingMediaCode

      public ID getBillingMediaCode()
      Returns PV2-32: "Billing Media Code" - creates it if necessary

    • getPv232_BillingMediaCode

      public ID getPv232_BillingMediaCode()
      Returns PV2-32: "Billing Media Code" - creates it if necessary

    • getExpectedSurgeryDateTime

      public TS getExpectedSurgeryDateTime()
      Returns PV2-33: "Expected Surgery Date & Time" - creates it if necessary

    • getPv233_ExpectedSurgeryDateTime

      public TS getPv233_ExpectedSurgeryDateTime()
      Returns PV2-33: "Expected Surgery Date & Time" - creates it if necessary

    • getMilitaryPartnershipCode

      public ID getMilitaryPartnershipCode()
      Returns PV2-34: "Military Partnership Code" - creates it if necessary

    • getPv234_MilitaryPartnershipCode

      public ID getPv234_MilitaryPartnershipCode()
      Returns PV2-34: "Military Partnership Code" - creates it if necessary

    • getMilitaryNonAvailabiltiyCode

      public ID getMilitaryNonAvailabiltiyCode()
      Returns PV2-35: "Military Non-Availabiltiy Code" - creates it if necessary

    • getPv235_MilitaryNonAvailabiltiyCode

      public ID getPv235_MilitaryNonAvailabiltiyCode()
      Returns PV2-35: "Military Non-Availabiltiy Code" - creates it if necessary

    • getNewbornBabyIndicator

      public ID getNewbornBabyIndicator()
      Returns PV2-36: "Newborn Baby Indicator" - creates it if necessary

    • getPv236_NewbornBabyIndicator

      public ID getPv236_NewbornBabyIndicator()
      Returns PV2-36: "Newborn Baby Indicator" - creates it if necessary

    • getBabyDetainedIndicator

      public ID getBabyDetainedIndicator()
      Returns PV2-37: "Baby Detained Indicator" - creates it if necessary

    • getPv237_BabyDetainedIndicator

      public ID getPv237_BabyDetainedIndicator()
      Returns PV2-37: "Baby Detained Indicator" - creates it if necessary

    • createNewTypeWithoutReflection

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