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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class CTD
extends AbstractSegment

Represents an HL7 CTD message segment (Contact Data). This segment has the following fields:

• CTD-1: Contact Role (CE) repeating
• CTD-2: Contact Name (XPN) optional repeating
• CTD-3: Contact Address (XAD) optional repeating
• CTD-4: Contact Location (PL) optional
• CTD-5: Contact Communication Information (XTN) optional repeating
• CTD-6: Preferred Method of Contact (CE) optional
• CTD-7: Contact Identifiers (PI) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
XAD[]	getContactAddress() Returns all repetitions of Contact Address (CTD-3).
XAD	getContactAddress(int rep) Returns a specific repetition of CTD-3: "Contact Address" - creates it if necessary
int	getContactAddressReps() Returns a count of the current number of repetitions of Contact Address (CTD-3).
XTN[]	getContactCommunicationInformation() Returns all repetitions of Contact Communication Information (CTD-5).
XTN	getContactCommunicationInformation(int rep) Returns a specific repetition of CTD-5: "Contact Communication Information" - creates it if necessary
int	getContactCommunicationInformationReps() Returns a count of the current number of repetitions of Contact Communication Information (CTD-5).
PI[]	getContactIdentifiers() Returns all repetitions of Contact Identifiers (CTD-7).
PI	getContactIdentifiers(int rep) Returns a specific repetition of CTD-7: "Contact Identifiers" - creates it if necessary
int	getContactIdentifiersReps() Returns a count of the current number of repetitions of Contact Identifiers (CTD-7).
PL	getContactLocation() Returns CTD-4: "Contact Location" - creates it if necessary
XPN[]	getContactName() Returns all repetitions of Contact Name (CTD-2).
XPN	getContactName(int rep) Returns a specific repetition of CTD-2: "Contact Name" - creates it if necessary
int	getContactNameReps() Returns a count of the current number of repetitions of Contact Name (CTD-2).
CE[]	getContactRole() Returns all repetitions of Contact Role (CTD-1).
CE	getContactRole(int rep) Returns a specific repetition of CTD-1: "Contact Role" - creates it if necessary
int	getContactRoleReps() Returns a count of the current number of repetitions of Contact Role (CTD-1).
CE	getCtd1_ContactRole(int rep) Returns a specific repetition of CTD-1: "Contact Role" - creates it if necessary
int	getCtd1_ContactRoleReps() Returns a count of the current number of repetitions of Contact Role (CTD-1).
XPN	getCtd2_ContactName(int rep) Returns a specific repetition of CTD-2: "Contact Name" - creates it if necessary
int	getCtd2_ContactNameReps() Returns a count of the current number of repetitions of Contact Name (CTD-2).
XAD	getCtd3_ContactAddress(int rep) Returns a specific repetition of CTD-3: "Contact Address" - creates it if necessary
int	getCtd3_ContactAddressReps() Returns a count of the current number of repetitions of Contact Address (CTD-3).
PL	getCtd4_ContactLocation() Returns CTD-4: "Contact Location" - creates it if necessary
XTN	getCtd5_ContactCommunicationInformation(int rep) Returns a specific repetition of CTD-5: "Contact Communication Information" - creates it if necessary
int	getCtd5_ContactCommunicationInformationReps() Returns a count of the current number of repetitions of Contact Communication Information (CTD-5).
CE	getCtd6_PreferredMethodOfContact() Returns CTD-6: "Preferred Method of Contact" - creates it if necessary
PI	getCtd7_ContactIdentifiers(int rep) Returns a specific repetition of CTD-7: "Contact Identifiers" - creates it if necessary
int	getCtd7_ContactIdentifiersReps() Returns a count of the current number of repetitions of Contact Identifiers (CTD-7).
CE	getPreferredMethodOfContact() Returns CTD-6: "Preferred Method of Contact" - creates it if necessary
XAD	insertContactAddress(int rep) Inserts a repetition of CTD-3: "Contact Address" at a specific index
XTN	insertContactCommunicationInformation(int rep) Inserts a repetition of CTD-5: "Contact Communication Information" at a specific index
PI	insertContactIdentifiers(int rep) Inserts a repetition of CTD-7: "Contact Identifiers" at a specific index
XPN	insertContactName(int rep) Inserts a repetition of CTD-2: "Contact Name" at a specific index
CE	insertContactRole(int rep) Inserts a repetition of CTD-1: "Contact Role" at a specific index
CE	insertCtd1_ContactRole(int rep) Inserts a repetition of CTD-1: "Contact Role" at a specific index
XPN	insertCtd2_ContactName(int rep) Inserts a repetition of CTD-2: "Contact Name" at a specific index
XAD	insertCtd3_ContactAddress(int rep) Inserts a repetition of CTD-3: "Contact Address" at a specific index
XTN	insertCtd5_ContactCommunicationInformation(int rep) Inserts a repetition of CTD-5: "Contact Communication Information" at a specific index
PI	insertCtd7_ContactIdentifiers(int rep) Inserts a repetition of CTD-7: "Contact Identifiers" at a specific index
XAD	removeContactAddress(int rep) Removes a repetition of CTD-3: "Contact Address" at a specific index
XTN	removeContactCommunicationInformation(int rep) Removes a repetition of CTD-5: "Contact Communication Information" at a specific index
PI	removeContactIdentifiers(int rep) Removes a repetition of CTD-7: "Contact Identifiers" at a specific index
XPN	removeContactName(int rep) Removes a repetition of CTD-2: "Contact Name" at a specific index
CE	removeContactRole(int rep) Removes a repetition of CTD-1: "Contact Role" at a specific index
CE	removeCtd1_ContactRole(int rep) Removes a repetition of CTD-1: "Contact Role" at a specific index
XPN	removeCtd2_ContactName(int rep) Removes a repetition of CTD-2: "Contact Name" at a specific index
XAD	removeCtd3_ContactAddress(int rep) Removes a repetition of CTD-3: "Contact Address" at a specific index
XTN	removeCtd5_ContactCommunicationInformation(int rep) Removes a repetition of CTD-5: "Contact Communication Information" at a specific index
PI	removeCtd7_ContactIdentifiers(int rep) Removes a repetition of CTD-7: "Contact Identifiers" 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

CTD

public CTD(Group parent,
           ModelClassFactory factory)

Creates a new CTD segment

Method Detail

getContactRole

public CE[] getContactRole()

Returns all repetitions of Contact Role (CTD-1).

getContactRoleReps

public int getContactRoleReps()

Returns a count of the current number of repetitions of Contact Role (CTD-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getContactRole

public CE getContactRole(int rep)

Returns a specific repetition of CTD-1: "Contact Role" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCtd1_ContactRole

public CE getCtd1_ContactRole(int rep)

Returns a specific repetition of CTD-1: "Contact Role" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCtd1_ContactRoleReps

public int getCtd1_ContactRoleReps()

Returns a count of the current number of repetitions of Contact Role (CTD-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertContactRole

public CE insertContactRole(int rep)
                     throws HL7Exception

Inserts a repetition of CTD-1: "Contact Role" 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)

insertCtd1_ContactRole

public CE insertCtd1_ContactRole(int rep)
                          throws HL7Exception

Inserts a repetition of CTD-1: "Contact Role" 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)

removeContactRole

public CE removeContactRole(int rep)
                     throws HL7Exception

Removes a repetition of CTD-1: "Contact Role" 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)

removeCtd1_ContactRole

public CE removeCtd1_ContactRole(int rep)
                          throws HL7Exception

Removes a repetition of CTD-1: "Contact Role" 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)

getContactName

public XPN[] getContactName()

Returns all repetitions of Contact Name (CTD-2).

getContactNameReps

public int getContactNameReps()

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

getContactName

public XPN getContactName(int rep)

Returns a specific repetition of CTD-2: "Contact Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCtd2_ContactName

public XPN getCtd2_ContactName(int rep)

Returns a specific repetition of CTD-2: "Contact Name" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCtd2_ContactNameReps

public int getCtd2_ContactNameReps()

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

insertContactName

public XPN insertContactName(int rep)
                      throws HL7Exception

Inserts a repetition of CTD-2: "Contact 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)

insertCtd2_ContactName

public XPN insertCtd2_ContactName(int rep)
                           throws HL7Exception

Inserts a repetition of CTD-2: "Contact 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)

removeContactName

public XPN removeContactName(int rep)
                      throws HL7Exception

Removes a repetition of CTD-2: "Contact 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)

removeCtd2_ContactName

public XPN removeCtd2_ContactName(int rep)
                           throws HL7Exception

Removes a repetition of CTD-2: "Contact 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)

getContactAddress

public XAD[] getContactAddress()

Returns all repetitions of Contact Address (CTD-3).

getContactAddressReps

public int getContactAddressReps()

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

getContactAddress

public XAD getContactAddress(int rep)

Returns a specific repetition of CTD-3: "Contact Address" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCtd3_ContactAddress

public XAD getCtd3_ContactAddress(int rep)

Returns a specific repetition of CTD-3: "Contact Address" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCtd3_ContactAddressReps

public int getCtd3_ContactAddressReps()

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

insertContactAddress

public XAD insertContactAddress(int rep)
                         throws HL7Exception

Inserts a repetition of CTD-3: "Contact 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)

insertCtd3_ContactAddress

public XAD insertCtd3_ContactAddress(int rep)
                              throws HL7Exception

Inserts a repetition of CTD-3: "Contact 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)

removeContactAddress

public XAD removeContactAddress(int rep)
                         throws HL7Exception

Removes a repetition of CTD-3: "Contact 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)

removeCtd3_ContactAddress

public XAD removeCtd3_ContactAddress(int rep)
                              throws HL7Exception

Removes a repetition of CTD-3: "Contact 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)

getContactLocation

public PL getContactLocation()

Returns CTD-4: "Contact Location" - creates it if necessary

getCtd4_ContactLocation

public PL getCtd4_ContactLocation()

Returns CTD-4: "Contact Location" - creates it if necessary

getContactCommunicationInformation

public XTN[] getContactCommunicationInformation()

Returns all repetitions of Contact Communication Information (CTD-5).

getContactCommunicationInformationReps

public int getContactCommunicationInformationReps()

Returns a count of the current number of repetitions of Contact Communication Information (CTD-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getContactCommunicationInformation

public XTN getContactCommunicationInformation(int rep)

Returns a specific repetition of CTD-5: "Contact Communication Information" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCtd5_ContactCommunicationInformation

public XTN getCtd5_ContactCommunicationInformation(int rep)

Returns a specific repetition of CTD-5: "Contact Communication Information" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCtd5_ContactCommunicationInformationReps

public int getCtd5_ContactCommunicationInformationReps()

Returns a count of the current number of repetitions of Contact Communication Information (CTD-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertContactCommunicationInformation

public XTN insertContactCommunicationInformation(int rep)
                                          throws HL7Exception

Inserts a repetition of CTD-5: "Contact Communication Information" 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)

insertCtd5_ContactCommunicationInformation

public XTN insertCtd5_ContactCommunicationInformation(int rep)
                                               throws HL7Exception

Inserts a repetition of CTD-5: "Contact Communication Information" 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)

removeContactCommunicationInformation

public XTN removeContactCommunicationInformation(int rep)
                                          throws HL7Exception

Removes a repetition of CTD-5: "Contact Communication Information" 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)

removeCtd5_ContactCommunicationInformation

public XTN removeCtd5_ContactCommunicationInformation(int rep)
                                               throws HL7Exception

Removes a repetition of CTD-5: "Contact Communication Information" 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)

getPreferredMethodOfContact

public CE getPreferredMethodOfContact()

Returns CTD-6: "Preferred Method of Contact" - creates it if necessary

getCtd6_PreferredMethodOfContact

public CE getCtd6_PreferredMethodOfContact()

Returns CTD-6: "Preferred Method of Contact" - creates it if necessary

getContactIdentifiers

public PI[] getContactIdentifiers()

Returns all repetitions of Contact Identifiers (CTD-7).

getContactIdentifiersReps

public int getContactIdentifiersReps()

Returns a count of the current number of repetitions of Contact Identifiers (CTD-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getContactIdentifiers

public PI getContactIdentifiers(int rep)

Returns a specific repetition of CTD-7: "Contact Identifiers" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCtd7_ContactIdentifiers

public PI getCtd7_ContactIdentifiers(int rep)

Returns a specific repetition of CTD-7: "Contact Identifiers" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCtd7_ContactIdentifiersReps

public int getCtd7_ContactIdentifiersReps()

Returns a count of the current number of repetitions of Contact Identifiers (CTD-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertContactIdentifiers

public PI insertContactIdentifiers(int rep)
                            throws HL7Exception

Inserts a repetition of CTD-7: "Contact Identifiers" 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)

insertCtd7_ContactIdentifiers

public PI insertCtd7_ContactIdentifiers(int rep)
                                 throws HL7Exception

Inserts a repetition of CTD-7: "Contact Identifiers" 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)

removeContactIdentifiers

public PI removeContactIdentifiers(int rep)
                            throws HL7Exception

Removes a repetition of CTD-7: "Contact Identifiers" 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)

removeCtd7_ContactIdentifiers

public PI removeCtd7_ContactIdentifiers(int rep)
                                 throws HL7Exception

Removes a repetition of CTD-7: "Contact Identifiers" 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