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