au.gov.nehta.vendorlibrary.pcehr.clients.common.type
Class XCN

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.pcehr.clients.common.type.XCN

public final class XCN
extends java.lang.Object

Encapsulates a partial implementation of an HL7 V2 Extended Person Name XCN identifier.


Nested Class Summary
static class XCN.Builder
          XCN.Builder Build class used to construct and validate an XCN object.
 
Method Summary
 HD getAssigningAuthority()
          Retrieve assigning authority.
 java.lang.String getFamilyName()
          Retrieve family name.
 java.lang.String getGivenName()
          Retrieve given name.
 java.lang.String getIdentifier()
          Retrieve unique identifier.
 java.lang.String getMiddleInitialOrName()
          Retrieve middle initial or name.
 java.lang.String getPrefix()
          Retrieve prefix.
 java.lang.String getSuffix()
          Retrieve suffix.
 java.lang.String toString()
          Outputs an XCN in the following format:

identifier^familyName^givenName^middleInitialOrName^^suffix^pefix^^^assigningAuthority

Variables that are not set are denoted by an empty string.

 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getIdentifier

public java.lang.String getIdentifier()
Retrieve unique identifier.

Returns:
Unique identifier.

getFamilyName

public java.lang.String getFamilyName()
Retrieve family name.

Returns:
Family name.

getGivenName

public java.lang.String getGivenName()
Retrieve given name.

Returns:
Given name.

getMiddleInitialOrName

public java.lang.String getMiddleInitialOrName()
Retrieve middle initial or name.

Returns:
Middle initial or name.

getSuffix

public java.lang.String getSuffix()
Retrieve suffix.

Returns:
Suffix.

getPrefix

public java.lang.String getPrefix()
Retrieve prefix.

Returns:
Prefix.

getAssigningAuthority

public HD getAssigningAuthority()
Retrieve assigning authority.

Returns:
Assigning authority designator.

toString

public java.lang.String toString()
Outputs an XCN in the following format:

identifier^familyName^givenName^middleInitialOrName^^suffix^pefix^^^assigningAuthority

Variables that are not set are denoted by an empty string.

Trailing '^' symbols are trimmed. For example:

'identifier^familyName^^^^^^^' becomes 'identifier^familyName'

Overrides:
toString in class java.lang.Object
Returns:
Formatted string.