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 PMU_B01 message structure (see chapter 15). This structure contains the
47 * following elements: </p>
48 * <ul>
49 * <li>1: MSH (Message Header) <b> </b> </li>
50 * <li>2: EVN (Event Type) <b> </b> </li>
51 * <li>3: STF (Staff Identification) <b> </b> </li>
52 * <li>4: PRA (Practitioner Detail) <b>optional repeating</b> </li>
53 * <li>5: ORG (Practitioner Organization Unit) <b>optional repeating</b> </li>
54 * <li>6: AFF (Professional Affiliation) <b>optional repeating</b> </li>
55 * <li>7: LAN (Language Detail) <b>optional repeating</b> </li>
56 * <li>8: EDU (Educational Detail) <b>optional repeating</b> </li>
57 * </ul>
58 */
59 //@SuppressWarnings("unused")
60 public class PMU_B01 extends AbstractMessage {
61
62 /**
63 * Creates a new PMU_B01 message with DefaultModelClassFactory.
64 */
65 public PMU_B01() {
66 this(new DefaultModelClassFactory());
67 }
68
69 /**
70 * Creates a new PMU_B01 message with custom ModelClassFactory.
71 */
72 public PMU_B01(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(EVN.class, true, false);
81 this.add(STF.class, true, false);
82 this.add(PRA.class, false, true);
83 this.add(ORG.class, false, true);
84 this.add(AFF.class, false, true);
85 this.add(LAN.class, false, true);
86 this.add(EDU.class, false, true);
87 } catch(HL7Exception e) {
88 log.error("Unexpected error creating PMU_B01 - 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 * EVN (Event Type) - creates it if necessary
123 * </p>
124 *
125 *
126 */
127 public EVN getEVN() {
128 return getTyped("EVN", EVN.class);
129 }
130
131
132
133
134
135 /**
136 * <p>
137 * Returns
138 * STF (Staff Identification) - creates it if necessary
139 * </p>
140 *
141 *
142 */
143 public STF getSTF() {
144 return getTyped("STF", STF.class);
145 }
146
147
148
149
150
151 /**
152 * <p>
153 * Returns
154 * the first repetition of
155 * PRA (Practitioner Detail) - creates it if necessary
156 * </p>
157 *
158 *
159 */
160 public PRA getPRA() {
161 return getTyped("PRA", PRA.class);
162 }
163
164
165 /**
166 * <p>
167 * Returns a specific repetition of
168 * PRA (Practitioner Detail) - 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 PRA getPRA(int rep) {
177 return getTyped("PRA", rep, PRA.class);
178 }
179
180 /**
181 * <p>
182 * Returns the number of existing repetitions of PRA
183 * </p>
184 *
185 */
186 public int getPRAReps() {
187 return getReps("PRA");
188 }
189
190 /**
191 * <p>
192 * Returns a non-modifiable List containing all current existing repetitions of PRA.
193 * <p>
194 * <p>
195 * Note that unlike {@link #getPRA()}, 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<PRA> getPRAAll() throws HL7Exception {
201 return getAllAsList("PRA", PRA.class);
202 }
203
204 /**
205 * <p>
206 * Inserts a specific repetition of PRA (Practitioner Detail)
207 * </p>
208 *
209 *
210 * @see AbstractGroup#insertRepetition(Structure, int)
211 */
212 public void insertPRA(PRA structure, int rep) throws HL7Exception {
213 super.insertRepetition( "PRA", structure, rep);
214 }
215
216
217 /**
218 * <p>
219 * Inserts a specific repetition of PRA (Practitioner Detail)
220 * </p>
221 *
222 *
223 * @see AbstractGroup#insertRepetition(Structure, int)
224 */
225 public PRA insertPRA(int rep) throws HL7Exception {
226 return (PRA)super.insertRepetition("PRA", rep);
227 }
228
229
230 /**
231 * <p>
232 * Removes a specific repetition of PRA (Practitioner Detail)
233 * </p>
234 *
235 *
236 * @see AbstractGroup#removeRepetition(String, int)
237 */
238 public PRA removePRA(int rep) throws HL7Exception {
239 return (PRA)super.removeRepetition("PRA", rep);
240 }
241
242
243
244
245 /**
246 * <p>
247 * Returns
248 * the first repetition of
249 * ORG (Practitioner Organization Unit) - creates it if necessary
250 * </p>
251 *
252 *
253 */
254 public ORG getORG() {
255 return getTyped("ORG", ORG.class);
256 }
257
258
259 /**
260 * <p>
261 * Returns a specific repetition of
262 * ORG (Practitioner Organization Unit) - creates it if necessary
263 * </p>
264 *
265 *
266 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
267 * @throws HL7Exception if the repetition requested is more than one
268 * greater than the number of existing repetitions.
269 */
270 public ORG getORG(int rep) {
271 return getTyped("ORG", rep, ORG.class);
272 }
273
274 /**
275 * <p>
276 * Returns the number of existing repetitions of ORG
277 * </p>
278 *
279 */
280 public int getORGReps() {
281 return getReps("ORG");
282 }
283
284 /**
285 * <p>
286 * Returns a non-modifiable List containing all current existing repetitions of ORG.
287 * <p>
288 * <p>
289 * Note that unlike {@link #getORG()}, this method will not create any reps
290 * if none are already present, so an empty list may be returned.
291 * </p>
292 *
293 */
294 public java.util.List<ORG> getORGAll() throws HL7Exception {
295 return getAllAsList("ORG", ORG.class);
296 }
297
298 /**
299 * <p>
300 * Inserts a specific repetition of ORG (Practitioner Organization Unit)
301 * </p>
302 *
303 *
304 * @see AbstractGroup#insertRepetition(Structure, int)
305 */
306 public void insertORG(ORG structure, int rep) throws HL7Exception {
307 super.insertRepetition( "ORG", structure, rep);
308 }
309
310
311 /**
312 * <p>
313 * Inserts a specific repetition of ORG (Practitioner Organization Unit)
314 * </p>
315 *
316 *
317 * @see AbstractGroup#insertRepetition(Structure, int)
318 */
319 public ORG insertORG(int rep) throws HL7Exception {
320 return (ORG)super.insertRepetition("ORG", rep);
321 }
322
323
324 /**
325 * <p>
326 * Removes a specific repetition of ORG (Practitioner Organization Unit)
327 * </p>
328 *
329 *
330 * @see AbstractGroup#removeRepetition(String, int)
331 */
332 public ORG removeORG(int rep) throws HL7Exception {
333 return (ORG)super.removeRepetition("ORG", rep);
334 }
335
336
337
338
339 /**
340 * <p>
341 * Returns
342 * the first repetition of
343 * AFF (Professional Affiliation) - creates it if necessary
344 * </p>
345 *
346 *
347 */
348 public AFF getAFF() {
349 return getTyped("AFF", AFF.class);
350 }
351
352
353 /**
354 * <p>
355 * Returns a specific repetition of
356 * AFF (Professional Affiliation) - creates it if necessary
357 * </p>
358 *
359 *
360 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
361 * @throws HL7Exception if the repetition requested is more than one
362 * greater than the number of existing repetitions.
363 */
364 public AFF getAFF(int rep) {
365 return getTyped("AFF", rep, AFF.class);
366 }
367
368 /**
369 * <p>
370 * Returns the number of existing repetitions of AFF
371 * </p>
372 *
373 */
374 public int getAFFReps() {
375 return getReps("AFF");
376 }
377
378 /**
379 * <p>
380 * Returns a non-modifiable List containing all current existing repetitions of AFF.
381 * <p>
382 * <p>
383 * Note that unlike {@link #getAFF()}, this method will not create any reps
384 * if none are already present, so an empty list may be returned.
385 * </p>
386 *
387 */
388 public java.util.List<AFF> getAFFAll() throws HL7Exception {
389 return getAllAsList("AFF", AFF.class);
390 }
391
392 /**
393 * <p>
394 * Inserts a specific repetition of AFF (Professional Affiliation)
395 * </p>
396 *
397 *
398 * @see AbstractGroup#insertRepetition(Structure, int)
399 */
400 public void insertAFF(AFF structure, int rep) throws HL7Exception {
401 super.insertRepetition( "AFF", structure, rep);
402 }
403
404
405 /**
406 * <p>
407 * Inserts a specific repetition of AFF (Professional Affiliation)
408 * </p>
409 *
410 *
411 * @see AbstractGroup#insertRepetition(Structure, int)
412 */
413 public AFF insertAFF(int rep) throws HL7Exception {
414 return (AFF)super.insertRepetition("AFF", rep);
415 }
416
417
418 /**
419 * <p>
420 * Removes a specific repetition of AFF (Professional Affiliation)
421 * </p>
422 *
423 *
424 * @see AbstractGroup#removeRepetition(String, int)
425 */
426 public AFF removeAFF(int rep) throws HL7Exception {
427 return (AFF)super.removeRepetition("AFF", rep);
428 }
429
430
431
432
433 /**
434 * <p>
435 * Returns
436 * the first repetition of
437 * LAN (Language Detail) - creates it if necessary
438 * </p>
439 *
440 *
441 */
442 public LAN getLAN() {
443 return getTyped("LAN", LAN.class);
444 }
445
446
447 /**
448 * <p>
449 * Returns a specific repetition of
450 * LAN (Language Detail) - creates it if necessary
451 * </p>
452 *
453 *
454 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
455 * @throws HL7Exception if the repetition requested is more than one
456 * greater than the number of existing repetitions.
457 */
458 public LAN getLAN(int rep) {
459 return getTyped("LAN", rep, LAN.class);
460 }
461
462 /**
463 * <p>
464 * Returns the number of existing repetitions of LAN
465 * </p>
466 *
467 */
468 public int getLANReps() {
469 return getReps("LAN");
470 }
471
472 /**
473 * <p>
474 * Returns a non-modifiable List containing all current existing repetitions of LAN.
475 * <p>
476 * <p>
477 * Note that unlike {@link #getLAN()}, this method will not create any reps
478 * if none are already present, so an empty list may be returned.
479 * </p>
480 *
481 */
482 public java.util.List<LAN> getLANAll() throws HL7Exception {
483 return getAllAsList("LAN", LAN.class);
484 }
485
486 /**
487 * <p>
488 * Inserts a specific repetition of LAN (Language Detail)
489 * </p>
490 *
491 *
492 * @see AbstractGroup#insertRepetition(Structure, int)
493 */
494 public void insertLAN(LAN structure, int rep) throws HL7Exception {
495 super.insertRepetition( "LAN", structure, rep);
496 }
497
498
499 /**
500 * <p>
501 * Inserts a specific repetition of LAN (Language Detail)
502 * </p>
503 *
504 *
505 * @see AbstractGroup#insertRepetition(Structure, int)
506 */
507 public LAN insertLAN(int rep) throws HL7Exception {
508 return (LAN)super.insertRepetition("LAN", rep);
509 }
510
511
512 /**
513 * <p>
514 * Removes a specific repetition of LAN (Language Detail)
515 * </p>
516 *
517 *
518 * @see AbstractGroup#removeRepetition(String, int)
519 */
520 public LAN removeLAN(int rep) throws HL7Exception {
521 return (LAN)super.removeRepetition("LAN", rep);
522 }
523
524
525
526
527 /**
528 * <p>
529 * Returns
530 * the first repetition of
531 * EDU (Educational Detail) - creates it if necessary
532 * </p>
533 *
534 *
535 */
536 public EDU getEDU() {
537 return getTyped("EDU", EDU.class);
538 }
539
540
541 /**
542 * <p>
543 * Returns a specific repetition of
544 * EDU (Educational Detail) - creates it if necessary
545 * </p>
546 *
547 *
548 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
549 * @throws HL7Exception if the repetition requested is more than one
550 * greater than the number of existing repetitions.
551 */
552 public EDU getEDU(int rep) {
553 return getTyped("EDU", rep, EDU.class);
554 }
555
556 /**
557 * <p>
558 * Returns the number of existing repetitions of EDU
559 * </p>
560 *
561 */
562 public int getEDUReps() {
563 return getReps("EDU");
564 }
565
566 /**
567 * <p>
568 * Returns a non-modifiable List containing all current existing repetitions of EDU.
569 * <p>
570 * <p>
571 * Note that unlike {@link #getEDU()}, this method will not create any reps
572 * if none are already present, so an empty list may be returned.
573 * </p>
574 *
575 */
576 public java.util.List<EDU> getEDUAll() throws HL7Exception {
577 return getAllAsList("EDU", EDU.class);
578 }
579
580 /**
581 * <p>
582 * Inserts a specific repetition of EDU (Educational Detail)
583 * </p>
584 *
585 *
586 * @see AbstractGroup#insertRepetition(Structure, int)
587 */
588 public void insertEDU(EDU structure, int rep) throws HL7Exception {
589 super.insertRepetition( "EDU", structure, rep);
590 }
591
592
593 /**
594 * <p>
595 * Inserts a specific repetition of EDU (Educational Detail)
596 * </p>
597 *
598 *
599 * @see AbstractGroup#insertRepetition(Structure, int)
600 */
601 public EDU insertEDU(int rep) throws HL7Exception {
602 return (EDU)super.insertRepetition("EDU", rep);
603 }
604
605
606 /**
607 * <p>
608 * Removes a specific repetition of EDU (Educational Detail)
609 * </p>
610 *
611 *
612 * @see AbstractGroup#removeRepetition(String, int)
613 */
614 public EDU removeEDU(int rep) throws HL7Exception {
615 return (EDU)super.removeRepetition("EDU", rep);
616 }
617
618
619
620 }
621