Package ca.uhn.hl7v2.model.v24.segment

Class PES

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

Represents an HL7 PES message segment (Product Experience Sender). This segment has the following fields:

  • PES-1: Sender Organization Name (XON) optional repeating
  • PES-2: Sender Individual Name (XCN) optional repeating
  • PES-3: Sender Address (XAD) optional repeating
  • PES-4: Sender Telephone (XTN) optional repeating
  • PES-5: Sender Event Identifier (EI) optional
  • PES-6: Sender Sequence Number (NM) optional
  • PES-7: Sender Event Description (FT) optional repeating
  • PES-8: Sender Comment (FT) optional
  • PES-9: Sender Aware Date/Time (TS) optional
  • PES-10: Event Report Date (TS)
  • PES-11: Event Report Timing/Type (ID) optional repeating
  • PES-12: Event Report Source (ID) optional
  • PES-13: Event Reported To (ID) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getSenderOrganizationName

      public XON[] getSenderOrganizationName()
      Returns all repetitions of Sender Organization Name (PES-1).

    • getPes1_SenderOrganizationName

      public XON[] getPes1_SenderOrganizationName()
      Returns all repetitions of Sender Organization Name (PES-1).

    • getSenderOrganizationNameReps

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

    • getSenderOrganizationName

      public XON getSenderOrganizationName(int rep)
      Returns a specific repetition of PES-1: "Sender Organization Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes1_SenderOrganizationName

      public XON getPes1_SenderOrganizationName(int rep)
      Returns a specific repetition of PES-1: "Sender Organization Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes1_SenderOrganizationNameReps

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

    • insertSenderOrganizationName

      public XON insertSenderOrganizationName(int rep) throws HL7Exception
      Inserts a repetition of PES-1: "Sender 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)

    • insertPes1_SenderOrganizationName

      public XON insertPes1_SenderOrganizationName(int rep) throws HL7Exception
      Inserts a repetition of PES-1: "Sender 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)

    • removeSenderOrganizationName

      public XON removeSenderOrganizationName(int rep) throws HL7Exception
      Removes a repetition of PES-1: "Sender 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)

    • removePes1_SenderOrganizationName

      public XON removePes1_SenderOrganizationName(int rep) throws HL7Exception
      Removes a repetition of PES-1: "Sender 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)

    • getSenderIndividualName

      public XCN[] getSenderIndividualName()
      Returns all repetitions of Sender Individual Name (PES-2).

    • getPes2_SenderIndividualName

      public XCN[] getPes2_SenderIndividualName()
      Returns all repetitions of Sender Individual Name (PES-2).

    • getSenderIndividualNameReps

      public int getSenderIndividualNameReps()
      Returns a count of the current number of repetitions of Sender Individual Name (PES-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSenderIndividualName

      public XCN getSenderIndividualName(int rep)
      Returns a specific repetition of PES-2: "Sender Individual Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes2_SenderIndividualName

      public XCN getPes2_SenderIndividualName(int rep)
      Returns a specific repetition of PES-2: "Sender Individual Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes2_SenderIndividualNameReps

      public int getPes2_SenderIndividualNameReps()
      Returns a count of the current number of repetitions of Sender Individual Name (PES-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSenderIndividualName

      public XCN insertSenderIndividualName(int rep) throws HL7Exception
      Inserts a repetition of PES-2: "Sender Individual 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)

    • insertPes2_SenderIndividualName

      public XCN insertPes2_SenderIndividualName(int rep) throws HL7Exception
      Inserts a repetition of PES-2: "Sender Individual 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)

    • removeSenderIndividualName

      public XCN removeSenderIndividualName(int rep) throws HL7Exception
      Removes a repetition of PES-2: "Sender Individual 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)

    • removePes2_SenderIndividualName

      public XCN removePes2_SenderIndividualName(int rep) throws HL7Exception
      Removes a repetition of PES-2: "Sender Individual 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)

    • getSenderAddress

      public XAD[] getSenderAddress()
      Returns all repetitions of Sender Address (PES-3).

    • getPes3_SenderAddress

      public XAD[] getPes3_SenderAddress()
      Returns all repetitions of Sender Address (PES-3).

    • getSenderAddressReps

      public int getSenderAddressReps()
      Returns a count of the current number of repetitions of Sender Address (PES-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSenderAddress

      public XAD getSenderAddress(int rep)
      Returns a specific repetition of PES-3: "Sender Address" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes3_SenderAddress

      public XAD getPes3_SenderAddress(int rep)
      Returns a specific repetition of PES-3: "Sender Address" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes3_SenderAddressReps

      public int getPes3_SenderAddressReps()
      Returns a count of the current number of repetitions of Sender Address (PES-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSenderAddress

      public XAD insertSenderAddress(int rep) throws HL7Exception
      Inserts a repetition of PES-3: "Sender Address" 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)

    • insertPes3_SenderAddress

      public XAD insertPes3_SenderAddress(int rep) throws HL7Exception
      Inserts a repetition of PES-3: "Sender Address" 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)

    • removeSenderAddress

      public XAD removeSenderAddress(int rep) throws HL7Exception
      Removes a repetition of PES-3: "Sender Address" 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)

    • removePes3_SenderAddress

      public XAD removePes3_SenderAddress(int rep) throws HL7Exception
      Removes a repetition of PES-3: "Sender Address" 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)

    • getSenderTelephone

      public XTN[] getSenderTelephone()
      Returns all repetitions of Sender Telephone (PES-4).

    • getPes4_SenderTelephone

      public XTN[] getPes4_SenderTelephone()
      Returns all repetitions of Sender Telephone (PES-4).

    • getSenderTelephoneReps

      public int getSenderTelephoneReps()
      Returns a count of the current number of repetitions of Sender Telephone (PES-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSenderTelephone

      public XTN getSenderTelephone(int rep)
      Returns a specific repetition of PES-4: "Sender Telephone" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes4_SenderTelephone

      public XTN getPes4_SenderTelephone(int rep)
      Returns a specific repetition of PES-4: "Sender Telephone" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes4_SenderTelephoneReps

      public int getPes4_SenderTelephoneReps()
      Returns a count of the current number of repetitions of Sender Telephone (PES-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSenderTelephone

      public XTN insertSenderTelephone(int rep) throws HL7Exception
      Inserts a repetition of PES-4: "Sender Telephone" 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)

    • insertPes4_SenderTelephone

      public XTN insertPes4_SenderTelephone(int rep) throws HL7Exception
      Inserts a repetition of PES-4: "Sender Telephone" 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)

    • removeSenderTelephone

      public XTN removeSenderTelephone(int rep) throws HL7Exception
      Removes a repetition of PES-4: "Sender Telephone" 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)

    • removePes4_SenderTelephone

      public XTN removePes4_SenderTelephone(int rep) throws HL7Exception
      Removes a repetition of PES-4: "Sender Telephone" 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)

    • getSenderEventIdentifier

      public EI getSenderEventIdentifier()
      Returns PES-5: "Sender Event Identifier" - creates it if necessary

    • getPes5_SenderEventIdentifier

      public EI getPes5_SenderEventIdentifier()
      Returns PES-5: "Sender Event Identifier" - creates it if necessary

    • getSenderSequenceNumber

      public NM getSenderSequenceNumber()
      Returns PES-6: "Sender Sequence Number" - creates it if necessary

    • getPes6_SenderSequenceNumber

      public NM getPes6_SenderSequenceNumber()
      Returns PES-6: "Sender Sequence Number" - creates it if necessary

    • getSenderEventDescription

      public FT[] getSenderEventDescription()
      Returns all repetitions of Sender Event Description (PES-7).

    • getPes7_SenderEventDescription

      public FT[] getPes7_SenderEventDescription()
      Returns all repetitions of Sender Event Description (PES-7).

    • getSenderEventDescriptionReps

      public int getSenderEventDescriptionReps()
      Returns a count of the current number of repetitions of Sender Event Description (PES-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSenderEventDescription

      public FT getSenderEventDescription(int rep)
      Returns a specific repetition of PES-7: "Sender Event Description" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes7_SenderEventDescription

      public FT getPes7_SenderEventDescription(int rep)
      Returns a specific repetition of PES-7: "Sender Event Description" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes7_SenderEventDescriptionReps

      public int getPes7_SenderEventDescriptionReps()
      Returns a count of the current number of repetitions of Sender Event Description (PES-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSenderEventDescription

      public FT insertSenderEventDescription(int rep) throws HL7Exception
      Inserts a repetition of PES-7: "Sender Event Description" 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)

    • insertPes7_SenderEventDescription

      public FT insertPes7_SenderEventDescription(int rep) throws HL7Exception
      Inserts a repetition of PES-7: "Sender Event Description" 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)

    • removeSenderEventDescription

      public FT removeSenderEventDescription(int rep) throws HL7Exception
      Removes a repetition of PES-7: "Sender Event Description" 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)

    • removePes7_SenderEventDescription

      public FT removePes7_SenderEventDescription(int rep) throws HL7Exception
      Removes a repetition of PES-7: "Sender Event Description" 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)

    • getSenderComment

      public FT getSenderComment()
      Returns PES-8: "Sender Comment" - creates it if necessary

    • getPes8_SenderComment

      public FT getPes8_SenderComment()
      Returns PES-8: "Sender Comment" - creates it if necessary

    • getSenderAwareDateTime

      public TS getSenderAwareDateTime()
      Returns PES-9: "Sender Aware Date/Time" - creates it if necessary

    • getPes9_SenderAwareDateTime

      public TS getPes9_SenderAwareDateTime()
      Returns PES-9: "Sender Aware Date/Time" - creates it if necessary

    • getEventReportDate

      public TS getEventReportDate()
      Returns PES-10: "Event Report Date" - creates it if necessary

    • getPes10_EventReportDate

      public TS getPes10_EventReportDate()
      Returns PES-10: "Event Report Date" - creates it if necessary

    • getEventReportTimingType

      public ID[] getEventReportTimingType()
      Returns all repetitions of Event Report Timing/Type (PES-11).

    • getPes11_EventReportTimingType

      public ID[] getPes11_EventReportTimingType()
      Returns all repetitions of Event Report Timing/Type (PES-11).

    • getEventReportTimingTypeReps

      public int getEventReportTimingTypeReps()
      Returns a count of the current number of repetitions of Event Report Timing/Type (PES-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getEventReportTimingType

      public ID getEventReportTimingType(int rep)
      Returns a specific repetition of PES-11: "Event Report Timing/Type" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes11_EventReportTimingType

      public ID getPes11_EventReportTimingType(int rep)
      Returns a specific repetition of PES-11: "Event Report Timing/Type" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes11_EventReportTimingTypeReps

      public int getPes11_EventReportTimingTypeReps()
      Returns a count of the current number of repetitions of Event Report Timing/Type (PES-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertEventReportTimingType

      public ID insertEventReportTimingType(int rep) throws HL7Exception
      Inserts a repetition of PES-11: "Event Report Timing/Type" 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)

    • insertPes11_EventReportTimingType

      public ID insertPes11_EventReportTimingType(int rep) throws HL7Exception
      Inserts a repetition of PES-11: "Event Report Timing/Type" 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)

    • removeEventReportTimingType

      public ID removeEventReportTimingType(int rep) throws HL7Exception
      Removes a repetition of PES-11: "Event Report Timing/Type" 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)

    • removePes11_EventReportTimingType

      public ID removePes11_EventReportTimingType(int rep) throws HL7Exception
      Removes a repetition of PES-11: "Event Report Timing/Type" 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)

    • getEventReportSource

      public ID getEventReportSource()
      Returns PES-12: "Event Report Source" - creates it if necessary

    • getPes12_EventReportSource

      public ID getPes12_EventReportSource()
      Returns PES-12: "Event Report Source" - creates it if necessary

    • getEventReportedTo

      public ID[] getEventReportedTo()
      Returns all repetitions of Event Reported To (PES-13).

    • getPes13_EventReportedTo

      public ID[] getPes13_EventReportedTo()
      Returns all repetitions of Event Reported To (PES-13).

    • getEventReportedToReps

      public int getEventReportedToReps()
      Returns a count of the current number of repetitions of Event Reported To (PES-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getEventReportedTo

      public ID getEventReportedTo(int rep)
      Returns a specific repetition of PES-13: "Event Reported To" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes13_EventReportedTo

      public ID getPes13_EventReportedTo(int rep)
      Returns a specific repetition of PES-13: "Event Reported To" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getPes13_EventReportedToReps

      public int getPes13_EventReportedToReps()
      Returns a count of the current number of repetitions of Event Reported To (PES-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertEventReportedTo

      public ID insertEventReportedTo(int rep) throws HL7Exception
      Inserts a repetition of PES-13: "Event Reported To" 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)

    • insertPes13_EventReportedTo

      public ID insertPes13_EventReportedTo(int rep) throws HL7Exception
      Inserts a repetition of PES-13: "Event Reported To" 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)

    • removeEventReportedTo

      public ID removeEventReportedTo(int rep) throws HL7Exception
      Removes a repetition of PES-13: "Event Reported To" 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)

    • removePes13_EventReportedTo

      public ID removePes13_EventReportedTo(int rep) throws HL7Exception
      Removes a repetition of PES-13: "Event Reported To" 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