1 /*
2 * This class is an auto-generated source file for a HAPI
3 * HL7 v2.x standard structure class.
4 *
5 * For more information, visit: http://hl7api.sourceforge.net/
6 *
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * (the "License"); you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
12 * specific language governing rights and limitations under the License.
13 *
14 * The Original Code is "[file_name]". Description:
15 * "[one_line_description]"
16 *
17 * The Initial Developer of the Original Code is University Health Network. Copyright (C)
18 * 2012. All Rights Reserved.
19 *
20 * Contributor(s): ______________________________________.
21 *
22 * Alternatively, the contents of this file may be used under the terms of the
23 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are
24 * applicable instead of those above. If you wish to allow use of your version of this
25 * file only under the terms of the GPL and not to allow others to use your version
26 * of this file under the MPL, indicate your decision by deleting the provisions above
27 * and replace them with the notice and other provisions required by the GPL License.
28 * If you do not delete the provisions above, a recipient may use your version of
29 * this file under either the MPL or the GPL.
30 *
31 */
32
33
34 package ca.uhn.hl7v2.model.v231.message;
35
36 import ca.uhn.hl7v2.model.v231.group.*;
37 import ca.uhn.hl7v2.model.v231.segment.*;
38
39 import ca.uhn.hl7v2.HL7Exception;
40 import ca.uhn.hl7v2.parser.ModelClassFactory;
41 import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
42 import ca.uhn.hl7v2.model.*;
43
44
45 /**
46 * <p>Represents a MDM_T02 message structure (see chapter ?). This structure contains the
47 * following elements: </p>
48 * <ul>
49 * <li>1: MSH (MSH - message header segment) <b> </b> </li>
50 * <li>2: EVN (EVN - event type segment) <b> </b> </li>
51 * <li>3: PID (PID - patient identification segment) <b> </b> </li>
52 * <li>4: PV1 (PV1 - patient visit segment-) <b> </b> </li>
53 * <li>5: TXA (Document notification segment) <b> </b> </li>
54 * <li>6: OBX (OBX - observation/result segment) <b> repeating</b> </li>
55 * </ul>
56 */
57 //@SuppressWarnings("unused")
58 public class MDM_T02 extends AbstractMessage {
59
60 /**
61 * Creates a new MDM_T02 message with DefaultModelClassFactory.
62 */
63 public MDM_T02() {
64 this(new DefaultModelClassFactory());
65 }
66
67 /**
68 * Creates a new MDM_T02 message with custom ModelClassFactory.
69 */
70 public MDM_T02(ModelClassFactory factory) {
71 super(factory);
72 init(factory);
73 }
74
75 private void init(ModelClassFactory factory) {
76 try {
77 this.add(MSH.class, true, false);
78 this.add(EVN.class, true, false);
79 this.add(PID.class, true, false);
80 this.add(PV1.class, true, false);
81 this.add(TXA.class, true, false);
82 this.add(OBX.class, true, true);
83 } catch(HL7Exception e) {
84 log.error("Unexpected error creating MDM_T02 - this is probably a bug in the source code generator.", e);
85 }
86 }
87
88
89 /**
90 * Returns "2.3.1"
91 */
92 public String getVersion() {
93 return "2.3.1";
94 }
95
96
97
98
99 /**
100 * <p>
101 * Returns
102 * MSH (MSH - message header segment) - creates it if necessary
103 * </p>
104 *
105 *
106 */
107 public MSH getMSH() {
108 return getTyped("MSH", MSH.class);
109 }
110
111
112
113
114
115 /**
116 * <p>
117 * Returns
118 * EVN (EVN - event type segment) - creates it if necessary
119 * </p>
120 *
121 *
122 */
123 public EVN getEVN() {
124 return getTyped("EVN", EVN.class);
125 }
126
127
128
129
130
131 /**
132 * <p>
133 * Returns
134 * PID (PID - patient identification segment) - creates it if necessary
135 * </p>
136 *
137 *
138 */
139 public PID getPID() {
140 return getTyped("PID", PID.class);
141 }
142
143
144
145
146
147 /**
148 * <p>
149 * Returns
150 * PV1 (PV1 - patient visit segment-) - creates it if necessary
151 * </p>
152 *
153 *
154 */
155 public PV1 getPV1() {
156 return getTyped("PV1", PV1.class);
157 }
158
159
160
161
162
163 /**
164 * <p>
165 * Returns
166 * TXA (Document notification segment) - creates it if necessary
167 * </p>
168 *
169 *
170 */
171 public TXA getTXA() {
172 return getTyped("TXA", TXA.class);
173 }
174
175
176
177
178
179 /**
180 * <p>
181 * Returns
182 * the first repetition of
183 * OBX (OBX - observation/result segment) - creates it if necessary
184 * </p>
185 *
186 *
187 */
188 public OBX getOBX() {
189 return getTyped("OBX", OBX.class);
190 }
191
192
193 /**
194 * <p>
195 * Returns a specific repetition of
196 * OBX (OBX - observation/result segment) - creates it if necessary
197 * </p>
198 *
199 *
200 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
201 * @throws HL7Exception if the repetition requested is more than one
202 * greater than the number of existing repetitions.
203 */
204 public OBX getOBX(int rep) {
205 return getTyped("OBX", rep, OBX.class);
206 }
207
208 /**
209 * <p>
210 * Returns the number of existing repetitions of OBX
211 * </p>
212 *
213 */
214 public int getOBXReps() {
215 return getReps("OBX");
216 }
217
218 /**
219 * <p>
220 * Returns a non-modifiable List containing all current existing repetitions of OBX.
221 * <p>
222 * <p>
223 * Note that unlike {@link #getOBX()}, this method will not create any reps
224 * if none are already present, so an empty list may be returned.
225 * </p>
226 *
227 */
228 public java.util.List<OBX> getOBXAll() throws HL7Exception {
229 return getAllAsList("OBX", OBX.class);
230 }
231
232 /**
233 * <p>
234 * Inserts a specific repetition of OBX (OBX - observation/result segment)
235 * </p>
236 *
237 *
238 * @see AbstractGroup#insertRepetition(Structure, int)
239 */
240 public void insertOBX(OBX structure, int rep) throws HL7Exception {
241 super.insertRepetition( "OBX", structure, rep);
242 }
243
244
245 /**
246 * <p>
247 * Inserts a specific repetition of OBX (OBX - observation/result segment)
248 * </p>
249 *
250 *
251 * @see AbstractGroup#insertRepetition(Structure, int)
252 */
253 public OBX insertOBX(int rep) throws HL7Exception {
254 return (OBX)super.insertRepetition("OBX", rep);
255 }
256
257
258 /**
259 * <p>
260 * Removes a specific repetition of OBX (OBX - observation/result segment)
261 * </p>
262 *
263 *
264 * @see AbstractGroup#removeRepetition(String, int)
265 */
266 public OBX removeOBX(int rep) throws HL7Exception {
267 return (OBX)super.removeRepetition("OBX", rep);
268 }
269
270
271
272 }
273