ca.uhn.hl7v2.model.v24.datatype
Class XCN

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.v24.datatype.XCN

All Implemented Interfaces:

Composite, Type, Serializable

public class XCN
extends AbstractType
implements Composite

Represents an HL7 XCN (extended composite ID number and name for persons) data type. This type consists of the following components:

• ID number (ST) (ST)
• family name (FN)
• given name (ST)
• second and further given names or initials thereof (ST)
• suffix (e.g., JR or III) (ST)
• prefix (e.g., DR) (ST)
• degree (e.g., MD) (IS)
• source table (IS)
• assigning authority (HD)
• name type code (ID)
• identifier check digit (ST)
• code identifying the check digit scheme employed (ID)
• identifier type code (IS) (IS)
• assigning facility (HD)
• Name Representation code (ID)
• name context (CE)
• name validity range (DR)
• name assembly order (ID)

See Also:

Serialized Form

Constructor Summary

XCN(Message message)
Creates a new XCN type

Method Summary

HD	getAssigningAuthority() Returns assigning authority (component #9).
HD	getAssigningFacility() Returns assigning facility (component #14).
ID	getCodeIdentifyingTheCheckDigitSchemeEmployed() Returns code identifying the check digit scheme employed (component #12).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
IS	getDegreeEgMD() Returns degree (e.g., MD) (component #7).
FN	getFamilyName() Returns family name (component #2).
ST	getGivenName() Returns given name (component #3).
ST	getIdentifierCheckDigit() Returns identifier check digit (component #11).
IS	getIdentifierTypeCode() Returns identifier type code (IS) (component #13).
ST	getIDNumber() Returns ID number (ST) (component #1).
ID	getNameAssemblyOrder() Returns name assembly order (component #18).
CE	getNameContext() Returns name context (component #16).
ID	getNameRepresentationCode() Returns Name Representation code (component #15).
ID	getNameTypeCode() Returns name type code (component #10).
DR	getNameValidityRange() Returns name validity range (component #17).
ST	getPrefixEgDR() Returns prefix (e.g., DR) (component #6).
ST	getSecondAndFurtherGivenNamesOrInitialsThereof() Returns second and further given names or initials thereof (component #4).
IS	getSourceTable() Returns source table (component #8).
ST	getSuffixEgJRorIII() Returns suffix (e.g., JR or III) (component #5).
ST	getXcn1_IDNumber() Returns ID number (ST) (component #1).
ID	getXcn10_NameTypeCode() Returns name type code (component #10).
ST	getXcn11_IdentifierCheckDigit() Returns identifier check digit (component #11).
ID	getXcn12_CodeIdentifyingTheCheckDigitSchemeEmployed() Returns code identifying the check digit scheme employed (component #12).
IS	getXcn13_IdentifierTypeCode() Returns identifier type code (IS) (component #13).
HD	getXcn14_AssigningFacility() Returns assigning facility (component #14).
ID	getXcn15_NameRepresentationCode() Returns Name Representation code (component #15).
CE	getXcn16_NameContext() Returns name context (component #16).
DR	getXcn17_NameValidityRange() Returns name validity range (component #17).
ID	getXcn18_NameAssemblyOrder() Returns name assembly order (component #18).
FN	getXcn2_FamilyName() Returns family name (component #2).
ST	getXcn3_GivenName() Returns given name (component #3).
ST	getXcn4_SecondAndFurtherGivenNamesOrInitialsThereof() Returns second and further given names or initials thereof (component #4).
ST	getXcn5_SuffixEgJRorIII() Returns suffix (e.g., JR or III) (component #5).
ST	getXcn6_PrefixEgDR() Returns prefix (e.g., DR) (component #6).
IS	getXcn7_DegreeEgMD() Returns degree (e.g., MD) (component #7).
IS	getXcn8_SourceTable() Returns source table (component #8).
HD	getXcn9_AssigningAuthority() Returns assigning authority (component #9).

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

clear, encode, getExtraComponents, getMessage, getName, parse

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Type

clear, encode, getExtraComponents, getMessage, getName, parse

Constructor Detail

XCN

public XCN(Message message)

Creates a new XCN type

Method Detail

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

Specified by:

getComponents in interface Composite

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Specified by:

getComponent in interface Composite

Parameters:

number - The component number (0-indexed)

Throws:

DataTypeException - if the given element number is out of range.

getIDNumber

public ST getIDNumber()

Returns ID number (ST) (component #1). This is a convenience method that saves you from casting and handling an exception.

getXcn1_IDNumber

public ST getXcn1_IDNumber()

Returns ID number (ST) (component #1). This is a convenience method that saves you from casting and handling an exception.

getFamilyName

public FN getFamilyName()

Returns family name (component #2). This is a convenience method that saves you from casting and handling an exception.

getXcn2_FamilyName

public FN getXcn2_FamilyName()

Returns family name (component #2). This is a convenience method that saves you from casting and handling an exception.

getGivenName

public ST getGivenName()

Returns given name (component #3). This is a convenience method that saves you from casting and handling an exception.

getXcn3_GivenName

public ST getXcn3_GivenName()

Returns given name (component #3). This is a convenience method that saves you from casting and handling an exception.

getSecondAndFurtherGivenNamesOrInitialsThereof

public ST getSecondAndFurtherGivenNamesOrInitialsThereof()

Returns second and further given names or initials thereof (component #4). This is a convenience method that saves you from casting and handling an exception.

getXcn4_SecondAndFurtherGivenNamesOrInitialsThereof

public ST getXcn4_SecondAndFurtherGivenNamesOrInitialsThereof()

Returns second and further given names or initials thereof (component #4). This is a convenience method that saves you from casting and handling an exception.

getSuffixEgJRorIII

public ST getSuffixEgJRorIII()

Returns suffix (e.g., JR or III) (component #5). This is a convenience method that saves you from casting and handling an exception.

getXcn5_SuffixEgJRorIII

public ST getXcn5_SuffixEgJRorIII()

Returns suffix (e.g., JR or III) (component #5). This is a convenience method that saves you from casting and handling an exception.

getPrefixEgDR

public ST getPrefixEgDR()

Returns prefix (e.g., DR) (component #6). This is a convenience method that saves you from casting and handling an exception.

getXcn6_PrefixEgDR

public ST getXcn6_PrefixEgDR()

Returns prefix (e.g., DR) (component #6). This is a convenience method that saves you from casting and handling an exception.

getDegreeEgMD

public IS getDegreeEgMD()

Returns degree (e.g., MD) (component #7). This is a convenience method that saves you from casting and handling an exception.

getXcn7_DegreeEgMD

public IS getXcn7_DegreeEgMD()

Returns degree (e.g., MD) (component #7). This is a convenience method that saves you from casting and handling an exception.

getSourceTable

public IS getSourceTable()

Returns source table (component #8). This is a convenience method that saves you from casting and handling an exception.

getXcn8_SourceTable

public IS getXcn8_SourceTable()

Returns source table (component #8). This is a convenience method that saves you from casting and handling an exception.

getAssigningAuthority

public HD getAssigningAuthority()

Returns assigning authority (component #9). This is a convenience method that saves you from casting and handling an exception.

getXcn9_AssigningAuthority

public HD getXcn9_AssigningAuthority()

Returns assigning authority (component #9). This is a convenience method that saves you from casting and handling an exception.

getNameTypeCode

public ID getNameTypeCode()

Returns name type code (component #10). This is a convenience method that saves you from casting and handling an exception.

getXcn10_NameTypeCode

public ID getXcn10_NameTypeCode()

Returns name type code (component #10). This is a convenience method that saves you from casting and handling an exception.

getIdentifierCheckDigit

public ST getIdentifierCheckDigit()

Returns identifier check digit (component #11). This is a convenience method that saves you from casting and handling an exception.

getXcn11_IdentifierCheckDigit

public ST getXcn11_IdentifierCheckDigit()

Returns identifier check digit (component #11). This is a convenience method that saves you from casting and handling an exception.

getCodeIdentifyingTheCheckDigitSchemeEmployed

public ID getCodeIdentifyingTheCheckDigitSchemeEmployed()

Returns code identifying the check digit scheme employed (component #12). This is a convenience method that saves you from casting and handling an exception.

getXcn12_CodeIdentifyingTheCheckDigitSchemeEmployed

public ID getXcn12_CodeIdentifyingTheCheckDigitSchemeEmployed()

Returns code identifying the check digit scheme employed (component #12). This is a convenience method that saves you from casting and handling an exception.

getIdentifierTypeCode

public IS getIdentifierTypeCode()

Returns identifier type code (IS) (component #13). This is a convenience method that saves you from casting and handling an exception.

getXcn13_IdentifierTypeCode

public IS getXcn13_IdentifierTypeCode()

Returns identifier type code (IS) (component #13). This is a convenience method that saves you from casting and handling an exception.

getAssigningFacility

public HD getAssigningFacility()

Returns assigning facility (component #14). This is a convenience method that saves you from casting and handling an exception.

getXcn14_AssigningFacility

public HD getXcn14_AssigningFacility()

Returns assigning facility (component #14). This is a convenience method that saves you from casting and handling an exception.

getNameRepresentationCode

public ID getNameRepresentationCode()

Returns Name Representation code (component #15). This is a convenience method that saves you from casting and handling an exception.

getXcn15_NameRepresentationCode

public ID getXcn15_NameRepresentationCode()

Returns Name Representation code (component #15). This is a convenience method that saves you from casting and handling an exception.

getNameContext

public CE getNameContext()

Returns name context (component #16). This is a convenience method that saves you from casting and handling an exception.

getXcn16_NameContext

public CE getXcn16_NameContext()

Returns name context (component #16). This is a convenience method that saves you from casting and handling an exception.

getNameValidityRange

public DR getNameValidityRange()

Returns name validity range (component #17). This is a convenience method that saves you from casting and handling an exception.

getXcn17_NameValidityRange

public DR getXcn17_NameValidityRange()

Returns name validity range (component #17). This is a convenience method that saves you from casting and handling an exception.

getNameAssemblyOrder

public ID getNameAssemblyOrder()

Returns name assembly order (component #18). This is a convenience method that saves you from casting and handling an exception.

getXcn18_NameAssemblyOrder

public ID getXcn18_NameAssemblyOrder()

Returns name assembly order (component #18). This is a convenience method that saves you from casting and handling an exception.