View Javadoc

1   /**
2    * The contents of this file are subject to the Mozilla Public License Version 1.1
3    * (the "License"); you may not use this file except in compliance with the License.
4    * You may obtain a copy of the License at http://www.mozilla.org/MPL/
5    * Software distributed under the License is distributed on an "AS IS" basis,
6    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
7    * specific language governing rights and limitations under the License.
8    *
9    * The Original Code is "TM.java".  Description:
10   * "Note: The class description below has been excerpted from the Hl7 2.4 documentation"
11   *
12   * The Initial Developer of the Original Code is University Health Network. Copyright (C)
13   * 2001.  All Rights Reserved.
14   *
15   * Contributor(s): ______________________________________.
16   *
17   * Alternatively, the contents of this file may be used under the terms of the
18   * GNU General Public License (the "GPL"), in which case the provisions of the GPL are
19   * applicable instead of those above.  If you wish to allow use of your version of this
20   * file only under the terms of the GPL and not to allow others to use your version
21   * of this file under the MPL, indicate your decision by deleting  the provisions above
22   * and replace  them with the notice and other provisions required by the GPL License.
23   * If you do not delete the provisions above, a recipient may use your version of
24   * this file under either the MPL or the GPL.
25   *
26   */
27  
28  package ca.uhn.hl7v2.model.v24.datatype;
29  
30  import ca.uhn.hl7v2.model.Message;
31  
32  /**
33   * Note: The class description below has been excerpted from the Hl7 2.4 documentation. Sectional
34   * references made below also refer to the same documentation.
35   *
36   * Format: HH[MM[SS[.S[S[S[S]]]]]][+/-ZZZZ]
37   * In prior versions of HL7, this data type was always specified to be in the
38   * format HHMM[SS[.SSSS]][+/-ZZZZ] using a 24 hour clock notation. In the
39   * current and future versions, the precision of a time may be expressed by
40   * limiting the number of digits used with the format specification as shown
41   * above. By site-specific agreement, HHMM[SS[.SSSS]][+/-ZZZZ] may be used where
42   * backward compatibility must be maintained.
43   * Thus, HH is used to specify a precision of "hour," HHMM is used to specify a
44   * precision of "minute," HHMMSS is used to specify a precision of seconds, and
45   * HHMMSS.SSSS is used to specify a precision of ten-thousandths of a second.
46   * In each of these cases, the time zone is an optional component. The fractional
47   * seconds could be sent by a transmitter who requires greater precision than whole
48   * seconds. Fractional representations of minutes, hours or other higher-order units
49   * of time are not permitted.
50   * Note: The time zone [+/-ZZZZ], when used, is restricted to legally-defined time zones
51   * and is represented in HHMM format.
52   * The time zone of the sender may be sent optionally as an offset from the coordinated
53   * universal time (previously known as Greenwich Mean Time). Where the time zone
54   * is not present in a particular TM field but is included as part of the date/time
55   * field in the MSH segment, the MSH value will be used as the default time zone.
56   * Otherwise, the time is understood to refer to the local time of the sender.
57   * Midnight is represented as 0000.
58   * Examples:|235959+1100| 1 second before midnight in a time zone eleven hours
59   * ahead of Universal Coordinated Time (i.e., east of Greenwich).
60   * |0800| Eight AM, local time of the sender.
61   * |093544.2312| 44.2312 seconds after Nine thirty-five AM, local time of sender.
62   * |13| 1pm (with a precision of hours), local time of sender.
63   * @author Neal Acharya
64   */
65  
66  public class TM extends ca.uhn.hl7v2.model.primitive.TM {
67      
68      /**
69       * @param theMessage message to which this Type belongs
70       */
71      public TM(Message theMessage) {
72          super(theMessage);
73      }
74  
75      /**
76       * @return "2.4"
77       */
78      public String getVersion() {
79          return "2.4";
80      }
81  }