001/*
002 * This class is an auto-generated source file for a HAPI
003 * HL7 v2.x standard structure class.
004 *
005 * For more information, visit: http://hl7api.sourceforge.net/
006 * 
007 * The contents of this file are subject to the Mozilla Public License Version 1.1 
008 * (the "License"); you may not use this file except in compliance with the License. 
009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
010 * Software distributed under the License is distributed on an "AS IS" basis, 
011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
012 * specific language governing rights and limitations under the License. 
013 * 
014 * The Original Code is "[file_name]".  Description: 
015 * "[one_line_description]" 
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2012.  All Rights Reserved. 
019 * 
020 * Contributor(s): ______________________________________. 
021 * 
022 * Alternatively, the contents of this file may be used under the terms of the 
023 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
024 * applicable instead of those above.  If you wish to allow use of your version of this 
025 * file only under the terms of the GPL and not to allow others to use your version 
026 * of this file under the MPL, indicate your decision by deleting  the provisions above 
027 * and replace  them with the notice and other provisions required by the GPL License.  
028 * If you do not delete the provisions above, a recipient may use your version of 
029 * this file under either the MPL or the GPL. 
030 * 
031 */
032
033
034package ca.uhn.hl7v2.model.v27.message;
035
036import ca.uhn.hl7v2.model.v27.group.*;
037import ca.uhn.hl7v2.model.v27.segment.*;
038
039import ca.uhn.hl7v2.HL7Exception;
040import ca.uhn.hl7v2.parser.ModelClassFactory;
041import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044
045/**
046 * <p>Represents a MDM_T02 message structure (see chapter 9.6.2). This structure contains the 
047 * following elements: </p>
048 * <ul>
049                                 * <li>1: MSH (Message Header) <b> </b> </li>
050                                 * <li>2: SFT (Software Segment) <b>optional repeating</b> </li>
051                                 * <li>3: UAC (User Authentication Credential Segment) <b>optional </b> </li>
052                                 * <li>4: EVN (Event Type) <b> </b> </li>
053                                 * <li>5: PID (Patient Identification) <b> </b> </li>
054                                 * <li>6: PV1 (Patient Visit) <b> </b> </li>
055                                 * <li>7: MDM_T02_COMMON_ORDER (a Group object) <b>optional repeating</b> </li>
056                                 * <li>8: TXA (Transcription Document Header) <b> </b> </li>
057                                 * <li>9: CON_ (Consent Segment) <b>optional repeating</b> </li>
058                                 * <li>10: MDM_T02_OBSERVATION (a Group object) <b> repeating</b> </li>
059 * </ul>
060 */
061//@SuppressWarnings("unused")
062public class MDM_T02 extends AbstractMessage  {
063
064    /**
065     * Creates a new MDM_T02 message with DefaultModelClassFactory. 
066     */ 
067    public MDM_T02() { 
068       this(new DefaultModelClassFactory());
069    }
070
071    /** 
072     * Creates a new MDM_T02 message with custom ModelClassFactory.
073     */
074    public MDM_T02(ModelClassFactory factory) {
075       super(factory);
076       init(factory);
077    }
078
079    private void init(ModelClassFactory factory) {
080       try {
081                          this.add(MSH.class, true, false);
082                                  this.add(SFT.class, false, true);
083                                  this.add(UAC.class, false, false);
084                                  this.add(EVN.class, true, false);
085                                  this.add(PID.class, true, false);
086                                  this.add(PV1.class, true, false);
087                                  this.add(MDM_T02_COMMON_ORDER.class, false, true);
088                                  this.add(TXA.class, true, false);
089                                  this.add(CON_.class, false, true);
090                                  this.add(MDM_T02_OBSERVATION.class, true, true);
091               } catch(HL7Exception e) {
092          log.error("Unexpected error creating MDM_T02 - this is probably a bug in the source code generator.", e);
093       }
094    }
095
096
097    /** 
098     * Returns "2.7"
099     */
100    public String getVersion() {
101       return "2.7";
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     * PV1 (Patient Visit) - creates it if necessary
269     * </p>
270     * 
271     *
272     */
273    public PV1 getPV1() { 
274       return getTyped("PV1", PV1.class);
275    }
276
277
278
279
280
281    /**
282     * <p>
283     * Returns
284     * the first repetition of 
285     * COMMON_ORDER (a Group object) - creates it if necessary
286     * </p>
287     * 
288     *
289     */
290    public MDM_T02_COMMON_ORDER getCOMMON_ORDER() { 
291       return getTyped("COMMON_ORDER", MDM_T02_COMMON_ORDER.class);
292    }
293
294
295    /**
296     * <p>
297     * Returns a specific repetition of
298     * COMMON_ORDER (a Group object) - 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 MDM_T02_COMMON_ORDER getCOMMON_ORDER(int rep) { 
307       return getTyped("COMMON_ORDER", rep, MDM_T02_COMMON_ORDER.class);
308    }
309
310    /** 
311     * <p>
312     * Returns the number of existing repetitions of COMMON_ORDER 
313     * </p>
314     * 
315     */ 
316    public int getCOMMON_ORDERReps() { 
317        return getReps("COMMON_ORDER");
318    } 
319
320    /** 
321     * <p>
322     * Returns a non-modifiable List containing all current existing repetitions of COMMON_ORDER.
323     * <p>
324     * <p>
325     * Note that unlike {@link #getCOMMON_ORDER()}, 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<MDM_T02_COMMON_ORDER> getCOMMON_ORDERAll() throws HL7Exception {
331        return getAllAsList("COMMON_ORDER", MDM_T02_COMMON_ORDER.class);
332    } 
333
334    /**
335     * <p>
336     * Inserts a specific repetition of COMMON_ORDER (a Group object)
337     * </p>
338     * 
339     *
340     * @see AbstractGroup#insertRepetition(Structure, int) 
341     */
342    public void insertCOMMON_ORDER(MDM_T02_COMMON_ORDER structure, int rep) throws HL7Exception { 
343       super.insertRepetition( "COMMON_ORDER", structure, rep);
344    }
345
346
347    /**
348     * <p>
349     * Inserts a specific repetition of COMMON_ORDER (a Group object)
350     * </p>
351     * 
352     *
353     * @see AbstractGroup#insertRepetition(Structure, int) 
354     */
355    public MDM_T02_COMMON_ORDER insertCOMMON_ORDER(int rep) throws HL7Exception { 
356       return (MDM_T02_COMMON_ORDER)super.insertRepetition("COMMON_ORDER", rep);
357    }
358
359
360    /**
361     * <p>
362     * Removes a specific repetition of COMMON_ORDER (a Group object)
363     * </p>
364     * 
365     *
366     * @see AbstractGroup#removeRepetition(String, int) 
367     */
368    public MDM_T02_COMMON_ORDER removeCOMMON_ORDER(int rep) throws HL7Exception { 
369       return (MDM_T02_COMMON_ORDER)super.removeRepetition("COMMON_ORDER", rep);
370    }
371
372
373
374
375    /**
376     * <p>
377     * Returns
378     * TXA (Transcription Document Header) - creates it if necessary
379     * </p>
380     * 
381     *
382     */
383    public TXA getTXA() { 
384       return getTyped("TXA", TXA.class);
385    }
386
387
388
389
390
391    /**
392     * <p>
393     * Returns
394     * the first repetition of 
395     * CON_ (Consent Segment) - creates it if necessary
396     * </p>
397     * 
398     *
399     */
400    public CON_ getCON_() { 
401       return getTyped("CON_", CON_.class);
402    }
403
404
405    /**
406     * <p>
407     * Returns a specific repetition of
408     * CON_ (Consent Segment) - 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 CON_ getCON_(int rep) { 
417       return getTyped("CON_", rep, CON_.class);
418    }
419
420    /** 
421     * <p>
422     * Returns the number of existing repetitions of CON_ 
423     * </p>
424     * 
425     */ 
426    public int getCON_Reps() { 
427        return getReps("CON_");
428    } 
429
430    /** 
431     * <p>
432     * Returns a non-modifiable List containing all current existing repetitions of CON_.
433     * <p>
434     * <p>
435     * Note that unlike {@link #getCON_()}, 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<CON_> getCON_All() throws HL7Exception {
441        return getAllAsList("CON_", CON_.class);
442    } 
443
444    /**
445     * <p>
446     * Inserts a specific repetition of CON_ (Consent Segment)
447     * </p>
448     * 
449     *
450     * @see AbstractGroup#insertRepetition(Structure, int) 
451     */
452    public void insertCON_(CON_ structure, int rep) throws HL7Exception { 
453       super.insertRepetition( "CON_", structure, rep);
454    }
455
456
457    /**
458     * <p>
459     * Inserts a specific repetition of CON_ (Consent Segment)
460     * </p>
461     * 
462     *
463     * @see AbstractGroup#insertRepetition(Structure, int) 
464     */
465    public CON_ insertCON_(int rep) throws HL7Exception { 
466       return (CON_)super.insertRepetition("CON_", rep);
467    }
468
469
470    /**
471     * <p>
472     * Removes a specific repetition of CON_ (Consent Segment)
473     * </p>
474     * 
475     *
476     * @see AbstractGroup#removeRepetition(String, int) 
477     */
478    public CON_ removeCON_(int rep) throws HL7Exception { 
479       return (CON_)super.removeRepetition("CON_", rep);
480    }
481
482
483
484
485    /**
486     * <p>
487     * Returns
488     * the first repetition of 
489     * OBSERVATION (a Group object) - creates it if necessary
490     * </p>
491     * 
492     *
493     */
494    public MDM_T02_OBSERVATION getOBSERVATION() { 
495       return getTyped("OBSERVATION", MDM_T02_OBSERVATION.class);
496    }
497
498
499    /**
500     * <p>
501     * Returns a specific repetition of
502     * OBSERVATION (a Group object) - creates it if necessary
503     * </p>
504     * 
505     *
506     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
507     * @throws HL7Exception if the repetition requested is more than one 
508     *     greater than the number of existing repetitions.
509     */
510    public MDM_T02_OBSERVATION getOBSERVATION(int rep) { 
511       return getTyped("OBSERVATION", rep, MDM_T02_OBSERVATION.class);
512    }
513
514    /** 
515     * <p>
516     * Returns the number of existing repetitions of OBSERVATION 
517     * </p>
518     * 
519     */ 
520    public int getOBSERVATIONReps() { 
521        return getReps("OBSERVATION");
522    } 
523
524    /** 
525     * <p>
526     * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
527     * <p>
528     * <p>
529     * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
530     * if none are already present, so an empty list may be returned.
531     * </p>
532     * 
533     */ 
534    public java.util.List<MDM_T02_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
535        return getAllAsList("OBSERVATION", MDM_T02_OBSERVATION.class);
536    } 
537
538    /**
539     * <p>
540     * Inserts a specific repetition of OBSERVATION (a Group object)
541     * </p>
542     * 
543     *
544     * @see AbstractGroup#insertRepetition(Structure, int) 
545     */
546    public void insertOBSERVATION(MDM_T02_OBSERVATION structure, int rep) throws HL7Exception { 
547       super.insertRepetition( "OBSERVATION", structure, rep);
548    }
549
550
551    /**
552     * <p>
553     * Inserts a specific repetition of OBSERVATION (a Group object)
554     * </p>
555     * 
556     *
557     * @see AbstractGroup#insertRepetition(Structure, int) 
558     */
559    public MDM_T02_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 
560       return (MDM_T02_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
561    }
562
563
564    /**
565     * <p>
566     * Removes a specific repetition of OBSERVATION (a Group object)
567     * </p>
568     * 
569     *
570     * @see AbstractGroup#removeRepetition(String, int) 
571     */
572    public MDM_T02_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 
573       return (MDM_T02_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
574    }
575
576
577
578}
579