ca.uhn.hl7v2.model.v23.datatype

Class CM_PLN

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v23.datatype.CM_PLN

All Implemented Interfaces:

Composite, Type, Serializable

public class CM_PLN
extends AbstractComposite

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

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

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
CM_PLN(Message message) Creates a new CM_PLN type

Method Summary

Methods

Modifier and Type	Method and Description
ST	getCm_pln1_IDNumber() Returns ID number (component 1).
IS	getCm_pln2_TypeOfIDNumber() Returns type of ID number (IS) (component 2).
ST	getCm_pln3_StateOtherQualifyingInfo() Returns state/other qualifying info (component 3).
DT	getCm_pln4_ExpirationDate() Returns expiration date (component 4).
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	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.AbstractComposite

clear, getTyped

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 Detail

CM_PLN

public CM_PLN(Message message)

Creates a new CM_PLN type

Method Detail

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.

getCm_pln1_IDNumber

public ST getCm_pln1_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 (IS) (component 2). This is a convenience method that saves you from casting and handling an exception.

getCm_pln2_TypeOfIDNumber

public IS getCm_pln2_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.

getCm_pln3_StateOtherQualifyingInfo

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

getCm_pln4_ExpirationDate

public DT getCm_pln4_ExpirationDate()

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