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_A37 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>optional </b> </li>
54 * <li>6: DB1 (Disability) <b>optional repeating</b> </li>
55 * <li>7: PID (Patient identification) <b> </b> </li>
56 * <li>8: PD1 (patient additional demographic) <b>optional </b> </li>
57 * <li>9: PV1 (Patient visit) <b>optional </b> </li>
58 * <li>10: DB1 (Disability) <b>optional repeating</b> </li>
59 * </ul>
60 */
61 //@SuppressWarnings("unused")
62 public class ADT_A37 extends AbstractMessage {
63
64 /**
65 * Creates a new ADT_A37 message with DefaultModelClassFactory.
66 */
67 public ADT_A37() {
68 this(new DefaultModelClassFactory());
69 }
70
71 /**
72 * Creates a new ADT_A37 message with custom ModelClassFactory.
73 */
74 public ADT_A37(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, false, false);
86 this.add(DB1.class, false, true);
87 this.add(PID.class, true, false);
88 this.add(PD1.class, false, false);
89 this.add(PV1.class, false, false);
90 this.add(DB1.class, false, true);
91 } catch(HL7Exception e) {
92 log.error("Unexpected error creating ADT_A37 - 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 * the first repetition of
191 * DB1 (Disability) - creates it if necessary
192 * </p>
193 *
194 *
195 */
196 public DB1 getDB1() {
197 return getTyped("DB1", DB1.class);
198 }
199
200
201 /**
202 * <p>
203 * Returns a specific repetition of
204 * DB1 (Disability) - creates it if necessary
205 * </p>
206 *
207 *
208 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
209 * @throws HL7Exception if the repetition requested is more than one
210 * greater than the number of existing repetitions.
211 */
212 public DB1 getDB1(int rep) {
213 return getTyped("DB1", rep, DB1.class);
214 }
215
216 /**
217 * <p>
218 * Returns the number of existing repetitions of DB1
219 * </p>
220 *
221 */
222 public int getDB1Reps() {
223 return getReps("DB1");
224 }
225
226 /**
227 * <p>
228 * Returns a non-modifiable List containing all current existing repetitions of DB1.
229 * <p>
230 * <p>
231 * Note that unlike {@link #getDB1()}, this method will not create any reps
232 * if none are already present, so an empty list may be returned.
233 * </p>
234 *
235 */
236 public java.util.List<DB1> getDB1All() throws HL7Exception {
237 return getAllAsList("DB1", DB1.class);
238 }
239
240 /**
241 * <p>
242 * Inserts a specific repetition of DB1 (Disability)
243 * </p>
244 *
245 *
246 * @see AbstractGroup#insertRepetition(Structure, int)
247 */
248 public void insertDB1(DB1 structure, int rep) throws HL7Exception {
249 super.insertRepetition( "DB1", structure, rep);
250 }
251
252
253 /**
254 * <p>
255 * Inserts a specific repetition of DB1 (Disability)
256 * </p>
257 *
258 *
259 * @see AbstractGroup#insertRepetition(Structure, int)
260 */
261 public DB1 insertDB1(int rep) throws HL7Exception {
262 return (DB1)super.insertRepetition("DB1", rep);
263 }
264
265
266 /**
267 * <p>
268 * Removes a specific repetition of DB1 (Disability)
269 * </p>
270 *
271 *
272 * @see AbstractGroup#removeRepetition(String, int)
273 */
274 public DB1 removeDB1(int rep) throws HL7Exception {
275 return (DB1)super.removeRepetition("DB1", rep);
276 }
277
278
279
280
281 /**
282 * <p>
283 * Returns
284 * PID2 (Patient identification) - creates it if necessary
285 * </p>
286 *
287 *
288 */
289 public PID getPID2() {
290 return getTyped("PID2", PID.class);
291 }
292
293
294
295
296
297 /**
298 * <p>
299 * Returns
300 * PD12 (patient additional demographic) - creates it if necessary
301 * </p>
302 *
303 *
304 */
305 public PD1 getPD12() {
306 return getTyped("PD12", PD1.class);
307 }
308
309
310
311
312
313 /**
314 * <p>
315 * Returns
316 * PV12 (Patient visit) - creates it if necessary
317 * </p>
318 *
319 *
320 */
321 public PV1 getPV12() {
322 return getTyped("PV12", PV1.class);
323 }
324
325
326
327
328
329 /**
330 * <p>
331 * Returns
332 * the first repetition of
333 * DB12 (Disability) - creates it if necessary
334 * </p>
335 *
336 *
337 */
338 public DB1 getDB12() {
339 return getTyped("DB12", DB1.class);
340 }
341
342
343 /**
344 * <p>
345 * Returns a specific repetition of
346 * DB12 (Disability) - creates it if necessary
347 * </p>
348 *
349 *
350 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
351 * @throws HL7Exception if the repetition requested is more than one
352 * greater than the number of existing repetitions.
353 */
354 public DB1 getDB12(int rep) {
355 return getTyped("DB12", rep, DB1.class);
356 }
357
358 /**
359 * <p>
360 * Returns the number of existing repetitions of DB12
361 * </p>
362 *
363 */
364 public int getDB12Reps() {
365 return getReps("DB12");
366 }
367
368 /**
369 * <p>
370 * Returns a non-modifiable List containing all current existing repetitions of DB12.
371 * <p>
372 * <p>
373 * Note that unlike {@link #getDB12()}, this method will not create any reps
374 * if none are already present, so an empty list may be returned.
375 * </p>
376 *
377 */
378 public java.util.List<DB1> getDB12All() throws HL7Exception {
379 return getAllAsList("DB12", DB1.class);
380 }
381
382 /**
383 * <p>
384 * Inserts a specific repetition of DB12 (Disability)
385 * </p>
386 *
387 *
388 * @see AbstractGroup#insertRepetition(Structure, int)
389 */
390 public void insertDB12(DB1 structure, int rep) throws HL7Exception {
391 super.insertRepetition( "DB12", structure, rep);
392 }
393
394
395 /**
396 * <p>
397 * Inserts a specific repetition of DB12 (Disability)
398 * </p>
399 *
400 *
401 * @see AbstractGroup#insertRepetition(Structure, int)
402 */
403 public DB1 insertDB12(int rep) throws HL7Exception {
404 return (DB1)super.insertRepetition("DB12", rep);
405 }
406
407
408 /**
409 * <p>
410 * Removes a specific repetition of DB12 (Disability)
411 * </p>
412 *
413 *
414 * @see AbstractGroup#removeRepetition(String, int)
415 */
416 public DB1 removeDB12(int rep) throws HL7Exception {
417 return (DB1)super.removeRepetition("DB12", rep);
418 }
419
420
421
422 }
423