ca.uhn.hl7v2.model.v231.datatype
Class PN

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.v231.datatype.PN

All Implemented Interfaces:

Composite, Type, Serializable

public class PN
extends AbstractType
implements Composite

Represents an HL7 PN (person name) data type. This type consists of the following components:

• family+last name (FN)
• given name (ST)
• middle initial or name (ST)
• suffix (e.g., JR or III) (ST)
• prefix (e.g., DR) (ST)
• degree (e.g., MD) (IS)

See Also:

Serialized Form

Constructor Summary

PN(Message message)
Creates a new PN type

Method Summary

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 #6).
FN	getFamilyLastName() Returns family+last name (component #1).
ST	getGivenName() Returns given name (component #2).
ST	getMiddleInitialOrName() Returns middle initial or name (component #3).
FN	getPn1_FamilyLastName() Returns family+last name (component #1).
ST	getPn2_GivenName() Returns given name (component #2).
ST	getPn3_MiddleInitialOrName() Returns middle initial or name (component #3).
ST	getPn4_SuffixEgJRorIII() Returns suffix (e.g., JR or III) (component #4).
ST	getPn5_PrefixEgDR() Returns prefix (e.g., DR) (component #5).
IS	getPn6_DegreeEgMD() Returns degree (e.g., MD) (component #6).
ST	getPrefixEgDR() Returns prefix (e.g., DR) (component #5).
ST	getSuffixEgJRorIII() Returns suffix (e.g., JR or III) (component #4).

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

PN

public PN(Message message)

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

getFamilyLastName

public FN getFamilyLastName()

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

getPn1_FamilyLastName

public FN getPn1_FamilyLastName()

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

getGivenName

public ST getGivenName()

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

getPn2_GivenName

public ST getPn2_GivenName()

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

getMiddleInitialOrName

public ST getMiddleInitialOrName()

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

getPn3_MiddleInitialOrName

public ST getPn3_MiddleInitialOrName()

Returns middle initial or name (component #3). 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 #4). This is a convenience method that saves you from casting and handling an exception.

getPn4_SuffixEgJRorIII

public ST getPn4_SuffixEgJRorIII()

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

getPrefixEgDR

public ST getPrefixEgDR()

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

getPn5_PrefixEgDR

public ST getPn5_PrefixEgDR()

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

getDegreeEgMD

public IS getDegreeEgMD()

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

getPn6_DegreeEgMD

public IS getPn6_DegreeEgMD()

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