ca.uhn.hl7v2.model.primitive.ID Maven / Gradle / Ivy
/**
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
* specific language governing rights and limitations under the License.
*
* The Original Code is "ID.java". Description:
* "This class contains functionality used by the ID class
* in the version 2.3.0, 2.3.1, 2.4, and 2.5 packages"
*
* The Initial Developer of the Original Code is University Health Network. Copyright (C)
* 2005. All Rights Reserved.
*
* Contributor(s): ______________________________________.
*
* Alternatively, the contents of this file may be used under the terms of the
* GNU General Public License (the "GPL"), in which case the provisions of the GPL are
* applicable instead of those above. If you wish to allow use of your version of this
* file only under the terms of the GPL and not to allow others to use your version
* of this file under the MPL, indicate your decision by deleting the provisions above
* and replace them with the notice and other provisions required by the GPL License.
* If you do not delete the provisions above, a recipient may use your version of
* this file under either the MPL or the GPL.
*
*/
package ca.uhn.hl7v2.model.primitive;
import ca.uhn.hl7v2.model.Message;
/**
* 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.
*
* @author Neal Acharya
* @author Bryan Tripp
* @version $Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:51 $ by $Author: jamesagnew $
*/
@SuppressWarnings("serial")
public abstract class ID extends AbstractTextPrimitive {
private int myTable = 0;
/**
* @param theMessage message to which this Type belongs
*/
public ID(Message theMessage) {
super(theMessage);
}
/**
* @param theMessage message to which this Type belongs
* @param theTable HL7 table from which values are to be drawn
*/
public ID(Message theMessage, int theTable) {
super(theMessage);
myTable = theTable;
}
/**
* @param message message to which this Type belongs
* @param theTable HL7 table from which values are to be drawn
*/
public ID(Message message, Integer theTable) {
super(message);
myTable = theTable;
}
/**
* @return number of HL7 table from which values should be drawn (defaults to 0)
*/
public int getTable() {
return myTable;
}
/**
* @param theTable HL7 table from which values are to be drawn
*/
public void setTable(int theTable) {
myTable = theTable;
}
}