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

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

All Implemented Interfaces:

Composite, Type, Serializable

public class CNN
extends AbstractType
implements Composite

Represents an HL7 CNN (composite ID number and name (special DT for NDL)) data type. This type consists of the following components:

• ID number (ST) (ST)
• family name (ST)
• 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 namespace ID (IS)
• assigning authority universal ID (ST)
• assigning authority universal ID type (ID)

See Also:

Serialized Form

Constructor Summary

CNN(Message message)
Creates a new CNN type

Method Summary

IS	getAssigningAuthorityNamespaceID() Returns assigning authority namespace ID (component #9).
ST	getAssigningAuthorityUniversalID() Returns assigning authority universal ID (component #10).
ID	getAssigningAuthorityUniversalIDType() Returns assigning authority universal ID type (component #11).
ST	getCnn1_IDNumber() Returns ID number (ST) (component #1).
ST	getCnn10_AssigningAuthorityUniversalID() Returns assigning authority universal ID (component #10).
ID	getCnn11_AssigningAuthorityUniversalIDType() Returns assigning authority universal ID type (component #11).
ST	getCnn2_FamilyName() Returns family name (component #2).
ST	getCnn3_GivenName() Returns given name (component #3).
ST	getCnn4_SecondAndFurtherGivenNamesOrInitialsThereof() Returns second and further given names or initials thereof (component #4).
ST	getCnn5_SuffixEgJRorIII() Returns suffix (e.g., JR or III) (component #5).
ST	getCnn6_PrefixEgDR() Returns prefix (e.g., DR) (component #6).
IS	getCnn7_DegreeEgMD() Returns degree (e.g., MD) (component #7).
IS	getCnn8_SourceTable() Returns source table (component #8).
IS	getCnn9_AssigningAuthorityNamespaceID() Returns assigning authority namespace ID (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).
ST	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

CNN

public CNN(Message message)

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

getCnn1_IDNumber

public ST getCnn1_IDNumber()

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

getFamilyName

public ST getFamilyName()

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

getCnn2_FamilyName

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

getCnn3_GivenName

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

getCnn4_SecondAndFurtherGivenNamesOrInitialsThereof

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

getCnn5_SuffixEgJRorIII

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

getCnn6_PrefixEgDR

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

getCnn7_DegreeEgMD

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

getCnn8_SourceTable

public IS getCnn8_SourceTable()

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

getAssigningAuthorityNamespaceID

public IS getAssigningAuthorityNamespaceID()

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

getCnn9_AssigningAuthorityNamespaceID

public IS getCnn9_AssigningAuthorityNamespaceID()

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

getAssigningAuthorityUniversalID

public ST getAssigningAuthorityUniversalID()

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

getCnn10_AssigningAuthorityUniversalID

public ST getCnn10_AssigningAuthorityUniversalID()

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

getAssigningAuthorityUniversalIDType

public ID getAssigningAuthorityUniversalIDType()

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

getCnn11_AssigningAuthorityUniversalIDType

public ID getCnn11_AssigningAuthorityUniversalIDType()

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