ca.uhn.hl7v2.model.v24.segment
Class TXA

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.TXA

All Implemented Interfaces:

Segment, Structure, 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:

Serialized Form

Constructor Summary

TXA(Group parent, ModelClassFactory factory)
Creates a new TXA segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
TS	getActivityDateTime() Returns TXA-4: "Activity Date/Time" - creates it if necessary
XCN[]	getAssignedDocumentAuthenticator() Returns all repetitions of Assigned Document Authenticator (TXA-10).
XCN	getAssignedDocumentAuthenticator(int rep) Returns a specific repetition of TXA-10: "Assigned Document Authenticator" - creates it if necessary
int	getAssignedDocumentAuthenticatorReps() Returns a count of the current number of repetitions of Assigned Document Authenticator (TXA-10).
PPN[]	getAuthenticationPersonTimeStamp() Returns all repetitions of Authentication Person, Time Stamp (TXA-22).
PPN	getAuthenticationPersonTimeStamp(int rep) Returns a specific repetition of TXA-22: "Authentication Person, Time Stamp" - creates it if necessary
int	getAuthenticationPersonTimeStampReps() Returns a count of the current number of repetitions of Authentication Person, Time Stamp (TXA-22).
XCN[]	getDistributedCopiesCodeandNameofRecipients() Returns all repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23).
XCN	getDistributedCopiesCodeandNameofRecipients(int rep) Returns a specific repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" - creates it if necessary
int	getDistributedCopiesCodeandNameofRecipientsReps() Returns a count of the current number of repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23).
ID	getDocumentAvailabilityStatus() Returns TXA-19: "Document Availability Status" - creates it if necessary
ST	getDocumentChangeReason() Returns TXA-21: "Document Change Reason" - creates it if necessary
ID	getDocumentCompletionStatus() Returns TXA-17: "Document Completion Status" - creates it if necessary
ID	getDocumentConfidentialityStatus() Returns TXA-18: "Document Confidentiality Status" - creates it if necessary
ID	getDocumentContentPresentation() Returns TXA-3: "Document Content Presentation" - creates it if necessary
ID	getDocumentStorageStatus() Returns TXA-20: "Document Storage Status" - creates it if necessary
IS	getDocumentType() Returns TXA-2: "Document Type" - creates it if necessary
TS[]	getEditDateTime() Returns all repetitions of Edit Date/Time (TXA-8).
TS	getEditDateTime(int rep) Returns a specific repetition of TXA-8: "Edit Date/Time" - creates it if necessary
int	getEditDateTimeReps() Returns a count of the current number of repetitions of Edit Date/Time (TXA-8).
EI	getFillerOrderNumber() Returns TXA-15: "Filler Order Number" - creates it if necessary
TS	getOriginationDateTime() Returns TXA-6: "Origination Date/Time" - creates it if necessary
XCN[]	getOriginatorCodeName() Returns all repetitions of Originator Code/Name (TXA-9).
XCN	getOriginatorCodeName(int rep) Returns a specific repetition of TXA-9: "Originator Code/Name" - creates it if necessary
int	getOriginatorCodeNameReps() Returns a count of the current number of repetitions of Originator Code/Name (TXA-9).
EI	getParentDocumentNumber() Returns TXA-13: "Parent Document Number" - creates it if necessary
EI[]	getPlacerOrderNumber() Returns all repetitions of Placer Order Number (TXA-14).
EI	getPlacerOrderNumber(int rep) Returns a specific repetition of TXA-14: "Placer Order Number" - creates it if necessary
int	getPlacerOrderNumberReps() Returns a count of the current number of repetitions of Placer Order Number (TXA-14).
XCN[]	getPrimaryActivityProviderCodeName() Returns all repetitions of Primary Activity Provider Code/Name (TXA-5).
XCN	getPrimaryActivityProviderCodeName(int rep) Returns a specific repetition of TXA-5: "Primary Activity Provider Code/Name" - creates it if necessary
int	getPrimaryActivityProviderCodeNameReps() Returns a count of the current number of repetitions of Primary Activity Provider Code/Name (TXA-5).
SI	getSetIDTXA() Returns TXA-1: "Set ID- TXA" - creates it if necessary
TS	getTranscriptionDateTime() Returns TXA-7: "Transcription Date/Time" - creates it if necessary
XCN[]	getTranscriptionistCodeName() Returns all repetitions of Transcriptionist Code/Name (TXA-11).
XCN	getTranscriptionistCodeName(int rep) Returns a specific repetition of TXA-11: "Transcriptionist Code/Name" - creates it if necessary
int	getTranscriptionistCodeNameReps() Returns a count of the current number of repetitions of Transcriptionist Code/Name (TXA-11).
SI	getTxa1_SetIDTXA() Returns TXA-1: "Set ID- TXA" - creates it if necessary
XCN	getTxa10_AssignedDocumentAuthenticator(int rep) Returns a specific repetition of TXA-10: "Assigned Document Authenticator" - creates it if necessary
int	getTxa10_AssignedDocumentAuthenticatorReps() Returns a count of the current number of repetitions of Assigned Document Authenticator (TXA-10).
XCN	getTxa11_TranscriptionistCodeName(int rep) Returns a specific repetition of TXA-11: "Transcriptionist Code/Name" - creates it if necessary
int	getTxa11_TranscriptionistCodeNameReps() Returns a count of the current number of repetitions of Transcriptionist Code/Name (TXA-11).
EI	getTxa12_UniqueDocumentNumber() Returns TXA-12: "Unique Document Number" - creates it if necessary
EI	getTxa13_ParentDocumentNumber() Returns TXA-13: "Parent Document Number" - creates it if necessary
EI	getTxa14_PlacerOrderNumber(int rep) Returns a specific repetition of TXA-14: "Placer Order Number" - creates it if necessary
int	getTxa14_PlacerOrderNumberReps() Returns a count of the current number of repetitions of Placer Order Number (TXA-14).
EI	getTxa15_FillerOrderNumber() Returns TXA-15: "Filler Order Number" - creates it if necessary
ST	getTxa16_UniqueDocumentFileName() Returns TXA-16: "Unique Document File Name" - creates it if necessary
ID	getTxa17_DocumentCompletionStatus() Returns TXA-17: "Document Completion Status" - creates it if necessary
ID	getTxa18_DocumentConfidentialityStatus() Returns TXA-18: "Document Confidentiality Status" - creates it if necessary
ID	getTxa19_DocumentAvailabilityStatus() Returns TXA-19: "Document Availability Status" - creates it if necessary
IS	getTxa2_DocumentType() Returns TXA-2: "Document Type" - creates it if necessary
ID	getTxa20_DocumentStorageStatus() Returns TXA-20: "Document Storage Status" - creates it if necessary
ST	getTxa21_DocumentChangeReason() Returns TXA-21: "Document Change Reason" - creates it if necessary
PPN	getTxa22_AuthenticationPersonTimeStamp(int rep) Returns a specific repetition of TXA-22: "Authentication Person, Time Stamp" - creates it if necessary
int	getTxa22_AuthenticationPersonTimeStampReps() Returns a count of the current number of repetitions of Authentication Person, Time Stamp (TXA-22).
XCN	getTxa23_DistributedCopiesCodeandNameofRecipients(int rep) Returns a specific repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" - creates it if necessary
int	getTxa23_DistributedCopiesCodeandNameofRecipientsReps() Returns a count of the current number of repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23).
ID	getTxa3_DocumentContentPresentation() Returns TXA-3: "Document Content Presentation" - creates it if necessary
TS	getTxa4_ActivityDateTime() Returns TXA-4: "Activity Date/Time" - creates it if necessary
XCN	getTxa5_PrimaryActivityProviderCodeName(int rep) Returns a specific repetition of TXA-5: "Primary Activity Provider Code/Name" - creates it if necessary
int	getTxa5_PrimaryActivityProviderCodeNameReps() Returns a count of the current number of repetitions of Primary Activity Provider Code/Name (TXA-5).
TS	getTxa6_OriginationDateTime() Returns TXA-6: "Origination Date/Time" - creates it if necessary
TS	getTxa7_TranscriptionDateTime() Returns TXA-7: "Transcription Date/Time" - creates it if necessary
TS	getTxa8_EditDateTime(int rep) Returns a specific repetition of TXA-8: "Edit Date/Time" - creates it if necessary
int	getTxa8_EditDateTimeReps() Returns a count of the current number of repetitions of Edit Date/Time (TXA-8).
XCN	getTxa9_OriginatorCodeName(int rep) Returns a specific repetition of TXA-9: "Originator Code/Name" - creates it if necessary
int	getTxa9_OriginatorCodeNameReps() Returns a count of the current number of repetitions of Originator Code/Name (TXA-9).
ST	getUniqueDocumentFileName() Returns TXA-16: "Unique Document File Name" - creates it if necessary
EI	getUniqueDocumentNumber() Returns TXA-12: "Unique Document Number" - creates it if necessary
XCN	insertAssignedDocumentAuthenticator(int rep) Inserts a repetition of TXA-10: "Assigned Document Authenticator" at a specific index
PPN	insertAuthenticationPersonTimeStamp(int rep) Inserts a repetition of TXA-22: "Authentication Person, Time Stamp" at a specific index
XCN	insertDistributedCopiesCodeandNameofRecipients(int rep) Inserts a repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index
TS	insertEditDateTime(int rep) Inserts a repetition of TXA-8: "Edit Date/Time" at a specific index
XCN	insertOriginatorCodeName(int rep) Inserts a repetition of TXA-9: "Originator Code/Name" at a specific index
EI	insertPlacerOrderNumber(int rep) Inserts a repetition of TXA-14: "Placer Order Number" at a specific index
XCN	insertPrimaryActivityProviderCodeName(int rep) Inserts a repetition of TXA-5: "Primary Activity Provider Code/Name" at a specific index
XCN	insertTranscriptionistCodeName(int rep) Inserts a repetition of TXA-11: "Transcriptionist Code/Name" at a specific index
XCN	insertTxa10_AssignedDocumentAuthenticator(int rep) Inserts a repetition of TXA-10: "Assigned Document Authenticator" at a specific index
XCN	insertTxa11_TranscriptionistCodeName(int rep) Inserts a repetition of TXA-11: "Transcriptionist Code/Name" at a specific index
EI	insertTxa14_PlacerOrderNumber(int rep) Inserts a repetition of TXA-14: "Placer Order Number" at a specific index
PPN	insertTxa22_AuthenticationPersonTimeStamp(int rep) Inserts a repetition of TXA-22: "Authentication Person, Time Stamp" at a specific index
XCN	insertTxa23_DistributedCopiesCodeandNameofRecipients(int rep) Inserts a repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index
XCN	insertTxa5_PrimaryActivityProviderCodeName(int rep) Inserts a repetition of TXA-5: "Primary Activity Provider Code/Name" at a specific index
TS	insertTxa8_EditDateTime(int rep) Inserts a repetition of TXA-8: "Edit Date/Time" at a specific index
XCN	insertTxa9_OriginatorCodeName(int rep) Inserts a repetition of TXA-9: "Originator Code/Name" at a specific index
XCN	removeAssignedDocumentAuthenticator(int rep) Removes a repetition of TXA-10: "Assigned Document Authenticator" at a specific index
PPN	removeAuthenticationPersonTimeStamp(int rep) Removes a repetition of TXA-22: "Authentication Person, Time Stamp" at a specific index
XCN	removeDistributedCopiesCodeandNameofRecipients(int rep) Removes a repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index
TS	removeEditDateTime(int rep) Removes a repetition of TXA-8: "Edit Date/Time" at a specific index
XCN	removeOriginatorCodeName(int rep) Removes a repetition of TXA-9: "Originator Code/Name" at a specific index
EI	removePlacerOrderNumber(int rep) Removes a repetition of TXA-14: "Placer Order Number" at a specific index
XCN	removePrimaryActivityProviderCodeName(int rep) Removes a repetition of TXA-5: "Primary Activity Provider Code/Name" at a specific index
XCN	removeTranscriptionistCodeName(int rep) Removes a repetition of TXA-11: "Transcriptionist Code/Name" at a specific index
XCN	removeTxa10_AssignedDocumentAuthenticator(int rep) Removes a repetition of TXA-10: "Assigned Document Authenticator" at a specific index
XCN	removeTxa11_TranscriptionistCodeName(int rep) Removes a repetition of TXA-11: "Transcriptionist Code/Name" at a specific index
EI	removeTxa14_PlacerOrderNumber(int rep) Removes a repetition of TXA-14: "Placer Order Number" at a specific index
PPN	removeTxa22_AuthenticationPersonTimeStamp(int rep) Removes a repetition of TXA-22: "Authentication Person, Time Stamp" at a specific index
XCN	removeTxa23_DistributedCopiesCodeandNameofRecipients(int rep) Removes a repetition of TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index
XCN	removeTxa5_PrimaryActivityProviderCodeName(int rep) Removes a repetition of TXA-5: "Primary Activity Provider Code/Name" at a specific index
TS	removeTxa8_EditDateTime(int rep) Removes a repetition of TXA-8: "Edit Date/Time" at a specific index
XCN	removeTxa9_OriginatorCodeName(int rep) Removes a repetition of TXA-9: "Originator Code/Name" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TXA

public TXA(Group parent,
           ModelClassFactory factory)

Creates a new TXA segment

Method Detail

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

public IS getTxa2_DocumentType()

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

getDocumentContentPresentation

public ID getDocumentContentPresentation()

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

getTxa3_DocumentContentPresentation

public ID getTxa3_DocumentContentPresentation()

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

getActivityDateTime

public TS getActivityDateTime()

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

getTxa4_ActivityDateTime

public TS getTxa4_ActivityDateTime()

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

getPrimaryActivityProviderCodeName

public XCN[] getPrimaryActivityProviderCodeName()

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

getPrimaryActivityProviderCodeNameReps

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

public XCN getPrimaryActivityProviderCodeName(int rep)

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

public XCN getTxa5_PrimaryActivityProviderCodeName(int rep)

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

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

public XCN insertPrimaryActivityProviderCodeName(int rep)
                                          throws HL7Exception

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

public XCN insertTxa5_PrimaryActivityProviderCodeName(int rep)
                                               throws HL7Exception

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

public XCN removePrimaryActivityProviderCodeName(int rep)
                                          throws HL7Exception

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

public XCN removeTxa5_PrimaryActivityProviderCodeName(int rep)
                                               throws HL7Exception

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

public TS getOriginationDateTime()

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

getTxa6_OriginationDateTime

public TS getTxa6_OriginationDateTime()

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

getTranscriptionDateTime

public TS getTranscriptionDateTime()

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

getTxa7_TranscriptionDateTime

public TS 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).

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

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

public XCN[] getOriginatorCodeName()

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

getOriginatorCodeNameReps

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

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

public XCN insertTxa9_OriginatorCodeName(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)

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

public XCN removeTxa9_OriginatorCodeName(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)

getAssignedDocumentAuthenticator

public XCN[] getAssignedDocumentAuthenticator()

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

getAssignedDocumentAuthenticatorReps

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

public XCN getAssignedDocumentAuthenticator(int rep)

Returns a specific repetition of TXA-10: "Assigned Document Authenticator" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getTxa10_AssignedDocumentAuthenticator

public XCN getTxa10_AssignedDocumentAuthenticator(int rep)

Returns a specific repetition of TXA-10: "Assigned Document Authenticator" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getTxa10_AssignedDocumentAuthenticatorReps

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

public XCN insertAssignedDocumentAuthenticator(int rep)
                                        throws HL7Exception

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

public XCN insertTxa10_AssignedDocumentAuthenticator(int rep)
                                              throws HL7Exception

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

public XCN removeAssignedDocumentAuthenticator(int rep)
                                        throws HL7Exception

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

public XCN removeTxa10_AssignedDocumentAuthenticator(int rep)
                                              throws HL7Exception

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

public XCN[] getTranscriptionistCodeName()

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

getTranscriptionistCodeNameReps

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

public XCN getTxa11_TranscriptionistCodeName(int rep)

Returns a specific repetition of TXA-11: "Transcriptionist Code/Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getTxa11_TranscriptionistCodeNameReps

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

public XCN insertTranscriptionistCodeName(int rep)
                                   throws HL7Exception

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

public XCN insertTxa11_TranscriptionistCodeName(int rep)
                                         throws HL7Exception

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

public XCN removeTranscriptionistCodeName(int rep)
                                   throws HL7Exception

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

public XCN removeTxa11_TranscriptionistCodeName(int rep)
                                         throws HL7Exception

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

public EI getUniqueDocumentNumber()

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

getTxa12_UniqueDocumentNumber

public EI getTxa12_UniqueDocumentNumber()

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

getParentDocumentNumber

public EI getParentDocumentNumber()

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

getTxa13_ParentDocumentNumber

public EI getTxa13_ParentDocumentNumber()

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

getPlacerOrderNumber

public EI[] getPlacerOrderNumber()

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

getPlacerOrderNumberReps

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

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

public EI insertTxa14_PlacerOrderNumber(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)

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

public EI removeTxa14_PlacerOrderNumber(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)

getFillerOrderNumber

public EI getFillerOrderNumber()

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

getTxa15_FillerOrderNumber

public EI getTxa15_FillerOrderNumber()

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

getUniqueDocumentFileName

public ST getUniqueDocumentFileName()

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

getTxa16_UniqueDocumentFileName

public ST getTxa16_UniqueDocumentFileName()

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

getDocumentCompletionStatus

public ID getDocumentCompletionStatus()

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

getTxa17_DocumentCompletionStatus

public ID getTxa17_DocumentCompletionStatus()

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

getDocumentConfidentialityStatus

public ID getDocumentConfidentialityStatus()

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

getTxa18_DocumentConfidentialityStatus

public ID getTxa18_DocumentConfidentialityStatus()

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

getDocumentAvailabilityStatus

public ID getDocumentAvailabilityStatus()

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

getTxa19_DocumentAvailabilityStatus

public ID getTxa19_DocumentAvailabilityStatus()

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

getDocumentStorageStatus

public ID getDocumentStorageStatus()

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

getTxa20_DocumentStorageStatus

public ID getTxa20_DocumentStorageStatus()

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

getDocumentChangeReason

public ST getDocumentChangeReason()

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

getTxa21_DocumentChangeReason

public ST getTxa21_DocumentChangeReason()

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

getAuthenticationPersonTimeStamp

public PPN[] getAuthenticationPersonTimeStamp()

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

getAuthenticationPersonTimeStampReps

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

public PPN getAuthenticationPersonTimeStamp(int rep)

Returns a specific repetition of TXA-22: "Authentication Person, Time Stamp" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getTxa22_AuthenticationPersonTimeStamp

public PPN getTxa22_AuthenticationPersonTimeStamp(int rep)

Returns a specific repetition of TXA-22: "Authentication Person, Time Stamp" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getTxa22_AuthenticationPersonTimeStampReps

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

public PPN insertAuthenticationPersonTimeStamp(int rep)
                                        throws HL7Exception

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

public PPN insertTxa22_AuthenticationPersonTimeStamp(int rep)
                                              throws HL7Exception

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

public PPN removeAuthenticationPersonTimeStamp(int rep)
                                        throws HL7Exception

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

public PPN removeTxa22_AuthenticationPersonTimeStamp(int rep)
                                              throws HL7Exception

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

public XCN[] getDistributedCopiesCodeandNameofRecipients()

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

getDistributedCopiesCodeandNameofRecipientsReps

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

public XCN getDistributedCopiesCodeandNameofRecipients(int rep)

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

public XCN getTxa23_DistributedCopiesCodeandNameofRecipients(int rep)

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

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

public XCN insertDistributedCopiesCodeandNameofRecipients(int rep)
                                                   throws HL7Exception

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

public XCN insertTxa23_DistributedCopiesCodeandNameofRecipients(int rep)
                                                         throws HL7Exception

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

public XCN removeDistributedCopiesCodeandNameofRecipients(int rep)
                                                   throws HL7Exception

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

public XCN removeTxa23_DistributedCopiesCodeandNameofRecipients(int rep)
                                                         throws HL7Exception

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