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