Source code

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.v231.group;
035
036import ca.uhn.hl7v2.model.v231.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI 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: ORC (ORC - common order segment) <b>  </b></li>
049                         * <li>2: RDE_O01_RXONTERXRRXCNTE (a Group object) <b>optional  </b></li>
050                         * <li>3: RXE (RXE - pharmacy/treatment encoded order segment) <b>  </b></li>
051                         * <li>4: RXR (RXR - pharmacy/treatment route segment) <b> repeating </b></li>
052                         * <li>5: RXC (RXC - pharmacy/treatment component order segment) <b>optional repeating </b></li>
053                         * <li>6: RDE_O01_OBXNTE (a Group object) <b>optional repeating </b></li>
054                         * <li>7: CTI (CTI - clinical trial identification segment) <b>optional repeating </b></li>
055 * </ul>
056 */
057//@SuppressWarnings("unused")
058public class RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI extends AbstractGroup {
059
060    /** 
061     * Creates a new RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI group
062     */
063    public RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI(Group parent, ModelClassFactory factory) {
064       super(parent, factory);
065       init(factory);
066    }
067
068    private void init(ModelClassFactory factory) {
069       try {
070                                  this.add(ORC.class, true, false, false);
071                                  this.add(RDE_O01_RXONTERXRRXCNTE.class, false, false, false);
072                                  this.add(RXE.class, true, false, false);
073                                  this.add(RXR.class, true, true, false);
074                                  this.add(RXC.class, false, true, false);
075                                  this.add(RDE_O01_OBXNTE.class, false, true, false);
076                                  this.add(CTI.class, false, true, false);
077       } catch(HL7Exception e) {
078          log.error("Unexpected error creating RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI - this is probably a bug in the source code generator.", e);
079       }
080    }
081
082    /** 
083     * Returns "2.3.1"
084     */
085    public String getVersion() {
086       return "2.3.1";
087    }
088
089
090
091    /**
092     * Returns
093     * ORC (ORC - common order segment) - creates it if necessary
094     */
095    public ORC getORC() { 
096       ORC retVal = getTyped("ORC", ORC.class);
097       return retVal;
098    }
099
100
101
102
103    /**
104     * Returns
105     * RXONTERXRRXCNTE (a Group object) - creates it if necessary
106     */
107    public RDE_O01_RXONTERXRRXCNTE getRXONTERXRRXCNTE() { 
108       RDE_O01_RXONTERXRRXCNTE retVal = getTyped("RXONTERXRRXCNTE", RDE_O01_RXONTERXRRXCNTE.class);
109       return retVal;
110    }
111
112
113
114
115    /**
116     * Returns
117     * RXE (RXE - pharmacy/treatment encoded order segment) - creates it if necessary
118     */
119    public RXE getRXE() { 
120       RXE retVal = getTyped("RXE", RXE.class);
121       return retVal;
122    }
123
124
125
126
127    /**
128     * Returns
129     * the first repetition of 
130     * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
131     */
132    public RXR getRXR() { 
133       RXR retVal = getTyped("RXR", RXR.class);
134       return retVal;
135    }
136
137
138    /**
139     * Returns a specific repetition of
140     * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
141     *
142     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
143     * @throws HL7Exception if the repetition requested is more than one 
144     *     greater than the number of existing repetitions.
145     */
146    public RXR getRXR(int rep) { 
147       RXR retVal = getTyped("RXR", rep, RXR.class);
148       return retVal;
149    }
150
151    /** 
152     * Returns the number of existing repetitions of RXR 
153     */ 
154    public int getRXRReps() {  
155        return getReps("RXR");
156    } 
157
158    /** 
159     * <p>
160     * Returns a non-modifiable List containing all current existing repetitions of RXR.
161     * <p>
162     * <p>
163     * Note that unlike {@link #getRXR()}, this method will not create any reps
164     * if none are already present, so an empty list may be returned.
165     * </p>
166     */ 
167    public java.util.List<RXR> getRXRAll() throws HL7Exception {
168        return getAllAsList("RXR", RXR.class);
169    } 
170
171    /**
172     * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
173     * @see AbstractGroup#insertRepetition(Structure, int) 
174     */
175    public void insertRXR(RXR structure, int rep) throws HL7Exception { 
176       super.insertRepetition("RXR", structure, rep);
177    }
178
179
180    /**
181     * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
182     * @see AbstractGroup#insertRepetition(Structure, int) 
183     */
184    public RXR insertRXR(int rep) throws HL7Exception { 
185       return (RXR)super.insertRepetition("RXR", rep);
186    }
187
188
189    /**
190     * Removes a specific repetition of RXR (RXR - pharmacy/treatment route segment)
191     * @see AbstractGroup#removeRepetition(String, int) 
192     */
193    public RXR removeRXR(int rep) throws HL7Exception { 
194       return (RXR)super.removeRepetition("RXR", rep);
195    }
196
197
198
199    /**
200     * Returns
201     * the first repetition of 
202     * RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
203     */
204    public RXC getRXC() { 
205       RXC retVal = getTyped("RXC", RXC.class);
206       return retVal;
207    }
208
209
210    /**
211     * Returns a specific repetition of
212     * RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
213     *
214     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
215     * @throws HL7Exception if the repetition requested is more than one 
216     *     greater than the number of existing repetitions.
217     */
218    public RXC getRXC(int rep) { 
219       RXC retVal = getTyped("RXC", rep, RXC.class);
220       return retVal;
221    }
222
223    /** 
224     * Returns the number of existing repetitions of RXC 
225     */ 
226    public int getRXCReps() {  
227        return getReps("RXC");
228    } 
229
230    /** 
231     * <p>
232     * Returns a non-modifiable List containing all current existing repetitions of RXC.
233     * <p>
234     * <p>
235     * Note that unlike {@link #getRXC()}, this method will not create any reps
236     * if none are already present, so an empty list may be returned.
237     * </p>
238     */ 
239    public java.util.List<RXC> getRXCAll() throws HL7Exception {
240        return getAllAsList("RXC", RXC.class);
241    } 
242
243    /**
244     * Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
245     * @see AbstractGroup#insertRepetition(Structure, int) 
246     */
247    public void insertRXC(RXC structure, int rep) throws HL7Exception { 
248       super.insertRepetition("RXC", structure, rep);
249    }
250
251
252    /**
253     * Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
254     * @see AbstractGroup#insertRepetition(Structure, int) 
255     */
256    public RXC insertRXC(int rep) throws HL7Exception { 
257       return (RXC)super.insertRepetition("RXC", rep);
258    }
259
260
261    /**
262     * Removes a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
263     * @see AbstractGroup#removeRepetition(String, int) 
264     */
265    public RXC removeRXC(int rep) throws HL7Exception { 
266       return (RXC)super.removeRepetition("RXC", rep);
267    }
268
269
270
271    /**
272     * Returns
273     * the first repetition of 
274     * OBXNTE (a Group object) - creates it if necessary
275     */
276    public RDE_O01_OBXNTE getOBXNTE() { 
277       RDE_O01_OBXNTE retVal = getTyped("OBXNTE", RDE_O01_OBXNTE.class);
278       return retVal;
279    }
280
281
282    /**
283     * Returns a specific repetition of
284     * OBXNTE (a Group object) - creates it if necessary
285     *
286     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
287     * @throws HL7Exception if the repetition requested is more than one 
288     *     greater than the number of existing repetitions.
289     */
290    public RDE_O01_OBXNTE getOBXNTE(int rep) { 
291       RDE_O01_OBXNTE retVal = getTyped("OBXNTE", rep, RDE_O01_OBXNTE.class);
292       return retVal;
293    }
294
295    /** 
296     * Returns the number of existing repetitions of OBXNTE 
297     */ 
298    public int getOBXNTEReps() {  
299        return getReps("OBXNTE");
300    } 
301
302    /** 
303     * <p>
304     * Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
305     * <p>
306     * <p>
307     * Note that unlike {@link #getOBXNTE()}, this method will not create any reps
308     * if none are already present, so an empty list may be returned.
309     * </p>
310     */ 
311    public java.util.List<RDE_O01_OBXNTE> getOBXNTEAll() throws HL7Exception {
312        return getAllAsList("OBXNTE", RDE_O01_OBXNTE.class);
313    } 
314
315    /**
316     * Inserts a specific repetition of OBXNTE (a Group object)
317     * @see AbstractGroup#insertRepetition(Structure, int) 
318     */
319    public void insertOBXNTE(RDE_O01_OBXNTE structure, int rep) throws HL7Exception { 
320       super.insertRepetition("OBXNTE", structure, rep);
321    }
322
323
324    /**
325     * Inserts a specific repetition of OBXNTE (a Group object)
326     * @see AbstractGroup#insertRepetition(Structure, int) 
327     */
328    public RDE_O01_OBXNTE insertOBXNTE(int rep) throws HL7Exception { 
329       return (RDE_O01_OBXNTE)super.insertRepetition("OBXNTE", rep);
330    }
331
332
333    /**
334     * Removes a specific repetition of OBXNTE (a Group object)
335     * @see AbstractGroup#removeRepetition(String, int) 
336     */
337    public RDE_O01_OBXNTE removeOBXNTE(int rep) throws HL7Exception { 
338       return (RDE_O01_OBXNTE)super.removeRepetition("OBXNTE", rep);
339    }
340
341
342
343    /**
344     * Returns
345     * the first repetition of 
346     * CTI (CTI - clinical trial identification segment) - creates it if necessary
347     */
348    public CTI getCTI() { 
349       CTI retVal = getTyped("CTI", CTI.class);
350       return retVal;
351    }
352
353
354    /**
355     * Returns a specific repetition of
356     * CTI (CTI - clinical trial identification segment) - creates it if necessary
357     *
358     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
359     * @throws HL7Exception if the repetition requested is more than one 
360     *     greater than the number of existing repetitions.
361     */
362    public CTI getCTI(int rep) { 
363       CTI retVal = getTyped("CTI", rep, CTI.class);
364       return retVal;
365    }
366
367    /** 
368     * Returns the number of existing repetitions of CTI 
369     */ 
370    public int getCTIReps() {  
371        return getReps("CTI");
372    } 
373
374    /** 
375     * <p>
376     * Returns a non-modifiable List containing all current existing repetitions of CTI.
377     * <p>
378     * <p>
379     * Note that unlike {@link #getCTI()}, this method will not create any reps
380     * if none are already present, so an empty list may be returned.
381     * </p>
382     */ 
383    public java.util.List<CTI> getCTIAll() throws HL7Exception {
384        return getAllAsList("CTI", CTI.class);
385    } 
386
387    /**
388     * Inserts a specific repetition of CTI (CTI - clinical trial identification segment)
389     * @see AbstractGroup#insertRepetition(Structure, int) 
390     */
391    public void insertCTI(CTI structure, int rep) throws HL7Exception { 
392       super.insertRepetition("CTI", structure, rep);
393    }
394
395
396    /**
397     * Inserts a specific repetition of CTI (CTI - clinical trial identification segment)
398     * @see AbstractGroup#insertRepetition(Structure, int) 
399     */
400    public CTI insertCTI(int rep) throws HL7Exception { 
401       return (CTI)super.insertRepetition("CTI", rep);
402    }
403
404
405    /**
406     * Removes a specific repetition of CTI (CTI - clinical trial identification segment)
407     * @see AbstractGroup#removeRepetition(String, int) 
408     */
409    public CTI removeCTI(int rep) throws HL7Exception { 
410       return (CTI)super.removeRepetition("CTI", rep);
411    }
412
413
414
415}
416