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.v23.message;
35
36 import ca.uhn.hl7v2.model.v23.group.*;
37 import ca.uhn.hl7v2.model.v23.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 VXU_V04 message structure (see chapter ?). This structure contains the
47 * following elements: </p>
48 * <ul>
49 * <li>1: MSH (Message header segment) <b> </b> </li>
50 * <li>2: PID (Patient Identification) <b> </b> </li>
51 * <li>3: PD1 (Patient Demographic) <b>optional </b> </li>
52 * <li>4: NK1 (Next of kin) <b>optional repeating</b> </li>
53 * <li>5: VXU_V04_PATIENT (a Group object) <b>optional </b> </li>
54 * <li>6: VXU_V04_INSURANCE (a Group object) <b>optional repeating</b> </li>
55 * <li>7: VXU_V04_ORDER (a Group object) <b>optional repeating</b> </li>
56 * </ul>
57 */
58 //@SuppressWarnings("unused")
59 public class VXU_V04 extends AbstractMessage {
60
61 /**
62 * Creates a new VXU_V04 message with DefaultModelClassFactory.
63 */
64 public VXU_V04() {
65 this(new DefaultModelClassFactory());
66 }
67
68 /**
69 * Creates a new VXU_V04 message with custom ModelClassFactory.
70 */
71 public VXU_V04(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(PID.class, true, false);
80 this.add(PD1.class, false, false);
81 this.add(NK1.class, false, true);
82 this.add(VXU_V04_PATIENT.class, false, false);
83 this.add(VXU_V04_INSURANCE.class, false, true);
84 this.add(VXU_V04_ORDER.class, false, true);
85 } catch(HL7Exception e) {
86 log.error("Unexpected error creating VXU_V04 - this is probably a bug in the source code generator.", e);
87 }
88 }
89
90
91 /**
92 * Returns "2.3"
93 */
94 public String getVersion() {
95 return "2.3";
96 }
97
98
99
100
101 /**
102 * <p>
103 * Returns
104 * MSH (Message header segment) - 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 * PID (Patient Identification) - creates it if necessary
121 * </p>
122 *
123 *
124 */
125 public PID getPID() {
126 return getTyped("PID", PID.class);
127 }
128
129
130
131
132
133 /**
134 * <p>
135 * Returns
136 * PD1 (Patient Demographic) - creates it if necessary
137 * </p>
138 *
139 *
140 */
141 public PD1 getPD1() {
142 return getTyped("PD1", PD1.class);
143 }
144
145
146
147
148
149 /**
150 * <p>
151 * Returns
152 * the first repetition of
153 * NK1 (Next of kin) - creates it if necessary
154 * </p>
155 *
156 *
157 */
158 public NK1 getNK1() {
159 return getTyped("NK1", NK1.class);
160 }
161
162
163 /**
164 * <p>
165 * Returns a specific repetition of
166 * NK1 (Next of kin) - creates it if necessary
167 * </p>
168 *
169 *
170 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
171 * @throws HL7Exception if the repetition requested is more than one
172 * greater than the number of existing repetitions.
173 */
174 public NK1 getNK1(int rep) {
175 return getTyped("NK1", rep, NK1.class);
176 }
177
178 /**
179 * <p>
180 * Returns the number of existing repetitions of NK1
181 * </p>
182 *
183 */
184 public int getNK1Reps() {
185 return getReps("NK1");
186 }
187
188 /**
189 * <p>
190 * Returns a non-modifiable List containing all current existing repetitions of NK1.
191 * <p>
192 * <p>
193 * Note that unlike {@link #getNK1()}, this method will not create any reps
194 * if none are already present, so an empty list may be returned.
195 * </p>
196 *
197 */
198 public java.util.List<NK1> getNK1All() throws HL7Exception {
199 return getAllAsList("NK1", NK1.class);
200 }
201
202 /**
203 * <p>
204 * Inserts a specific repetition of NK1 (Next of kin)
205 * </p>
206 *
207 *
208 * @see AbstractGroup#insertRepetition(Structure, int)
209 */
210 public void insertNK1(NK1 structure, int rep) throws HL7Exception {
211 super.insertRepetition( "NK1", structure, rep);
212 }
213
214
215 /**
216 * <p>
217 * Inserts a specific repetition of NK1 (Next of kin)
218 * </p>
219 *
220 *
221 * @see AbstractGroup#insertRepetition(Structure, int)
222 */
223 public NK1 insertNK1(int rep) throws HL7Exception {
224 return (NK1)super.insertRepetition("NK1", rep);
225 }
226
227
228 /**
229 * <p>
230 * Removes a specific repetition of NK1 (Next of kin)
231 * </p>
232 *
233 *
234 * @see AbstractGroup#removeRepetition(String, int)
235 */
236 public NK1 removeNK1(int rep) throws HL7Exception {
237 return (NK1)super.removeRepetition("NK1", rep);
238 }
239
240
241
242
243 /**
244 * <p>
245 * Returns
246 * PATIENT (a Group object) - creates it if necessary
247 * </p>
248 *
249 *
250 */
251 public VXU_V04_PATIENT getPATIENT() {
252 return getTyped("PATIENT", VXU_V04_PATIENT.class);
253 }
254
255
256
257
258
259 /**
260 * <p>
261 * Returns
262 * the first repetition of
263 * INSURANCE (a Group object) - creates it if necessary
264 * </p>
265 *
266 *
267 */
268 public VXU_V04_INSURANCE getINSURANCE() {
269 return getTyped("INSURANCE", VXU_V04_INSURANCE.class);
270 }
271
272
273 /**
274 * <p>
275 * Returns a specific repetition of
276 * INSURANCE (a Group object) - creates it if necessary
277 * </p>
278 *
279 *
280 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
281 * @throws HL7Exception if the repetition requested is more than one
282 * greater than the number of existing repetitions.
283 */
284 public VXU_V04_INSURANCE getINSURANCE(int rep) {
285 return getTyped("INSURANCE", rep, VXU_V04_INSURANCE.class);
286 }
287
288 /**
289 * <p>
290 * Returns the number of existing repetitions of INSURANCE
291 * </p>
292 *
293 */
294 public int getINSURANCEReps() {
295 return getReps("INSURANCE");
296 }
297
298 /**
299 * <p>
300 * Returns a non-modifiable List containing all current existing repetitions of INSURANCE.
301 * <p>
302 * <p>
303 * Note that unlike {@link #getINSURANCE()}, this method will not create any reps
304 * if none are already present, so an empty list may be returned.
305 * </p>
306 *
307 */
308 public java.util.List<VXU_V04_INSURANCE> getINSURANCEAll() throws HL7Exception {
309 return getAllAsList("INSURANCE", VXU_V04_INSURANCE.class);
310 }
311
312 /**
313 * <p>
314 * Inserts a specific repetition of INSURANCE (a Group object)
315 * </p>
316 *
317 *
318 * @see AbstractGroup#insertRepetition(Structure, int)
319 */
320 public void insertINSURANCE(VXU_V04_INSURANCE structure, int rep) throws HL7Exception {
321 super.insertRepetition( "INSURANCE", structure, rep);
322 }
323
324
325 /**
326 * <p>
327 * Inserts a specific repetition of INSURANCE (a Group object)
328 * </p>
329 *
330 *
331 * @see AbstractGroup#insertRepetition(Structure, int)
332 */
333 public VXU_V04_INSURANCE insertINSURANCE(int rep) throws HL7Exception {
334 return (VXU_V04_INSURANCE)super.insertRepetition("INSURANCE", rep);
335 }
336
337
338 /**
339 * <p>
340 * Removes a specific repetition of INSURANCE (a Group object)
341 * </p>
342 *
343 *
344 * @see AbstractGroup#removeRepetition(String, int)
345 */
346 public VXU_V04_INSURANCE removeINSURANCE(int rep) throws HL7Exception {
347 return (VXU_V04_INSURANCE)super.removeRepetition("INSURANCE", rep);
348 }
349
350
351
352
353 /**
354 * <p>
355 * Returns
356 * the first repetition of
357 * ORDER (a Group object) - creates it if necessary
358 * </p>
359 *
360 *
361 */
362 public VXU_V04_ORDER getORDER() {
363 return getTyped("ORDER", VXU_V04_ORDER.class);
364 }
365
366
367 /**
368 * <p>
369 * Returns a specific repetition of
370 * ORDER (a Group object) - creates it if necessary
371 * </p>
372 *
373 *
374 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
375 * @throws HL7Exception if the repetition requested is more than one
376 * greater than the number of existing repetitions.
377 */
378 public VXU_V04_ORDER getORDER(int rep) {
379 return getTyped("ORDER", rep, VXU_V04_ORDER.class);
380 }
381
382 /**
383 * <p>
384 * Returns the number of existing repetitions of ORDER
385 * </p>
386 *
387 */
388 public int getORDERReps() {
389 return getReps("ORDER");
390 }
391
392 /**
393 * <p>
394 * Returns a non-modifiable List containing all current existing repetitions of ORDER.
395 * <p>
396 * <p>
397 * Note that unlike {@link #getORDER()}, this method will not create any reps
398 * if none are already present, so an empty list may be returned.
399 * </p>
400 *
401 */
402 public java.util.List<VXU_V04_ORDER> getORDERAll() throws HL7Exception {
403 return getAllAsList("ORDER", VXU_V04_ORDER.class);
404 }
405
406 /**
407 * <p>
408 * Inserts a specific repetition of ORDER (a Group object)
409 * </p>
410 *
411 *
412 * @see AbstractGroup#insertRepetition(Structure, int)
413 */
414 public void insertORDER(VXU_V04_ORDER structure, int rep) throws HL7Exception {
415 super.insertRepetition( "ORDER", structure, rep);
416 }
417
418
419 /**
420 * <p>
421 * Inserts a specific repetition of ORDER (a Group object)
422 * </p>
423 *
424 *
425 * @see AbstractGroup#insertRepetition(Structure, int)
426 */
427 public VXU_V04_ORDER insertORDER(int rep) throws HL7Exception {
428 return (VXU_V04_ORDER)super.insertRepetition("ORDER", rep);
429 }
430
431
432 /**
433 * <p>
434 * Removes a specific repetition of ORDER (a Group object)
435 * </p>
436 *
437 *
438 * @see AbstractGroup#removeRepetition(String, int)
439 */
440 public VXU_V04_ORDER removeORDER(int rep) throws HL7Exception {
441 return (VXU_V04_ORDER)super.removeRepetition("ORDER", rep);
442 }
443
444
445
446 }
447