Package ca.uhn.hl7v2.model.v251.datatype

Class PLN

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v251.datatype.PLN

All Implemented Interfaces:

Composite, Type, Visitable, Serializable

public class PLN
extends AbstractComposite

Represents an HL7 PLN (Practitioner License or Other ID Number) data type. This type consists of the following components:

• ID Number (ST)
• Type of ID Number (IS)
• State/other Qualifying Information (ST)
• Expiration Date (DT)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PLN(Message message)	Creates a new PLN 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.
DT	getExpirationDate()	Returns Expiration Date (component 4).
ST	getIDNumber()	Returns ID Number (component 1).
ST	getPln1_IDNumber()	Returns ID Number (component 1).
IS	getPln2_TypeOfIDNumber()	Returns Type of ID Number (component 2).
ST	getPln3_StateOtherQualifyingInformation()	Returns State/other Qualifying Information (component 3).
DT	getPln4_ExpirationDate()	Returns Expiration Date (component 4).
ST	getStateOtherQualifyingInformation()	Returns State/other Qualifying Information (component 3).
IS	getTypeOfIDNumber()	Returns Type of ID Number (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

PLN

public PLN(Message message)

Creates a new PLN 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 (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 (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 (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 (component 2). This is a convenience method that saves you from casting and handling an exception.

getStateOtherQualifyingInformation

public ST getStateOtherQualifyingInformation()

Returns State/other Qualifying Information (component 3). This is a convenience method that saves you from casting and handling an exception.

getPln3_StateOtherQualifyingInformation

public ST getPln3_StateOtherQualifyingInformation()

Returns State/other Qualifying Information (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.