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