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.v22.group;
035
036import ca.uhn.hl7v2.model.v22.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a ORM_O01_ORDER_DETAIL 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>  choice</b></li>
049                         * <li>2: RQD (REQUISITION DETAIL) <b>  choice</b></li>
050                         * <li>3: RQ1 (REQUISITION DETAIL-!) <b>  choice</b></li>
051                         * <li>4: RXO (PHARMACY PRESCRIPTION ORDER) <b>  choice</b></li>
052                         * <li>5: ODS (DIETARY ORDERS, SUPPLEMENTS, and PREFERENCES) <b>  choice</b></li>
053                         * <li>6: ODT (DIET TRAY INSTRUCTION) <b>  choice</b></li>
054                         * <li>7: NTE (NOTES AND COMMENTS) <b>optional repeating </b></li>
055                         * <li>8: OBX (OBSERVATION RESULT) <b>optional repeating </b></li>
056                         * <li>9: NTE (NOTES AND COMMENTS) <b> repeating </b></li>
057 * </ul>
058 * <p>
059 * Note that this structure has "choice" elements. This means that one of the 
060 * structures above marked as "choice" must be present, but no more than one.
061 * </p> 
062 */
063//@SuppressWarnings("unused")
064public class ORM_O01_ORDER_DETAIL extends AbstractGroup {
065
066    /** 
067     * Creates a new ORM_O01_ORDER_DETAIL group
068     */
069    public ORM_O01_ORDER_DETAIL(Group parent, ModelClassFactory factory) {
070       super(parent, factory);
071       init(factory);
072    }
073
074    private void init(ModelClassFactory factory) {
075       try {
076                                  this.add(OBR.class, true, false, true);
077                                  this.add(RQD.class, true, false, true);
078                                  this.add(RQ1.class, true, false, true);
079                                  this.add(RXO.class, true, false, true);
080                                  this.add(ODS.class, true, false, true);
081                                  this.add(ODT.class, true, false, true);
082                                  this.add(NTE.class, false, true, false);
083                                  this.add(OBX.class, false, true, false);
084                                  this.add(NTE.class, true, true, false);
085       } catch(HL7Exception e) {
086          log.error("Unexpected error creating ORM_O01_ORDER_DETAIL - this is probably a bug in the source code generator.", e);
087       }
088    }
089
090    /** 
091     * Returns "2.2"
092     */
093    public String getVersion() {
094       return "2.2";
095    }
096
097
098
099    /**
100     * Returns
101     * OBR (OBSERVATION REQUEST) - creates it if necessary
102     */
103    public OBR getOBR() { 
104       OBR retVal = getTyped("OBR", OBR.class);
105       return retVal;
106    }
107
108
109
110
111    /**
112     * Returns
113     * RQD (REQUISITION DETAIL) - creates it if necessary
114     */
115    public RQD getRQD() { 
116       RQD retVal = getTyped("RQD", RQD.class);
117       return retVal;
118    }
119
120
121
122
123    /**
124     * Returns
125     * RQ1 (REQUISITION DETAIL-!) - creates it if necessary
126     */
127    public RQ1 getRQ1() { 
128       RQ1 retVal = getTyped("RQ1", RQ1.class);
129       return retVal;
130    }
131
132
133
134
135    /**
136     * Returns
137     * RXO (PHARMACY PRESCRIPTION ORDER) - creates it if necessary
138     */
139    public RXO getRXO() { 
140       RXO retVal = getTyped("RXO", RXO.class);
141       return retVal;
142    }
143
144
145
146
147    /**
148     * Returns
149     * ODS (DIETARY ORDERS, SUPPLEMENTS, and PREFERENCES) - creates it if necessary
150     */
151    public ODS getODS() { 
152       ODS retVal = getTyped("ODS", ODS.class);
153       return retVal;
154    }
155
156
157
158
159    /**
160     * Returns
161     * ODT (DIET TRAY INSTRUCTION) - creates it if necessary
162     */
163    public ODT getODT() { 
164       ODT retVal = getTyped("ODT", ODT.class);
165       return retVal;
166    }
167
168
169
170
171    /**
172     * Returns
173     * the first repetition of 
174     * NTE (NOTES AND COMMENTS) - creates it if necessary
175     */
176    public NTE getNTE() { 
177       NTE retVal = getTyped("NTE", NTE.class);
178       return retVal;
179    }
180
181
182    /**
183     * Returns a specific repetition of
184     * NTE (NOTES AND COMMENTS) - creates it if necessary
185     *
186     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
187     * @throws HL7Exception if the repetition requested is more than one 
188     *     greater than the number of existing repetitions.
189     */
190    public NTE getNTE(int rep) { 
191       NTE retVal = getTyped("NTE", rep, NTE.class);
192       return retVal;
193    }
194
195    /** 
196     * Returns the number of existing repetitions of NTE 
197     */ 
198    public int getNTEReps() {  
199        return getReps("NTE");
200    } 
201
202    /** 
203     * <p>
204     * Returns a non-modifiable List containing all current existing repetitions of NTE.
205     * <p>
206     * <p>
207     * Note that unlike {@link #getNTE()}, this method will not create any reps
208     * if none are already present, so an empty list may be returned.
209     * </p>
210     */ 
211    public java.util.List<NTE> getNTEAll() throws HL7Exception {
212        return getAllAsList("NTE", NTE.class);
213    } 
214
215    /**
216     * Inserts a specific repetition of NTE (NOTES AND COMMENTS)
217     * @see AbstractGroup#insertRepetition(Structure, int) 
218     */
219    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
220       super.insertRepetition("NTE", structure, rep);
221    }
222
223
224    /**
225     * Inserts a specific repetition of NTE (NOTES AND COMMENTS)
226     * @see AbstractGroup#insertRepetition(Structure, int) 
227     */
228    public NTE insertNTE(int rep) throws HL7Exception { 
229       return (NTE)super.insertRepetition("NTE", rep);
230    }
231
232
233    /**
234     * Removes a specific repetition of NTE (NOTES AND COMMENTS)
235     * @see AbstractGroup#removeRepetition(String, int) 
236     */
237    public NTE removeNTE(int rep) throws HL7Exception { 
238       return (NTE)super.removeRepetition("NTE", rep);
239    }
240
241
242
243    /**
244     * Returns
245     * the first repetition of 
246     * OBX (OBSERVATION RESULT) - creates it if necessary
247     */
248    public OBX getOBX() { 
249       OBX retVal = getTyped("OBX", OBX.class);
250       return retVal;
251    }
252
253
254    /**
255     * Returns a specific repetition of
256     * OBX (OBSERVATION RESULT) - creates it if necessary
257     *
258     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
259     * @throws HL7Exception if the repetition requested is more than one 
260     *     greater than the number of existing repetitions.
261     */
262    public OBX getOBX(int rep) { 
263       OBX retVal = getTyped("OBX", rep, OBX.class);
264       return retVal;
265    }
266
267    /** 
268     * Returns the number of existing repetitions of OBX 
269     */ 
270    public int getOBXReps() {  
271        return getReps("OBX");
272    } 
273
274    /** 
275     * <p>
276     * Returns a non-modifiable List containing all current existing repetitions of OBX.
277     * <p>
278     * <p>
279     * Note that unlike {@link #getOBX()}, this method will not create any reps
280     * if none are already present, so an empty list may be returned.
281     * </p>
282     */ 
283    public java.util.List<OBX> getOBXAll() throws HL7Exception {
284        return getAllAsList("OBX", OBX.class);
285    } 
286
287    /**
288     * Inserts a specific repetition of OBX (OBSERVATION RESULT)
289     * @see AbstractGroup#insertRepetition(Structure, int) 
290     */
291    public void insertOBX(OBX structure, int rep) throws HL7Exception { 
292       super.insertRepetition("OBX", structure, rep);
293    }
294
295
296    /**
297     * Inserts a specific repetition of OBX (OBSERVATION RESULT)
298     * @see AbstractGroup#insertRepetition(Structure, int) 
299     */
300    public OBX insertOBX(int rep) throws HL7Exception { 
301       return (OBX)super.insertRepetition("OBX", rep);
302    }
303
304
305    /**
306     * Removes a specific repetition of OBX (OBSERVATION RESULT)
307     * @see AbstractGroup#removeRepetition(String, int) 
308     */
309    public OBX removeOBX(int rep) throws HL7Exception { 
310       return (OBX)super.removeRepetition("OBX", rep);
311    }
312
313
314
315    /**
316     * Returns
317     * the first repetition of 
318     * NTE2 (NOTES AND COMMENTS) - creates it if necessary
319     */
320    public NTE getNTE2() { 
321       NTE retVal = getTyped("NTE2", NTE.class);
322       return retVal;
323    }
324
325
326    /**
327     * Returns a specific repetition of
328     * NTE (NOTES AND COMMENTS) - creates it if necessary
329     *
330     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
331     * @throws HL7Exception if the repetition requested is more than one 
332     *     greater than the number of existing repetitions.
333     */
334    public NTE getNTE2(int rep) { 
335       NTE retVal = getTyped("NTE2", rep, NTE.class);
336       return retVal;
337    }
338
339    /** 
340     * Returns the number of existing repetitions of NTE2 
341     */ 
342    public int getNTE2Reps() {  
343        return getReps("NTE2");
344    } 
345
346    /** 
347     * <p>
348     * Returns a non-modifiable List containing all current existing repetitions of NTE2.
349     * <p>
350     * <p>
351     * Note that unlike {@link #getNTE2()}, this method will not create any reps
352     * if none are already present, so an empty list may be returned.
353     * </p>
354     */ 
355    public java.util.List<NTE> getNTE2All() throws HL7Exception {
356        return getAllAsList("NTE2", NTE.class);
357    } 
358
359    /**
360     * Inserts a specific repetition of NTE2 (NOTES AND COMMENTS)
361     * @see AbstractGroup#insertRepetition(Structure, int) 
362     */
363    public void insertNTE2(NTE structure, int rep) throws HL7Exception { 
364       super.insertRepetition("NTE2", structure, rep);
365    }
366
367
368    /**
369     * Inserts a specific repetition of NTE2 (NOTES AND COMMENTS)
370     * @see AbstractGroup#insertRepetition(Structure, int) 
371     */
372    public NTE insertNTE2(int rep) throws HL7Exception { 
373       return (NTE)super.insertRepetition("NTE2", rep);
374    }
375
376
377    /**
378     * Removes a specific repetition of NTE2 (NOTES AND COMMENTS)
379     * @see AbstractGroup#removeRepetition(String, int) 
380     */
381    public NTE removeNTE2(int rep) throws HL7Exception { 
382       return (NTE)super.removeRepetition("NTE2", rep);
383    }
384
385
386
387}
388