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