ca.uhn.hl7v2.model.v22.datatype

Class CM_PAT_ID

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v22.datatype.CM_PAT_ID

All Implemented Interfaces:

Composite, Type, Serializable

public class CM_PAT_ID
extends AbstractComposite

Represents an HL7 CM_PAT_ID (Patient ID) data type. This type consists of the following components:

• ID number (ST)
• Check digit (NM)
• Check digit scheme (ID)
• Facility ID (ID)
• type (ID)

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
NM	getCheckDigit() Returns Check digit (component 2).
ID	getCheckDigitScheme() Returns Check digit scheme (component 3).
ST	getCm_pat_id1_IDNumber() Returns ID number (component 1).
NM	getCm_pat_id2_CheckDigit() Returns Check digit (component 2).
ID	getCm_pat_id3_CheckDigitScheme() Returns Check digit scheme (component 3).
ID	getCm_pat_id4_FacilityID() Returns Facility ID (component 4).
ID	getCm_pat_id5_Type() Returns type (component 5).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
ID	getFacilityID() Returns Facility ID (component 4).
ST	getIDNumber() Returns ID number (component 1).
ID	getType() Returns type (component 5).

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_PAT_ID

public CM_PAT_ID(Message message)

Creates a new CM_PAT_ID 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_pat_id1_IDNumber

public ST getCm_pat_id1_IDNumber()

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

getCheckDigit

public NM getCheckDigit()

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

getCm_pat_id2_CheckDigit

public NM getCm_pat_id2_CheckDigit()

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

getCheckDigitScheme

public ID getCheckDigitScheme()

Returns Check digit scheme (component 3). This is a convenience method that saves you from casting and handling an exception.

getCm_pat_id3_CheckDigitScheme

public ID getCm_pat_id3_CheckDigitScheme()

Returns Check digit scheme (component 3). This is a convenience method that saves you from casting and handling an exception.

getFacilityID

public ID getFacilityID()

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

getCm_pat_id4_FacilityID

public ID getCm_pat_id4_FacilityID()

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

getType

public ID getType()

Returns type (component 5). This is a convenience method that saves you from casting and handling an exception.

getCm_pat_id5_Type

public ID getCm_pat_id5_Type()

Returns type (component 5). This is a convenience method that saves you from casting and handling an exception.