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