ca.uhn.hl7v2.model.primitive

Class ID

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractPrimitive

ca.uhn.hl7v2.model.primitive.AbstractTextPrimitive

ca.uhn.hl7v2.model.primitive.ID

All Implemented Interfaces:

Primitive, Type, Visitable, Serializable

Direct Known Subclasses:

ID, ID, ID, ID, ID, ID, ID, ID, ID, ID, ID, ID, IDWithNamespace, SNM, SNM, SNM, SNM

public abstract class ID
extends AbstractTextPrimitive

This class contains functionality used by the ID class in the version 2.3.0, 2.3.1, 2.4, and 2.5 packages Note: The class description below has been excerpted from the Hl7 2.4 documentation. Sectional references made below also refer to the same documentation. The value of such a field follows the formatting rules for an ST field except that it is drawn from a table of legal values. There shall be an HL7 table number associated with ID data types. An example of an ID field is OBR-25-result status. This data type should be used only for HL7 tables (see Section 2.7.6, "Table"). The reverse is not true, since in some circumstances it is more appropriate to use the CE data type for HL7 tables.

Version:

$Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:51 $ by $Author: jamesagnew $

Author:

Neal Acharya, Bryan Tripp

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ID(Message theMessage)
ID(Message theMessage, int theTable)
ID(Message message, Integer theTable)

Method Summary

Modifier and Type	Method and Description
int	getTable()
void	setTable(int theTable)

Methods inherited from class ca.uhn.hl7v2.model.primitive.AbstractTextPrimitive

getValueAsHtml, getValueOrEmpty

Methods inherited from class ca.uhn.hl7v2.model.AbstractPrimitive

accept, clear, encode, getValue, isEmpty, parse, setValue, toString

Methods inherited from class ca.uhn.hl7v2.model.AbstractType

getExtraComponents, getMessage, getName, provideLocation

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

getExtraComponents, getMessage, getName

Methods inherited from interface ca.uhn.hl7v2.model.Visitable

provideLocation

Constructor Detail

ID

public ID(Message theMessage)

Parameters:

theMessage - message to which this Type belongs

ID

public ID(Message theMessage,
          int theTable)

Parameters:

theMessage - message to which this Type belongs

theTable - HL7 table from which values are to be drawn

ID

public ID(Message message,
          Integer theTable)

Parameters:

message - message to which this Type belongs

theTable - HL7 table from which values are to be drawn

Method Detail

getTable

public int getTable()

Returns:

number of HL7 table from which values should be drawn (defaults to 0)

setTable

public void setTable(int theTable)

Parameters:

theTable - HL7 table from which values are to be drawn