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