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

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

All Implemented Interfaces:

Composite, Type, Serializable

public class PLN
extends AbstractType
implements Composite

Represents an HL7 PLN (Practitioner ID Numbers) data type. This type consists of the following components:

• ID number (ST) (ST)
• type of ID number (IS) (IS)
• state/other qualifying info (ST)
• expiration date (DT)

See Also:

Serialized Form

Constructor Summary

PLN(Message message)
Creates a new PLN type

Method Summary

Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
DT	getExpirationDate() Returns expiration date (component #4).
ST	getIDNumber() Returns ID number (ST) (component #1).
ST	getPln1_IDNumber() Returns ID number (ST) (component #1).
IS	getPln2_TypeOfIDNumber() Returns type of ID number (IS) (component #2).
ST	getPln3_StateOtherQualifyingInfo() Returns state/other qualifying info (component #3).
DT	getPln4_ExpirationDate() Returns expiration date (component #4).
ST	getStateOtherQualifyingInfo() Returns state/other qualifying info (component #3).
IS	getTypeOfIDNumber() Returns type of ID number (IS) (component #2).

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

PLN

public PLN(Message message)

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

getPln1_IDNumber

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

getPln2_TypeOfIDNumber

public IS getPln2_TypeOfIDNumber()

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

getStateOtherQualifyingInfo

public ST getStateOtherQualifyingInfo()

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

getPln3_StateOtherQualifyingInfo

public ST getPln3_StateOtherQualifyingInfo()

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

getExpirationDate

public DT getExpirationDate()

Returns expiration date (component #4). This is a convenience method that saves you from casting and handling an exception.

getPln4_ExpirationDate

public DT getPln4_ExpirationDate()

Returns expiration date (component #4). This is a convenience method that saves you from casting and handling an exception.