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

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

All Implemented Interfaces:

Composite, Type, Serializable

public class CN
extends AbstractType
implements Composite

Represents an HL7 CN (composite ID number and name) 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)

See Also:

Serialized Form

Constructor Summary

CN(Message message)
Creates a new CN type

Method Summary

HD	getAssigningAuthority() Returns assigning authority (component #9).
ST	getCn1_IDNumber() Returns ID number (ST) (component #1).
FN	getCn2_FamilyName() Returns family name (component #2).
ST	getCn3_GivenName() Returns given name (component #3).
ST	getCn4_SecondAndFurtherGivenNamesOrInitialsThereof() Returns second and further given names or initials thereof (component #4).
ST	getCn5_SuffixEgJRorIII() Returns suffix (e.g., JR or III) (component #5).
ST	getCn6_PrefixEgDR() Returns prefix (e.g., DR) (component #6).
IS	getCn7_DegreeEgMD() Returns degree (e.g., MD) (component #7).
IS	getCn8_SourceTable() Returns source table (component #8).
HD	getCn9_AssigningAuthority() Returns assigning authority (component #9).
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	getIDNumber() Returns ID number (ST) (component #1).
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).

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

CN

public CN(Message message)

Creates a new CN 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.

getCn1_IDNumber

public ST getCn1_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.

getCn2_FamilyName

public FN getCn2_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.

getCn3_GivenName

public ST getCn3_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.

getCn4_SecondAndFurtherGivenNamesOrInitialsThereof

public ST getCn4_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.

getCn5_SuffixEgJRorIII

public ST getCn5_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.

getCn6_PrefixEgDR

public ST getCn6_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.

getCn7_DegreeEgMD

public IS getCn7_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.

getCn8_SourceTable

public IS getCn8_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.

getCn9_AssigningAuthority

public HD getCn9_AssigningAuthority()

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