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

Class CK

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v24.datatype.CK

All Implemented Interfaces:

Composite, Type, Visitable, Serializable

public class CK
extends AbstractComposite

Represents an HL7 CK (composite ID with check digit) data type. This type consists of the following components:

• ID number (NM) (NM)
• check digit (NM) (ST)
• code identifying the check digit scheme employed (ID)
• assigning authority (HD)

See Also:

• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
HD	getAssigningAuthority()	Returns assigning authority (component 4).
ST	getCheckDigit()	Returns check digit (NM) (component 2).
NM	getCk1_IDNumber()	Returns ID number (NM) (component 1).
ST	getCk2_CheckDigit()	Returns check digit (NM) (component 2).
ID	getCk3_CodeIdentifyingTheCheckDigitSchemeEmployed()	Returns code identifying the check digit scheme employed (component 3).
HD	getCk4_AssigningAuthority()	Returns assigning authority (component 4).
ID	getCodeIdentifyingTheCheckDigitSchemeEmployed()	Returns code identifying the check digit scheme employed (component 3).
Type	getComponent(int number)	Returns an individual data component.
Type[]	getComponents()	Returns an array containing the data elements.
NM	getIDNumber()	Returns ID number (NM) (component 1).

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

CK

public CK(Message message)

Creates a new CK 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 NM getIDNumber()

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

getCk1_IDNumber

public NM getCk1_IDNumber()

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

getCheckDigit

public ST getCheckDigit()

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

getCk2_CheckDigit

public ST getCk2_CheckDigit()

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

getCodeIdentifyingTheCheckDigitSchemeEmployed

public ID getCodeIdentifyingTheCheckDigitSchemeEmployed()

Returns code identifying the check digit scheme employed (component 3). This is a convenience method that saves you from casting and handling an exception.

getCk3_CodeIdentifyingTheCheckDigitSchemeEmployed

public ID getCk3_CodeIdentifyingTheCheckDigitSchemeEmployed()

Returns code identifying the check digit scheme employed (component 3). This is a convenience method that saves you from casting and handling an exception.

getAssigningAuthority

public HD getAssigningAuthority()

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

getCk4_AssigningAuthority

public HD getCk4_AssigningAuthority()

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