au.gov.nehta.vendorlibrary.mdm.datatypes

Class XCN

java.lang.Object

au.gov.nehta.vendorlibrary.mdm.datatypes.XCN

public final class XCN
extends Object

XCN Encapsulates an HL7 V2 Extended Person Name XCN identifier.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XCN.Builder XCN.Builder Build class used to construct and validate an XCN object.

Method Summary

Modifier and Type	Method and Description
HD	getAssigningAuthority() Retrieve assigning authority.
String	getFamilyName() Retrieve family name.
String	getGivenName() Retrieve given name.
String	getIdentifier() Retrieve unique identifier.
String	getIdentifierTypeCode() Retrieve identifier type code.
String	getMiddleInitialOrName() Retrieve middle initial or name.
String	getPrefix() Retrieve prefix.
String	getSuffix() Retrieve suffix.
static XCN	parse(String parseValue) Parse XCN from string.
String	toString() Outputs an XCN in the following format: identifier^familyName^givenName^middleInitialOrName^^suffix^prefix^^^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 String getIdentifier()

Retrieve unique identifier.

Returns:

Unique identifier.

getFamilyName

public String getFamilyName()

Retrieve family name.

Returns:

Family name.

getGivenName

public String getGivenName()

Retrieve given name.

Returns:

Given name.

getMiddleInitialOrName

public String getMiddleInitialOrName()

Retrieve middle initial or name.

Returns:

Middle initial or name.

getSuffix

public String getSuffix()

Retrieve suffix.

Returns:

Suffix.

getPrefix

public String getPrefix()

Retrieve prefix.

Returns:

Prefix.

getAssigningAuthority

public HD getAssigningAuthority()

Retrieve assigning authority.

Returns:

Assigning authority designator.

getIdentifierTypeCode

public String getIdentifierTypeCode()

Retrieve identifier type code.

Returns:

Identifier type code.

parse

public static XCN parse(String parseValue)

Parse XCN from string.

Parameters:

parseValue - String to be parsed (not null).

Returns:

XCN

toString

public String toString()

Outputs an XCN in the following format:

identifier^familyName^givenName^middleInitialOrName^^suffix^prefix^^^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 Object

Returns:

Formatted string.