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.v26.group;
35
36 import ca.uhn.hl7v2.model.v26.segment.*;
37
38 import ca.uhn.hl7v2.HL7Exception;
39 import ca.uhn.hl7v2.parser.ModelClassFactory;
40 import ca.uhn.hl7v2.model.*;
41
42 /**
43 * <p>Represents a OMI_O23_ORDER group structure (a Group object).
44 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
45 * This Group contains the following elements:
46 * </p>
47 * <ul>
48 * <li>1: ORC (Common Order) <b> </b></li>
49 * <li>2: OMI_O23_TIMING (a Group object) <b>optional repeating </b></li>
50 * <li>3: OBR (Observation Request) <b> </b></li>
51 * <li>4: NTE (Notes and Comments) <b>optional repeating </b></li>
52 * <li>5: ROL (Role) <b>optional repeating </b></li>
53 * <li>6: CTD (Contact Data) <b>optional </b></li>
54 * <li>7: DG1 (Diagnosis) <b>optional repeating </b></li>
55 * <li>8: OMI_O23_OBSERVATION (a Group object) <b>optional repeating </b></li>
56 * <li>9: IPC (Imaging Procedure Control Segment) <b> repeating </b></li>
57 * </ul>
58 */
59 //@SuppressWarnings("unused")
60 public class OMI_O23_ORDER extends AbstractGroup {
61
62 /**
63 * Creates a new OMI_O23_ORDER group
64 */
65 public OMI_O23_ORDER(Group parent, ModelClassFactory factory) {
66 super(parent, factory);
67 init(factory);
68 }
69
70 private void init(ModelClassFactory factory) {
71 try {
72 this.add(ORC.class, true, false, false);
73 this.add(OMI_O23_TIMING.class, false, true, false);
74 this.add(OBR.class, true, false, false);
75 this.add(NTE.class, false, true, false);
76 this.add(ROL.class, false, true, false);
77 this.add(CTD.class, false, false, false);
78 this.add(DG1.class, false, true, false);
79 this.add(OMI_O23_OBSERVATION.class, false, true, false);
80 this.add(IPC.class, true, true, false);
81 } catch(HL7Exception e) {
82 log.error("Unexpected error creating OMI_O23_ORDER - this is probably a bug in the source code generator.", e);
83 }
84 }
85
86 /**
87 * Returns "2.6"
88 */
89 public String getVersion() {
90 return "2.6";
91 }
92
93
94
95 /**
96 * Returns
97 * ORC (Common Order) - creates it if necessary
98 */
99 public ORC getORC() {
100 ORC retVal = getTyped("ORC", ORC.class);
101 return retVal;
102 }
103
104
105
106
107 /**
108 * Returns
109 * the first repetition of
110 * TIMING (a Group object) - creates it if necessary
111 */
112 public OMI_O23_TIMING getTIMING() {
113 OMI_O23_TIMING retVal = getTyped("TIMING", OMI_O23_TIMING.class);
114 return retVal;
115 }
116
117
118 /**
119 * Returns a specific repetition of
120 * TIMING (a Group object) - creates it if necessary
121 *
122 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
123 * @throws HL7Exception if the repetition requested is more than one
124 * greater than the number of existing repetitions.
125 */
126 public OMI_O23_TIMING getTIMING(int rep) {
127 OMI_O23_TIMING retVal = getTyped("TIMING", rep, OMI_O23_TIMING.class);
128 return retVal;
129 }
130
131 /**
132 * Returns the number of existing repetitions of TIMING
133 */
134 public int getTIMINGReps() {
135 return getReps("TIMING");
136 }
137
138 /**
139 * <p>
140 * Returns a non-modifiable List containing all current existing repetitions of TIMING.
141 * <p>
142 * <p>
143 * Note that unlike {@link #getTIMING()}, this method will not create any reps
144 * if none are already present, so an empty list may be returned.
145 * </p>
146 */
147 public java.util.List<OMI_O23_TIMING> getTIMINGAll() throws HL7Exception {
148 return getAllAsList("TIMING", OMI_O23_TIMING.class);
149 }
150
151 /**
152 * Inserts a specific repetition of TIMING (a Group object)
153 * @see AbstractGroup#insertRepetition(Structure, int)
154 */
155 public void insertTIMING(OMI_O23_TIMING structure, int rep) throws HL7Exception {
156 super.insertRepetition("TIMING", structure, rep);
157 }
158
159
160 /**
161 * Inserts a specific repetition of TIMING (a Group object)
162 * @see AbstractGroup#insertRepetition(Structure, int)
163 */
164 public OMI_O23_TIMING insertTIMING(int rep) throws HL7Exception {
165 return (OMI_O23_TIMING)super.insertRepetition("TIMING", rep);
166 }
167
168
169 /**
170 * Removes a specific repetition of TIMING (a Group object)
171 * @see AbstractGroup#removeRepetition(String, int)
172 */
173 public OMI_O23_TIMING removeTIMING(int rep) throws HL7Exception {
174 return (OMI_O23_TIMING)super.removeRepetition("TIMING", rep);
175 }
176
177
178
179 /**
180 * Returns
181 * OBR (Observation Request) - creates it if necessary
182 */
183 public OBR getOBR() {
184 OBR retVal = getTyped("OBR", OBR.class);
185 return retVal;
186 }
187
188
189
190
191 /**
192 * Returns
193 * the first repetition of
194 * NTE (Notes and Comments) - creates it if necessary
195 */
196 public NTE getNTE() {
197 NTE retVal = getTyped("NTE", NTE.class);
198 return retVal;
199 }
200
201
202 /**
203 * Returns a specific repetition of
204 * NTE (Notes and Comments) - creates it if necessary
205 *
206 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
207 * @throws HL7Exception if the repetition requested is more than one
208 * greater than the number of existing repetitions.
209 */
210 public NTE getNTE(int rep) {
211 NTE retVal = getTyped("NTE", rep, NTE.class);
212 return retVal;
213 }
214
215 /**
216 * Returns the number of existing repetitions of NTE
217 */
218 public int getNTEReps() {
219 return getReps("NTE");
220 }
221
222 /**
223 * <p>
224 * Returns a non-modifiable List containing all current existing repetitions of NTE.
225 * <p>
226 * <p>
227 * Note that unlike {@link #getNTE()}, this method will not create any reps
228 * if none are already present, so an empty list may be returned.
229 * </p>
230 */
231 public java.util.List<NTE> getNTEAll() throws HL7Exception {
232 return getAllAsList("NTE", NTE.class);
233 }
234
235 /**
236 * Inserts a specific repetition of NTE (Notes and Comments)
237 * @see AbstractGroup#insertRepetition(Structure, int)
238 */
239 public void insertNTE(NTE structure, int rep) throws HL7Exception {
240 super.insertRepetition("NTE", structure, rep);
241 }
242
243
244 /**
245 * Inserts a specific repetition of NTE (Notes and Comments)
246 * @see AbstractGroup#insertRepetition(Structure, int)
247 */
248 public NTE insertNTE(int rep) throws HL7Exception {
249 return (NTE)super.insertRepetition("NTE", rep);
250 }
251
252
253 /**
254 * Removes a specific repetition of NTE (Notes and Comments)
255 * @see AbstractGroup#removeRepetition(String, int)
256 */
257 public NTE removeNTE(int rep) throws HL7Exception {
258 return (NTE)super.removeRepetition("NTE", rep);
259 }
260
261
262
263 /**
264 * Returns
265 * the first repetition of
266 * ROL (Role) - creates it if necessary
267 */
268 public ROL getROL() {
269 ROL retVal = getTyped("ROL", ROL.class);
270 return retVal;
271 }
272
273
274 /**
275 * Returns a specific repetition of
276 * ROL (Role) - creates it if necessary
277 *
278 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
279 * @throws HL7Exception if the repetition requested is more than one
280 * greater than the number of existing repetitions.
281 */
282 public ROL getROL(int rep) {
283 ROL retVal = getTyped("ROL", rep, ROL.class);
284 return retVal;
285 }
286
287 /**
288 * Returns the number of existing repetitions of ROL
289 */
290 public int getROLReps() {
291 return getReps("ROL");
292 }
293
294 /**
295 * <p>
296 * Returns a non-modifiable List containing all current existing repetitions of ROL.
297 * <p>
298 * <p>
299 * Note that unlike {@link #getROL()}, this method will not create any reps
300 * if none are already present, so an empty list may be returned.
301 * </p>
302 */
303 public java.util.List<ROL> getROLAll() throws HL7Exception {
304 return getAllAsList("ROL", ROL.class);
305 }
306
307 /**
308 * Inserts a specific repetition of ROL (Role)
309 * @see AbstractGroup#insertRepetition(Structure, int)
310 */
311 public void insertROL(ROL structure, int rep) throws HL7Exception {
312 super.insertRepetition("ROL", structure, rep);
313 }
314
315
316 /**
317 * Inserts a specific repetition of ROL (Role)
318 * @see AbstractGroup#insertRepetition(Structure, int)
319 */
320 public ROL insertROL(int rep) throws HL7Exception {
321 return (ROL)super.insertRepetition("ROL", rep);
322 }
323
324
325 /**
326 * Removes a specific repetition of ROL (Role)
327 * @see AbstractGroup#removeRepetition(String, int)
328 */
329 public ROL removeROL(int rep) throws HL7Exception {
330 return (ROL)super.removeRepetition("ROL", rep);
331 }
332
333
334
335 /**
336 * Returns
337 * CTD (Contact Data) - creates it if necessary
338 */
339 public CTD getCTD() {
340 CTD retVal = getTyped("CTD", CTD.class);
341 return retVal;
342 }
343
344
345
346
347 /**
348 * Returns
349 * the first repetition of
350 * DG1 (Diagnosis) - creates it if necessary
351 */
352 public DG1 getDG1() {
353 DG1 retVal = getTyped("DG1", DG1.class);
354 return retVal;
355 }
356
357
358 /**
359 * Returns a specific repetition of
360 * DG1 (Diagnosis) - creates it if necessary
361 *
362 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
363 * @throws HL7Exception if the repetition requested is more than one
364 * greater than the number of existing repetitions.
365 */
366 public DG1 getDG1(int rep) {
367 DG1 retVal = getTyped("DG1", rep, DG1.class);
368 return retVal;
369 }
370
371 /**
372 * Returns the number of existing repetitions of DG1
373 */
374 public int getDG1Reps() {
375 return getReps("DG1");
376 }
377
378 /**
379 * <p>
380 * Returns a non-modifiable List containing all current existing repetitions of DG1.
381 * <p>
382 * <p>
383 * Note that unlike {@link #getDG1()}, this method will not create any reps
384 * if none are already present, so an empty list may be returned.
385 * </p>
386 */
387 public java.util.List<DG1> getDG1All() throws HL7Exception {
388 return getAllAsList("DG1", DG1.class);
389 }
390
391 /**
392 * Inserts a specific repetition of DG1 (Diagnosis)
393 * @see AbstractGroup#insertRepetition(Structure, int)
394 */
395 public void insertDG1(DG1 structure, int rep) throws HL7Exception {
396 super.insertRepetition("DG1", structure, rep);
397 }
398
399
400 /**
401 * Inserts a specific repetition of DG1 (Diagnosis)
402 * @see AbstractGroup#insertRepetition(Structure, int)
403 */
404 public DG1 insertDG1(int rep) throws HL7Exception {
405 return (DG1)super.insertRepetition("DG1", rep);
406 }
407
408
409 /**
410 * Removes a specific repetition of DG1 (Diagnosis)
411 * @see AbstractGroup#removeRepetition(String, int)
412 */
413 public DG1 removeDG1(int rep) throws HL7Exception {
414 return (DG1)super.removeRepetition("DG1", rep);
415 }
416
417
418
419 /**
420 * Returns
421 * the first repetition of
422 * OBSERVATION (a Group object) - creates it if necessary
423 */
424 public OMI_O23_OBSERVATION getOBSERVATION() {
425 OMI_O23_OBSERVATION retVal = getTyped("OBSERVATION", OMI_O23_OBSERVATION.class);
426 return retVal;
427 }
428
429
430 /**
431 * Returns a specific repetition of
432 * OBSERVATION (a Group object) - creates it if necessary
433 *
434 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
435 * @throws HL7Exception if the repetition requested is more than one
436 * greater than the number of existing repetitions.
437 */
438 public OMI_O23_OBSERVATION getOBSERVATION(int rep) {
439 OMI_O23_OBSERVATION retVal = getTyped("OBSERVATION", rep, OMI_O23_OBSERVATION.class);
440 return retVal;
441 }
442
443 /**
444 * Returns the number of existing repetitions of OBSERVATION
445 */
446 public int getOBSERVATIONReps() {
447 return getReps("OBSERVATION");
448 }
449
450 /**
451 * <p>
452 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
453 * <p>
454 * <p>
455 * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
456 * if none are already present, so an empty list may be returned.
457 * </p>
458 */
459 public java.util.List<OMI_O23_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
460 return getAllAsList("OBSERVATION", OMI_O23_OBSERVATION.class);
461 }
462
463 /**
464 * Inserts a specific repetition of OBSERVATION (a Group object)
465 * @see AbstractGroup#insertRepetition(Structure, int)
466 */
467 public void insertOBSERVATION(OMI_O23_OBSERVATION structure, int rep) throws HL7Exception {
468 super.insertRepetition("OBSERVATION", structure, rep);
469 }
470
471
472 /**
473 * Inserts a specific repetition of OBSERVATION (a Group object)
474 * @see AbstractGroup#insertRepetition(Structure, int)
475 */
476 public OMI_O23_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
477 return (OMI_O23_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
478 }
479
480
481 /**
482 * Removes a specific repetition of OBSERVATION (a Group object)
483 * @see AbstractGroup#removeRepetition(String, int)
484 */
485 public OMI_O23_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
486 return (OMI_O23_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
487 }
488
489
490
491 /**
492 * Returns
493 * the first repetition of
494 * IPC (Imaging Procedure Control Segment) - creates it if necessary
495 */
496 public IPC getIPC() {
497 IPC retVal = getTyped("IPC", IPC.class);
498 return retVal;
499 }
500
501
502 /**
503 * Returns a specific repetition of
504 * IPC (Imaging Procedure Control Segment) - creates it if necessary
505 *
506 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
507 * @throws HL7Exception if the repetition requested is more than one
508 * greater than the number of existing repetitions.
509 */
510 public IPC getIPC(int rep) {
511 IPC retVal = getTyped("IPC", rep, IPC.class);
512 return retVal;
513 }
514
515 /**
516 * Returns the number of existing repetitions of IPC
517 */
518 public int getIPCReps() {
519 return getReps("IPC");
520 }
521
522 /**
523 * <p>
524 * Returns a non-modifiable List containing all current existing repetitions of IPC.
525 * <p>
526 * <p>
527 * Note that unlike {@link #getIPC()}, this method will not create any reps
528 * if none are already present, so an empty list may be returned.
529 * </p>
530 */
531 public java.util.List<IPC> getIPCAll() throws HL7Exception {
532 return getAllAsList("IPC", IPC.class);
533 }
534
535 /**
536 * Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
537 * @see AbstractGroup#insertRepetition(Structure, int)
538 */
539 public void insertIPC(IPC structure, int rep) throws HL7Exception {
540 super.insertRepetition("IPC", structure, rep);
541 }
542
543
544 /**
545 * Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
546 * @see AbstractGroup#insertRepetition(Structure, int)
547 */
548 public IPC insertIPC(int rep) throws HL7Exception {
549 return (IPC)super.insertRepetition("IPC", rep);
550 }
551
552
553 /**
554 * Removes a specific repetition of IPC (Imaging Procedure Control Segment)
555 * @see AbstractGroup#removeRepetition(String, int)
556 */
557 public IPC removeIPC(int rep) throws HL7Exception {
558 return (IPC)super.removeRepetition("IPC", rep);
559 }
560
561
562
563 }
564