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