Package ca.uhn.hl7v2.model.v24.datatype

Class PI

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v24.datatype.PI

All Implemented Interfaces:

Composite, Type, Visitable, Serializable

public class PI
extends AbstractComposite

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

• ID number (ST) (ST)
• type of ID number (IS) (IS)
• other qualifying info (ST)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PI(Message message)	Creates a new PI type

Method Summary

Modifier and Type	Method	Description
Type	getComponent(int number)	Returns an individual data component.
Type[]	getComponents()	Returns an array containing the data elements.
ST	getIDNumber()	Returns ID number (ST) (component 1).
ST	getOtherQualifyingInfo()	Returns other qualifying info (component 3).
ST	getPi1_IDNumber()	Returns ID number (ST) (component 1).
IS	getPi2_TypeOfIDNumber()	Returns type of ID number (IS) (component 2).
ST	getPi3_OtherQualifyingInfo()	Returns other qualifying info (component 3).
IS	getTypeOfIDNumber()	Returns type of ID number (IS) (component 2).

Methods inherited from class ca.uhn.hl7v2.model.AbstractComposite

accept, clear, getTyped, isEmpty, provideLocation

Methods inherited from class ca.uhn.hl7v2.model.AbstractType

encode, getExtraComponents, getMessage, getName, parse, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Type

encode, getExtraComponents, getMessage, getName, parse

Constructor Details

PI

public PI(Message message)

Creates a new PI type

Method Details

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

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.

getPi1_IDNumber

public ST getPi1_IDNumber()

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

getTypeOfIDNumber

public IS getTypeOfIDNumber()

Returns type of ID number (IS) (component 2). This is a convenience method that saves you from casting and handling an exception.

getPi2_TypeOfIDNumber

public IS getPi2_TypeOfIDNumber()

Returns type of ID number (IS) (component 2). This is a convenience method that saves you from casting and handling an exception.

getOtherQualifyingInfo

public ST getOtherQualifyingInfo()

Returns other qualifying info (component 3). This is a convenience method that saves you from casting and handling an exception.

getPi3_OtherQualifyingInfo

public ST getPi3_OtherQualifyingInfo()

Returns other qualifying info (component 3). This is a convenience method that saves you from casting and handling an exception.