ca.uhn.hl7v2.model.v22.datatype

Class CK

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v22.datatype.CK

All Implemented Interfaces:

Composite, Type, Serializable

public class CK
extends AbstractComposite

Represents an HL7 CK (CK für Patienten-IDs) data type. This type consists of the following components:

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

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
CK(Message message) Creates a new CK 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	getCk1_IDNumber() Returns ID number (component 1).
NM	getCk2_CheckDigit() Returns Check digit (component 2).
ID	getCk3_CheckDigitScheme() Returns Check digit scheme (component 3).
ID	getCk4_FacilityID() Returns Facility ID (component 4).
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).

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

CK

public CK(Message message)

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

getCk1_IDNumber

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

getCk2_CheckDigit

public NM getCk2_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.

getCk3_CheckDigitScheme

public ID getCk3_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.

getCk4_FacilityID

public ID getCk4_FacilityID()

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