Class TXA

All Implemented Interfaces:
Segment, Structure, Visitable, Serializable

public class TXA extends AbstractSegment

Represents an HL7 TXA message segment (Transcription Document Header). This segment has the following fields:

  • TXA-1: Set ID- TXA (SI)
  • TXA-2: Document Type (IS)
  • TXA-3: Document Content Presentation (ID) optional
  • TXA-4: Activity Date/Time (TS) optional
  • TXA-5: Primary Activity Provider Code/Name (XCN) optional repeating
  • TXA-6: Origination Date/Time (TS) optional
  • TXA-7: Transcription Date/Time (TS) optional
  • TXA-8: Edit Date/Time (TS) optional repeating
  • TXA-9: Originator Code/Name (XCN) optional repeating
  • TXA-10: Assigned Document Authenticator (XCN) optional repeating
  • TXA-11: Transcriptionist Code/Name (XCN) optional repeating
  • TXA-12: Unique Document Number (EI)
  • TXA-13: Parent Document Number (EI) optional
  • TXA-14: Placer Order Number (EI) optional repeating
  • TXA-15: Filler Order Number (EI) optional
  • TXA-16: Unique Document File Name (ST) optional
  • TXA-17: Document Completion Status (ID)
  • TXA-18: Document Confidentiality Status (ID) optional
  • TXA-19: Document Availability Status (ID) optional
  • TXA-20: Document Storage Status (ID) optional
  • TXA-21: Document Change Reason (ST) optional
  • TXA-22: Authentication Person, Time Stamp (PPN) optional repeating
  • TXA-23: Distributed Copies (Code and Name of Recipients) (XCN) optional repeating
See Also:
  • Constructor Details

  • Method Details

    • getSetIDTXA

      public SI getSetIDTXA()
      Returns TXA-1: "Set ID- TXA" - creates it if necessary
    • getTxa1_SetIDTXA

      public SI getTxa1_SetIDTXA()
      Returns TXA-1: "Set ID- TXA" - creates it if necessary
    • getDocumentType

      public IS getDocumentType()
      Returns TXA-2: "Document Type" - creates it if necessary
    • getTxa2_DocumentType

      Returns TXA-2: "Document Type" - creates it if necessary
    • getDocumentContentPresentation

      Returns TXA-3: "Document Content Presentation" - creates it if necessary
    • getTxa3_DocumentContentPresentation

      Returns TXA-3: "Document Content Presentation" - creates it if necessary
    • getActivityDateTime

      Returns TXA-4: "Activity Date/Time" - creates it if necessary
    • getTxa4_ActivityDateTime

      Returns TXA-4: "Activity Date/Time" - creates it if necessary
    • getPrimaryActivityProviderCodeName

      Returns all repetitions of Primary Activity Provider Code/Name (TXA-5).
    • getTxa5_PrimaryActivityProviderCodeName

      Returns all repetitions of Primary Activity Provider Code/Name (TXA-5).
    • getPrimaryActivityProviderCodeNameReps

      Returns a count of the current number of repetitions of Primary Activity Provider Code/Name (TXA-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getPrimaryActivityProviderCodeName

      Returns a specific repetition of TXA-5: "Primary Activity Provider Code/Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa5_PrimaryActivityProviderCodeName

      Returns a specific repetition of TXA-5: "Primary Activity Provider Code/Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa5_PrimaryActivityProviderCodeNameReps

      Returns a count of the current number of repetitions of Primary Activity Provider Code/Name (TXA-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertPrimaryActivityProviderCodeName

      Inserts a repetition of TXA-5: "Primary Activity Provider Code/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)
    • insertTxa5_PrimaryActivityProviderCodeName

      Inserts a repetition of TXA-5: "Primary Activity Provider Code/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)
    • removePrimaryActivityProviderCodeName

      Removes a repetition of TXA-5: "Primary Activity Provider Code/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)
    • removeTxa5_PrimaryActivityProviderCodeName

      Removes a repetition of TXA-5: "Primary Activity Provider Code/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)
    • getOriginationDateTime

      Returns TXA-6: "Origination Date/Time" - creates it if necessary
    • getTxa6_OriginationDateTime

      Returns TXA-6: "Origination Date/Time" - creates it if necessary
    • getTranscriptionDateTime

      Returns TXA-7: "Transcription Date/Time" - creates it if necessary
    • getTxa7_TranscriptionDateTime

      Returns TXA-7: "Transcription Date/Time" - creates it if necessary
    • getEditDateTime

      public TS[] getEditDateTime()
      Returns all repetitions of Edit Date/Time (TXA-8).
    • getTxa8_EditDateTime

      Returns all repetitions of Edit Date/Time (TXA-8).
    • getEditDateTimeReps

      public int getEditDateTimeReps()
      Returns a count of the current number of repetitions of Edit Date/Time (TXA-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getEditDateTime

      public TS getEditDateTime(int rep)
      Returns a specific repetition of TXA-8: "Edit Date/Time" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa8_EditDateTime

      public TS getTxa8_EditDateTime(int rep)
      Returns a specific repetition of TXA-8: "Edit Date/Time" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa8_EditDateTimeReps

      Returns a count of the current number of repetitions of Edit Date/Time (TXA-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertEditDateTime

      public TS insertEditDateTime(int rep) throws HL7Exception
      Inserts a repetition of TXA-8: "Edit Date/Time" 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)
    • insertTxa8_EditDateTime

      public TS insertTxa8_EditDateTime(int rep) throws HL7Exception
      Inserts a repetition of TXA-8: "Edit Date/Time" 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)
    • removeEditDateTime

      public TS removeEditDateTime(int rep) throws HL7Exception
      Removes a repetition of TXA-8: "Edit Date/Time" 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)
    • removeTxa8_EditDateTime

      public TS removeTxa8_EditDateTime(int rep) throws HL7Exception
      Removes a repetition of TXA-8: "Edit Date/Time" 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)
    • getOriginatorCodeName

      Returns all repetitions of Originator Code/Name (TXA-9).
    • getTxa9_OriginatorCodeName

      Returns all repetitions of Originator Code/Name (TXA-9).
    • getOriginatorCodeNameReps

      Returns a count of the current number of repetitions of Originator Code/Name (TXA-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getOriginatorCodeName

      public XCN getOriginatorCodeName(int rep)
      Returns a specific repetition of TXA-9: "Originator Code/Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa9_OriginatorCodeName

      public XCN getTxa9_OriginatorCodeName(int rep)
      Returns a specific repetition of TXA-9: "Originator Code/Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa9_OriginatorCodeNameReps

      Returns a count of the current number of repetitions of Originator Code/Name (TXA-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertOriginatorCodeName

      public XCN insertOriginatorCodeName(int rep) throws HL7Exception
      Inserts a repetition of TXA-9: "Originator Code/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)
    • insertTxa9_OriginatorCodeName

      Inserts a repetition of TXA-9: "Originator Code/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)
    • removeOriginatorCodeName

      public XCN removeOriginatorCodeName(int rep) throws HL7Exception
      Removes a repetition of TXA-9: "Originator Code/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)
    • removeTxa9_OriginatorCodeName

      Removes a repetition of TXA-9: "Originator Code/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)
    • getAssignedDocumentAuthenticator

      Returns all repetitions of Assigned Document Authenticator (TXA-10).
    • getTxa10_AssignedDocumentAuthenticator

      Returns all repetitions of Assigned Document Authenticator (TXA-10).
    • getAssignedDocumentAuthenticatorReps

      Returns a count of the current number of repetitions of Assigned Document Authenticator (TXA-10). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getAssignedDocumentAuthenticator

      Returns a specific repetition of TXA-10: "Assigned Document Authenticator" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa10_AssignedDocumentAuthenticator

      Returns a specific repetition of TXA-10: "Assigned Document Authenticator" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa10_AssignedDocumentAuthenticatorReps

      Returns a count of the current number of repetitions of Assigned Document Authenticator (TXA-10). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertAssignedDocumentAuthenticator

      Inserts a repetition of TXA-10: "Assigned Document Authenticator" 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)
    • insertTxa10_AssignedDocumentAuthenticator

      Inserts a repetition of TXA-10: "Assigned Document Authenticator" 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)
    • removeAssignedDocumentAuthenticator

      Removes a repetition of TXA-10: "Assigned Document Authenticator" 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)
    • removeTxa10_AssignedDocumentAuthenticator

      Removes a repetition of TXA-10: "Assigned Document Authenticator" 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)
    • getTranscriptionistCodeName

      Returns all repetitions of Transcriptionist Code/Name (TXA-11).
    • getTxa11_TranscriptionistCodeName

      Returns all repetitions of Transcriptionist Code/Name (TXA-11).
    • getTranscriptionistCodeNameReps

      Returns a count of the current number of repetitions of Transcriptionist Code/Name (TXA-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getTranscriptionistCodeName

      public XCN getTranscriptionistCodeName(int rep)
      Returns a specific repetition of TXA-11: "Transcriptionist Code/Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa11_TranscriptionistCodeName

      Returns a specific repetition of TXA-11: "Transcriptionist Code/Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa11_TranscriptionistCodeNameReps

      Returns a count of the current number of repetitions of Transcriptionist Code/Name (TXA-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertTranscriptionistCodeName

      Inserts a repetition of TXA-11: "Transcriptionist Code/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)
    • insertTxa11_TranscriptionistCodeName

      Inserts a repetition of TXA-11: "Transcriptionist Code/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)
    • removeTranscriptionistCodeName

      Removes a repetition of TXA-11: "Transcriptionist Code/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)
    • removeTxa11_TranscriptionistCodeName

      Removes a repetition of TXA-11: "Transcriptionist Code/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)
    • getUniqueDocumentNumber

      Returns TXA-12: "Unique Document Number" - creates it if necessary
    • getTxa12_UniqueDocumentNumber

      Returns TXA-12: "Unique Document Number" - creates it if necessary
    • getParentDocumentNumber

      Returns TXA-13: "Parent Document Number" - creates it if necessary
    • getTxa13_ParentDocumentNumber

      Returns TXA-13: "Parent Document Number" - creates it if necessary
    • getPlacerOrderNumber

      Returns all repetitions of Placer Order Number (TXA-14).
    • getTxa14_PlacerOrderNumber

      Returns all repetitions of Placer Order Number (TXA-14).
    • getPlacerOrderNumberReps

      Returns a count of the current number of repetitions of Placer Order Number (TXA-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getPlacerOrderNumber

      public EI getPlacerOrderNumber(int rep)
      Returns a specific repetition of TXA-14: "Placer Order Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa14_PlacerOrderNumber

      public EI getTxa14_PlacerOrderNumber(int rep)
      Returns a specific repetition of TXA-14: "Placer Order Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa14_PlacerOrderNumberReps

      Returns a count of the current number of repetitions of Placer Order Number (TXA-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertPlacerOrderNumber

      public EI insertPlacerOrderNumber(int rep) throws HL7Exception
      Inserts a repetition of TXA-14: "Placer Order 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)
    • insertTxa14_PlacerOrderNumber

      Inserts a repetition of TXA-14: "Placer Order 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)
    • removePlacerOrderNumber

      public EI removePlacerOrderNumber(int rep) throws HL7Exception
      Removes a repetition of TXA-14: "Placer Order 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)
    • removeTxa14_PlacerOrderNumber

      Removes a repetition of TXA-14: "Placer Order 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)
    • getFillerOrderNumber

      Returns TXA-15: "Filler Order Number" - creates it if necessary
    • getTxa15_FillerOrderNumber

      Returns TXA-15: "Filler Order Number" - creates it if necessary
    • getUniqueDocumentFileName

      Returns TXA-16: "Unique Document File Name" - creates it if necessary
    • getTxa16_UniqueDocumentFileName

      Returns TXA-16: "Unique Document File Name" - creates it if necessary
    • getDocumentCompletionStatus

      Returns TXA-17: "Document Completion Status" - creates it if necessary
    • getTxa17_DocumentCompletionStatus

      Returns TXA-17: "Document Completion Status" - creates it if necessary
    • getDocumentConfidentialityStatus

      Returns TXA-18: "Document Confidentiality Status" - creates it if necessary
    • getTxa18_DocumentConfidentialityStatus

      Returns TXA-18: "Document Confidentiality Status" - creates it if necessary
    • getDocumentAvailabilityStatus

      Returns TXA-19: "Document Availability Status" - creates it if necessary
    • getTxa19_DocumentAvailabilityStatus

      Returns TXA-19: "Document Availability Status" - creates it if necessary
    • getDocumentStorageStatus

      Returns TXA-20: "Document Storage Status" - creates it if necessary
    • getTxa20_DocumentStorageStatus

      Returns TXA-20: "Document Storage Status" - creates it if necessary
    • getDocumentChangeReason

      Returns TXA-21: "Document Change Reason" - creates it if necessary
    • getTxa21_DocumentChangeReason

      Returns TXA-21: "Document Change Reason" - creates it if necessary
    • getAuthenticationPersonTimeStamp

      Returns all repetitions of Authentication Person, Time Stamp (TXA-22).
    • getTxa22_AuthenticationPersonTimeStamp

      Returns all repetitions of Authentication Person, Time Stamp (TXA-22).
    • getAuthenticationPersonTimeStampReps

      Returns a count of the current number of repetitions of Authentication Person, Time Stamp (TXA-22). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getAuthenticationPersonTimeStamp

      Returns a specific repetition of TXA-22: "Authentication Person, Time Stamp" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa22_AuthenticationPersonTimeStamp

      Returns a specific repetition of TXA-22: "Authentication Person, Time Stamp" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa22_AuthenticationPersonTimeStampReps

      Returns a count of the current number of repetitions of Authentication Person, Time Stamp (TXA-22). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertAuthenticationPersonTimeStamp

      Inserts a repetition of TXA-22: "Authentication Person, Time Stamp" 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)
    • insertTxa22_AuthenticationPersonTimeStamp

      Inserts a repetition of TXA-22: "Authentication Person, Time Stamp" 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)
    • removeAuthenticationPersonTimeStamp

      Removes a repetition of TXA-22: "Authentication Person, Time Stamp" 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)
    • removeTxa22_AuthenticationPersonTimeStamp

      Removes a repetition of TXA-22: "Authentication Person, Time Stamp" 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)
    • getDistributedCopiesCodeandNameofRecipients

      Returns all repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23).
    • getTxa23_DistributedCopiesCodeandNameofRecipients

      Returns all repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23).
    • getDistributedCopiesCodeandNameofRecipientsReps

      Returns a count of the current number of repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getDistributedCopiesCodeandNameofRecipients

      Returns a specific repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa23_DistributedCopiesCodeandNameofRecipients

      Returns a specific repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getTxa23_DistributedCopiesCodeandNameofRecipientsReps

      Returns a count of the current number of repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertDistributedCopiesCodeandNameofRecipients

      Inserts a repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" 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)
    • insertTxa23_DistributedCopiesCodeandNameofRecipients

      Inserts a repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" 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)
    • removeDistributedCopiesCodeandNameofRecipients

      Removes a repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" 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)
    • removeTxa23_DistributedCopiesCodeandNameofRecipients

      Removes a repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" 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