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