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 VXR_V03 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: MSA (MSA - message acknowledgment segment) <b> </b> </li>
51 * <li>3: QRD (QRD - original-style query definition segment) <b> </b> </li>
52 * <li>4: QRF (QRF - original style query filter segment) <b>optional </b> </li>
53 * <li>5: PID (PID - patient identification segment) <b> </b> </li>
54 * <li>6: PD1 (PD1 - patient additional demographic segment) <b>optional </b> </li>
55 * <li>7: NK1 (NK1 - next of kin / associated parties segment-) <b>optional repeating</b> </li>
56 * <li>8: VXR_V03_PV1PV2 (a Group object) <b>optional </b> </li>
57 * <li>9: VXR_V03_IN1IN2IN3 (a Group object) <b>optional repeating</b> </li>
58 * <li>10: VXR_V03_ORCRXARXROBXNTE (a Group object) <b>optional repeating</b> </li>
59 * </ul>
60 */
61 //@SuppressWarnings("unused")
62 public class VXR_V03 extends AbstractMessage {
63
64 /**
65 * Creates a new VXR_V03 message with DefaultModelClassFactory.
66 */
67 public VXR_V03() {
68 this(new DefaultModelClassFactory());
69 }
70
71 /**
72 * Creates a new VXR_V03 message with custom ModelClassFactory.
73 */
74 public VXR_V03(ModelClassFactory factory) {
75 super(factory);
76 init(factory);
77 }
78
79 private void init(ModelClassFactory factory) {
80 try {
81 this.add(MSH.class, true, false);
82 this.add(MSA.class, true, false);
83 this.add(QRD.class, true, false);
84 this.add(QRF.class, false, false);
85 this.add(PID.class, true, false);
86 this.add(PD1.class, false, false);
87 this.add(NK1.class, false, true);
88 this.add(VXR_V03_PV1PV2.class, false, false);
89 this.add(VXR_V03_IN1IN2IN3.class, false, true);
90 this.add(VXR_V03_ORCRXARXROBXNTE.class, false, true);
91 } catch(HL7Exception e) {
92 log.error("Unexpected error creating VXR_V03 - this is probably a bug in the source code generator.", e);
93 }
94 }
95
96
97 /**
98 * Returns "2.3.1"
99 */
100 public String getVersion() {
101 return "2.3.1";
102 }
103
104
105
106
107 /**
108 * <p>
109 * Returns
110 * MSH (MSH - message header segment) - creates it if necessary
111 * </p>
112 *
113 *
114 */
115 public MSH getMSH() {
116 return getTyped("MSH", MSH.class);
117 }
118
119
120
121
122
123 /**
124 * <p>
125 * Returns
126 * MSA (MSA - message acknowledgment segment) - creates it if necessary
127 * </p>
128 *
129 *
130 */
131 public MSA getMSA() {
132 return getTyped("MSA", MSA.class);
133 }
134
135
136
137
138
139 /**
140 * <p>
141 * Returns
142 * QRD (QRD - original-style query definition segment) - creates it if necessary
143 * </p>
144 *
145 *
146 */
147 public QRD getQRD() {
148 return getTyped("QRD", QRD.class);
149 }
150
151
152
153
154
155 /**
156 * <p>
157 * Returns
158 * QRF (QRF - original style query filter segment) - creates it if necessary
159 * </p>
160 *
161 *
162 */
163 public QRF getQRF() {
164 return getTyped("QRF", QRF.class);
165 }
166
167
168
169
170
171 /**
172 * <p>
173 * Returns
174 * PID (PID - patient identification segment) - creates it if necessary
175 * </p>
176 *
177 *
178 */
179 public PID getPID() {
180 return getTyped("PID", PID.class);
181 }
182
183
184
185
186
187 /**
188 * <p>
189 * Returns
190 * PD1 (PD1 - patient additional demographic segment) - creates it if necessary
191 * </p>
192 *
193 *
194 */
195 public PD1 getPD1() {
196 return getTyped("PD1", PD1.class);
197 }
198
199
200
201
202
203 /**
204 * <p>
205 * Returns
206 * the first repetition of
207 * NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary
208 * </p>
209 *
210 *
211 */
212 public NK1 getNK1() {
213 return getTyped("NK1", NK1.class);
214 }
215
216
217 /**
218 * <p>
219 * Returns a specific repetition of
220 * NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary
221 * </p>
222 *
223 *
224 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
225 * @throws HL7Exception if the repetition requested is more than one
226 * greater than the number of existing repetitions.
227 */
228 public NK1 getNK1(int rep) {
229 return getTyped("NK1", rep, NK1.class);
230 }
231
232 /**
233 * <p>
234 * Returns the number of existing repetitions of NK1
235 * </p>
236 *
237 */
238 public int getNK1Reps() {
239 return getReps("NK1");
240 }
241
242 /**
243 * <p>
244 * Returns a non-modifiable List containing all current existing repetitions of NK1.
245 * <p>
246 * <p>
247 * Note that unlike {@link #getNK1()}, this method will not create any reps
248 * if none are already present, so an empty list may be returned.
249 * </p>
250 *
251 */
252 public java.util.List<NK1> getNK1All() throws HL7Exception {
253 return getAllAsList("NK1", NK1.class);
254 }
255
256 /**
257 * <p>
258 * Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
259 * </p>
260 *
261 *
262 * @see AbstractGroup#insertRepetition(Structure, int)
263 */
264 public void insertNK1(NK1 structure, int rep) throws HL7Exception {
265 super.insertRepetition( "NK1", structure, rep);
266 }
267
268
269 /**
270 * <p>
271 * Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
272 * </p>
273 *
274 *
275 * @see AbstractGroup#insertRepetition(Structure, int)
276 */
277 public NK1 insertNK1(int rep) throws HL7Exception {
278 return (NK1)super.insertRepetition("NK1", rep);
279 }
280
281
282 /**
283 * <p>
284 * Removes a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
285 * </p>
286 *
287 *
288 * @see AbstractGroup#removeRepetition(String, int)
289 */
290 public NK1 removeNK1(int rep) throws HL7Exception {
291 return (NK1)super.removeRepetition("NK1", rep);
292 }
293
294
295
296
297 /**
298 * <p>
299 * Returns
300 * PV1PV2 (a Group object) - creates it if necessary
301 * </p>
302 *
303 *
304 */
305 public VXR_V03_PV1PV2 getPV1PV2() {
306 return getTyped("PV1PV2", VXR_V03_PV1PV2.class);
307 }
308
309
310
311
312
313 /**
314 * <p>
315 * Returns
316 * the first repetition of
317 * IN1IN2IN3 (a Group object) - creates it if necessary
318 * </p>
319 *
320 *
321 */
322 public VXR_V03_IN1IN2IN3 getIN1IN2IN3() {
323 return getTyped("IN1IN2IN3", VXR_V03_IN1IN2IN3.class);
324 }
325
326
327 /**
328 * <p>
329 * Returns a specific repetition of
330 * IN1IN2IN3 (a Group object) - creates it if necessary
331 * </p>
332 *
333 *
334 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
335 * @throws HL7Exception if the repetition requested is more than one
336 * greater than the number of existing repetitions.
337 */
338 public VXR_V03_IN1IN2IN3 getIN1IN2IN3(int rep) {
339 return getTyped("IN1IN2IN3", rep, VXR_V03_IN1IN2IN3.class);
340 }
341
342 /**
343 * <p>
344 * Returns the number of existing repetitions of IN1IN2IN3
345 * </p>
346 *
347 */
348 public int getIN1IN2IN3Reps() {
349 return getReps("IN1IN2IN3");
350 }
351
352 /**
353 * <p>
354 * Returns a non-modifiable List containing all current existing repetitions of IN1IN2IN3.
355 * <p>
356 * <p>
357 * Note that unlike {@link #getIN1IN2IN3()}, this method will not create any reps
358 * if none are already present, so an empty list may be returned.
359 * </p>
360 *
361 */
362 public java.util.List<VXR_V03_IN1IN2IN3> getIN1IN2IN3All() throws HL7Exception {
363 return getAllAsList("IN1IN2IN3", VXR_V03_IN1IN2IN3.class);
364 }
365
366 /**
367 * <p>
368 * Inserts a specific repetition of IN1IN2IN3 (a Group object)
369 * </p>
370 *
371 *
372 * @see AbstractGroup#insertRepetition(Structure, int)
373 */
374 public void insertIN1IN2IN3(VXR_V03_IN1IN2IN3 structure, int rep) throws HL7Exception {
375 super.insertRepetition( "IN1IN2IN3", structure, rep);
376 }
377
378
379 /**
380 * <p>
381 * Inserts a specific repetition of IN1IN2IN3 (a Group object)
382 * </p>
383 *
384 *
385 * @see AbstractGroup#insertRepetition(Structure, int)
386 */
387 public VXR_V03_IN1IN2IN3 insertIN1IN2IN3(int rep) throws HL7Exception {
388 return (VXR_V03_IN1IN2IN3)super.insertRepetition("IN1IN2IN3", rep);
389 }
390
391
392 /**
393 * <p>
394 * Removes a specific repetition of IN1IN2IN3 (a Group object)
395 * </p>
396 *
397 *
398 * @see AbstractGroup#removeRepetition(String, int)
399 */
400 public VXR_V03_IN1IN2IN3 removeIN1IN2IN3(int rep) throws HL7Exception {
401 return (VXR_V03_IN1IN2IN3)super.removeRepetition("IN1IN2IN3", rep);
402 }
403
404
405
406
407 /**
408 * <p>
409 * Returns
410 * the first repetition of
411 * ORCRXARXROBXNTE (a Group object) - creates it if necessary
412 * </p>
413 *
414 *
415 */
416 public VXR_V03_ORCRXARXROBXNTE getORCRXARXROBXNTE() {
417 return getTyped("ORCRXARXROBXNTE", VXR_V03_ORCRXARXROBXNTE.class);
418 }
419
420
421 /**
422 * <p>
423 * Returns a specific repetition of
424 * ORCRXARXROBXNTE (a Group object) - creates it if necessary
425 * </p>
426 *
427 *
428 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
429 * @throws HL7Exception if the repetition requested is more than one
430 * greater than the number of existing repetitions.
431 */
432 public VXR_V03_ORCRXARXROBXNTE getORCRXARXROBXNTE(int rep) {
433 return getTyped("ORCRXARXROBXNTE", rep, VXR_V03_ORCRXARXROBXNTE.class);
434 }
435
436 /**
437 * <p>
438 * Returns the number of existing repetitions of ORCRXARXROBXNTE
439 * </p>
440 *
441 */
442 public int getORCRXARXROBXNTEReps() {
443 return getReps("ORCRXARXROBXNTE");
444 }
445
446 /**
447 * <p>
448 * Returns a non-modifiable List containing all current existing repetitions of ORCRXARXROBXNTE.
449 * <p>
450 * <p>
451 * Note that unlike {@link #getORCRXARXROBXNTE()}, this method will not create any reps
452 * if none are already present, so an empty list may be returned.
453 * </p>
454 *
455 */
456 public java.util.List<VXR_V03_ORCRXARXROBXNTE> getORCRXARXROBXNTEAll() throws HL7Exception {
457 return getAllAsList("ORCRXARXROBXNTE", VXR_V03_ORCRXARXROBXNTE.class);
458 }
459
460 /**
461 * <p>
462 * Inserts a specific repetition of ORCRXARXROBXNTE (a Group object)
463 * </p>
464 *
465 *
466 * @see AbstractGroup#insertRepetition(Structure, int)
467 */
468 public void insertORCRXARXROBXNTE(VXR_V03_ORCRXARXROBXNTE structure, int rep) throws HL7Exception {
469 super.insertRepetition( "ORCRXARXROBXNTE", structure, rep);
470 }
471
472
473 /**
474 * <p>
475 * Inserts a specific repetition of ORCRXARXROBXNTE (a Group object)
476 * </p>
477 *
478 *
479 * @see AbstractGroup#insertRepetition(Structure, int)
480 */
481 public VXR_V03_ORCRXARXROBXNTE insertORCRXARXROBXNTE(int rep) throws HL7Exception {
482 return (VXR_V03_ORCRXARXROBXNTE)super.insertRepetition("ORCRXARXROBXNTE", rep);
483 }
484
485
486 /**
487 * <p>
488 * Removes a specific repetition of ORCRXARXROBXNTE (a Group object)
489 * </p>
490 *
491 *
492 * @see AbstractGroup#removeRepetition(String, int)
493 */
494 public VXR_V03_ORCRXARXROBXNTE removeORCRXARXROBXNTE(int rep) throws HL7Exception {
495 return (VXR_V03_ORCRXARXROBXNTE)super.removeRepetition("ORCRXARXROBXNTE", rep);
496 }
497
498
499
500 }
501