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