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.group;
035
036import ca.uhn.hl7v2.model.v27.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a OML_O33_OBSERVATION_REQUEST group structure (a Group object).
044 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
045 * This Group contains the following elements:  
046 * </p>
047 * <ul>
048                         * <li>1: OBR (Observation Request) <b>  </b></li>
049                         * <li>2: TCD (Test Code Detail) <b>optional  </b></li>
050                         * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li>
051                         * <li>4: PRT (Participation Information) <b>optional repeating </b></li>
052                         * <li>5: DG1 (Diagnosis) <b>optional repeating </b></li>
053                         * <li>6: OML_O33_OBSERVATION (a Group object) <b>optional repeating </b></li>
054                         * <li>7: OML_O33_PRIOR_RESULT (a Group object) <b>optional repeating </b></li>
055 * </ul>
056 */
057//@SuppressWarnings("unused")
058public class OML_O33_OBSERVATION_REQUEST extends AbstractGroup {
059
060    /** 
061     * Creates a new OML_O33_OBSERVATION_REQUEST group
062     */
063    public OML_O33_OBSERVATION_REQUEST(Group parent, ModelClassFactory factory) {
064       super(parent, factory);
065       init(factory);
066    }
067
068    private void init(ModelClassFactory factory) {
069       try {
070                                  this.add(OBR.class, true, false, false);
071                                  this.add(TCD.class, false, false, false);
072                                  this.add(NTE.class, false, true, false);
073                                  this.add(PRT.class, false, true, false);
074                                  this.add(DG1.class, false, true, false);
075                                  this.add(OML_O33_OBSERVATION.class, false, true, false);
076                                  this.add(OML_O33_PRIOR_RESULT.class, false, true, false);
077       } catch(HL7Exception e) {
078          log.error("Unexpected error creating OML_O33_OBSERVATION_REQUEST - this is probably a bug in the source code generator.", e);
079       }
080    }
081
082    /** 
083     * Returns "2.7"
084     */
085    public String getVersion() {
086       return "2.7";
087    }
088
089
090
091    /**
092     * Returns
093     * OBR (Observation Request) - creates it if necessary
094     */
095    public OBR getOBR() { 
096       OBR retVal = getTyped("OBR", OBR.class);
097       return retVal;
098    }
099
100
101
102
103    /**
104     * Returns
105     * TCD (Test Code Detail) - creates it if necessary
106     */
107    public TCD getTCD() { 
108       TCD retVal = getTyped("TCD", TCD.class);
109       return retVal;
110    }
111
112
113
114
115    /**
116     * Returns
117     * the first repetition of 
118     * NTE (Notes and Comments) - creates it if necessary
119     */
120    public NTE getNTE() { 
121       NTE retVal = getTyped("NTE", NTE.class);
122       return retVal;
123    }
124
125
126    /**
127     * Returns a specific repetition of
128     * NTE (Notes and Comments) - creates it if necessary
129     *
130     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
131     * @throws HL7Exception if the repetition requested is more than one 
132     *     greater than the number of existing repetitions.
133     */
134    public NTE getNTE(int rep) { 
135       NTE retVal = getTyped("NTE", rep, NTE.class);
136       return retVal;
137    }
138
139    /** 
140     * Returns the number of existing repetitions of NTE 
141     */ 
142    public int getNTEReps() {  
143        return getReps("NTE");
144    } 
145
146    /** 
147     * <p>
148     * Returns a non-modifiable List containing all current existing repetitions of NTE.
149     * <p>
150     * <p>
151     * Note that unlike {@link #getNTE()}, this method will not create any reps
152     * if none are already present, so an empty list may be returned.
153     * </p>
154     */ 
155    public java.util.List<NTE> getNTEAll() throws HL7Exception {
156        return getAllAsList("NTE", NTE.class);
157    } 
158
159    /**
160     * Inserts a specific repetition of NTE (Notes and Comments)
161     * @see AbstractGroup#insertRepetition(Structure, int) 
162     */
163    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
164       super.insertRepetition("NTE", structure, rep);
165    }
166
167
168    /**
169     * Inserts a specific repetition of NTE (Notes and Comments)
170     * @see AbstractGroup#insertRepetition(Structure, int) 
171     */
172    public NTE insertNTE(int rep) throws HL7Exception { 
173       return (NTE)super.insertRepetition("NTE", rep);
174    }
175
176
177    /**
178     * Removes a specific repetition of NTE (Notes and Comments)
179     * @see AbstractGroup#removeRepetition(String, int) 
180     */
181    public NTE removeNTE(int rep) throws HL7Exception { 
182       return (NTE)super.removeRepetition("NTE", rep);
183    }
184
185
186
187    /**
188     * Returns
189     * the first repetition of 
190     * PRT (Participation Information) - creates it if necessary
191     */
192    public PRT getPRT() { 
193       PRT retVal = getTyped("PRT", PRT.class);
194       return retVal;
195    }
196
197
198    /**
199     * Returns a specific repetition of
200     * PRT (Participation Information) - creates it if necessary
201     *
202     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
203     * @throws HL7Exception if the repetition requested is more than one 
204     *     greater than the number of existing repetitions.
205     */
206    public PRT getPRT(int rep) { 
207       PRT retVal = getTyped("PRT", rep, PRT.class);
208       return retVal;
209    }
210
211    /** 
212     * Returns the number of existing repetitions of PRT 
213     */ 
214    public int getPRTReps() {  
215        return getReps("PRT");
216    } 
217
218    /** 
219     * <p>
220     * Returns a non-modifiable List containing all current existing repetitions of PRT.
221     * <p>
222     * <p>
223     * Note that unlike {@link #getPRT()}, this method will not create any reps
224     * if none are already present, so an empty list may be returned.
225     * </p>
226     */ 
227    public java.util.List<PRT> getPRTAll() throws HL7Exception {
228        return getAllAsList("PRT", PRT.class);
229    } 
230
231    /**
232     * Inserts a specific repetition of PRT (Participation Information)
233     * @see AbstractGroup#insertRepetition(Structure, int) 
234     */
235    public void insertPRT(PRT structure, int rep) throws HL7Exception { 
236       super.insertRepetition("PRT", structure, rep);
237    }
238
239
240    /**
241     * Inserts a specific repetition of PRT (Participation Information)
242     * @see AbstractGroup#insertRepetition(Structure, int) 
243     */
244    public PRT insertPRT(int rep) throws HL7Exception { 
245       return (PRT)super.insertRepetition("PRT", rep);
246    }
247
248
249    /**
250     * Removes a specific repetition of PRT (Participation Information)
251     * @see AbstractGroup#removeRepetition(String, int) 
252     */
253    public PRT removePRT(int rep) throws HL7Exception { 
254       return (PRT)super.removeRepetition("PRT", rep);
255    }
256
257
258
259    /**
260     * Returns
261     * the first repetition of 
262     * DG1 (Diagnosis) - creates it if necessary
263     */
264    public DG1 getDG1() { 
265       DG1 retVal = getTyped("DG1", DG1.class);
266       return retVal;
267    }
268
269
270    /**
271     * Returns a specific repetition of
272     * DG1 (Diagnosis) - creates it if necessary
273     *
274     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
275     * @throws HL7Exception if the repetition requested is more than one 
276     *     greater than the number of existing repetitions.
277     */
278    public DG1 getDG1(int rep) { 
279       DG1 retVal = getTyped("DG1", rep, DG1.class);
280       return retVal;
281    }
282
283    /** 
284     * Returns the number of existing repetitions of DG1 
285     */ 
286    public int getDG1Reps() {  
287        return getReps("DG1");
288    } 
289
290    /** 
291     * <p>
292     * Returns a non-modifiable List containing all current existing repetitions of DG1.
293     * <p>
294     * <p>
295     * Note that unlike {@link #getDG1()}, this method will not create any reps
296     * if none are already present, so an empty list may be returned.
297     * </p>
298     */ 
299    public java.util.List<DG1> getDG1All() throws HL7Exception {
300        return getAllAsList("DG1", DG1.class);
301    } 
302
303    /**
304     * Inserts a specific repetition of DG1 (Diagnosis)
305     * @see AbstractGroup#insertRepetition(Structure, int) 
306     */
307    public void insertDG1(DG1 structure, int rep) throws HL7Exception { 
308       super.insertRepetition("DG1", structure, rep);
309    }
310
311
312    /**
313     * Inserts a specific repetition of DG1 (Diagnosis)
314     * @see AbstractGroup#insertRepetition(Structure, int) 
315     */
316    public DG1 insertDG1(int rep) throws HL7Exception { 
317       return (DG1)super.insertRepetition("DG1", rep);
318    }
319
320
321    /**
322     * Removes a specific repetition of DG1 (Diagnosis)
323     * @see AbstractGroup#removeRepetition(String, int) 
324     */
325    public DG1 removeDG1(int rep) throws HL7Exception { 
326       return (DG1)super.removeRepetition("DG1", rep);
327    }
328
329
330
331    /**
332     * Returns
333     * the first repetition of 
334     * OBSERVATION (a Group object) - creates it if necessary
335     */
336    public OML_O33_OBSERVATION getOBSERVATION() { 
337       OML_O33_OBSERVATION retVal = getTyped("OBSERVATION", OML_O33_OBSERVATION.class);
338       return retVal;
339    }
340
341
342    /**
343     * Returns a specific repetition of
344     * OBSERVATION (a Group object) - creates it if necessary
345     *
346     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
347     * @throws HL7Exception if the repetition requested is more than one 
348     *     greater than the number of existing repetitions.
349     */
350    public OML_O33_OBSERVATION getOBSERVATION(int rep) { 
351       OML_O33_OBSERVATION retVal = getTyped("OBSERVATION", rep, OML_O33_OBSERVATION.class);
352       return retVal;
353    }
354
355    /** 
356     * Returns the number of existing repetitions of OBSERVATION 
357     */ 
358    public int getOBSERVATIONReps() {  
359        return getReps("OBSERVATION");
360    } 
361
362    /** 
363     * <p>
364     * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
365     * <p>
366     * <p>
367     * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
368     * if none are already present, so an empty list may be returned.
369     * </p>
370     */ 
371    public java.util.List<OML_O33_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
372        return getAllAsList("OBSERVATION", OML_O33_OBSERVATION.class);
373    } 
374
375    /**
376     * Inserts a specific repetition of OBSERVATION (a Group object)
377     * @see AbstractGroup#insertRepetition(Structure, int) 
378     */
379    public void insertOBSERVATION(OML_O33_OBSERVATION structure, int rep) throws HL7Exception { 
380       super.insertRepetition("OBSERVATION", structure, rep);
381    }
382
383
384    /**
385     * Inserts a specific repetition of OBSERVATION (a Group object)
386     * @see AbstractGroup#insertRepetition(Structure, int) 
387     */
388    public OML_O33_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 
389       return (OML_O33_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
390    }
391
392
393    /**
394     * Removes a specific repetition of OBSERVATION (a Group object)
395     * @see AbstractGroup#removeRepetition(String, int) 
396     */
397    public OML_O33_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 
398       return (OML_O33_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
399    }
400
401
402
403    /**
404     * Returns
405     * the first repetition of 
406     * PRIOR_RESULT (a Group object) - creates it if necessary
407     */
408    public OML_O33_PRIOR_RESULT getPRIOR_RESULT() { 
409       OML_O33_PRIOR_RESULT retVal = getTyped("PRIOR_RESULT", OML_O33_PRIOR_RESULT.class);
410       return retVal;
411    }
412
413
414    /**
415     * Returns a specific repetition of
416     * PRIOR_RESULT (a Group object) - creates it if necessary
417     *
418     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
419     * @throws HL7Exception if the repetition requested is more than one 
420     *     greater than the number of existing repetitions.
421     */
422    public OML_O33_PRIOR_RESULT getPRIOR_RESULT(int rep) { 
423       OML_O33_PRIOR_RESULT retVal = getTyped("PRIOR_RESULT", rep, OML_O33_PRIOR_RESULT.class);
424       return retVal;
425    }
426
427    /** 
428     * Returns the number of existing repetitions of PRIOR_RESULT 
429     */ 
430    public int getPRIOR_RESULTReps() {  
431        return getReps("PRIOR_RESULT");
432    } 
433
434    /** 
435     * <p>
436     * Returns a non-modifiable List containing all current existing repetitions of PRIOR_RESULT.
437     * <p>
438     * <p>
439     * Note that unlike {@link #getPRIOR_RESULT()}, this method will not create any reps
440     * if none are already present, so an empty list may be returned.
441     * </p>
442     */ 
443    public java.util.List<OML_O33_PRIOR_RESULT> getPRIOR_RESULTAll() throws HL7Exception {
444        return getAllAsList("PRIOR_RESULT", OML_O33_PRIOR_RESULT.class);
445    } 
446
447    /**
448     * Inserts a specific repetition of PRIOR_RESULT (a Group object)
449     * @see AbstractGroup#insertRepetition(Structure, int) 
450     */
451    public void insertPRIOR_RESULT(OML_O33_PRIOR_RESULT structure, int rep) throws HL7Exception { 
452       super.insertRepetition("PRIOR_RESULT", structure, rep);
453    }
454
455
456    /**
457     * Inserts a specific repetition of PRIOR_RESULT (a Group object)
458     * @see AbstractGroup#insertRepetition(Structure, int) 
459     */
460    public OML_O33_PRIOR_RESULT insertPRIOR_RESULT(int rep) throws HL7Exception { 
461       return (OML_O33_PRIOR_RESULT)super.insertRepetition("PRIOR_RESULT", rep);
462    }
463
464
465    /**
466     * Removes a specific repetition of PRIOR_RESULT (a Group object)
467     * @see AbstractGroup#removeRepetition(String, int) 
468     */
469    public OML_O33_PRIOR_RESULT removePRIOR_RESULT(int rep) throws HL7Exception { 
470       return (OML_O33_PRIOR_RESULT)super.removeRepetition("PRIOR_RESULT", rep);
471    }
472
473
474
475}
476