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.v25.group;
035
036import ca.uhn.hl7v2.model.v25.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 VXR_V03_ORDER 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: ORC (Common Order) <b> </b></li>
051                 * <li>2: VXR_V03_TIMING (a Group object) <b>optional repeating</b></li>
052                 * <li>3: RXA (Pharmacy/Treatment Administration) <b> </b></li>
053                 * <li>4: RXR (Pharmacy/Treatment Route) <b>optional </b></li>
054                 * <li>5: VXR_V03_OBSERVATION (a Group object) <b>optional repeating</b></li>
055 * </ul>
056 */
057@SuppressWarnings("unused")
058public class VXR_V03_ORDER extends AbstractGroup {
059
060    /** 
061     * Creates a new VXR_V03_ORDER group
062     */
063    public VXR_V03_ORDER(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);
071                          this.add(VXR_V03_TIMING.class, false, true);
072                          this.add(RXA.class, true, false);
073                          this.add(RXR.class, false, false);
074                          this.add(VXR_V03_OBSERVATION.class, false, true);
075       } catch(HL7Exception e) {
076          log.error("Unexpected error creating VXR_V03_ORDER - this is probably a bug in the source code generator.", e);
077       }
078    }
079
080    /** 
081     * Returns "2.5"
082     */
083    public String getVersion() {
084       return "2.5";
085    }
086
087
088
089    /**
090     * Returns
091     * ORC (Common Order) - creates it if necessary
092     */
093    public ORC getORC() { 
094       ORC retVal = getTyped("ORC", ORC.class);
095       return retVal;
096    }
097
098
099
100
101    /**
102     * Returns
103     * the first repetition of 
104     * TIMING (a Group object) - creates it if necessary
105     */
106    public VXR_V03_TIMING getTIMING() { 
107       VXR_V03_TIMING retVal = getTyped("TIMING", VXR_V03_TIMING.class);
108       return retVal;
109    }
110
111
112    /**
113     * Returns a specific repetition of
114     * TIMING (a Group object) - creates it if necessary
115     *
116     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
117     * @throws HL7Exception if the repetition requested is more than one 
118     *     greater than the number of existing repetitions.
119     */
120    public VXR_V03_TIMING getTIMING(int rep) { 
121       VXR_V03_TIMING retVal = getTyped("TIMING", rep, VXR_V03_TIMING.class);
122       return retVal;
123    }
124
125    /** 
126     * Returns the number of existing repetitions of TIMING 
127     */ 
128    public int getTIMINGReps() {  
129        return getReps("TIMING");
130    } 
131
132    /** 
133     * <p>
134     * Returns a non-modifiable List containing all current existing repetitions of TIMING.
135     * <p>
136     * <p>
137     * Note that unlike {@link #getTIMING()}, this method will not create any reps
138     * if none are already present, so an empty list may be returned.
139     * </p>
140     */ 
141    public List<VXR_V03_TIMING> getTIMINGAll() throws HL7Exception {
142        return getAllAsList("TIMING", VXR_V03_TIMING.class);
143    } 
144
145    /**
146     * Inserts a specific repetition of TIMING (a Group object)
147     * @see AbstractGroup#insertRepetition(Structure, int) 
148     */
149    public void insertTIMING(VXR_V03_TIMING structure, int rep) throws HL7Exception { 
150       super.insertRepetition("TIMING", structure, rep);
151    }
152
153
154    /**
155     * Inserts a specific repetition of TIMING (a Group object)
156     * @see AbstractGroup#insertRepetition(Structure, int) 
157     */
158    public VXR_V03_TIMING insertTIMING(int rep) throws HL7Exception { 
159       return (VXR_V03_TIMING)super.insertRepetition("TIMING", rep);
160    }
161
162
163    /**
164     * Removes a specific repetition of TIMING (a Group object)
165     * @see AbstractGroup#removeRepetition(String, int) 
166     */
167    public VXR_V03_TIMING removeTIMING(int rep) throws HL7Exception { 
168       return (VXR_V03_TIMING)super.removeRepetition("TIMING", rep);
169    }
170
171
172
173    /**
174     * Returns
175     * RXA (Pharmacy/Treatment Administration) - creates it if necessary
176     */
177    public RXA getRXA() { 
178       RXA retVal = getTyped("RXA", RXA.class);
179       return retVal;
180    }
181
182
183
184
185    /**
186     * Returns
187     * RXR (Pharmacy/Treatment Route) - creates it if necessary
188     */
189    public RXR getRXR() { 
190       RXR retVal = getTyped("RXR", RXR.class);
191       return retVal;
192    }
193
194
195
196
197    /**
198     * Returns
199     * the first repetition of 
200     * OBSERVATION (a Group object) - creates it if necessary
201     */
202    public VXR_V03_OBSERVATION getOBSERVATION() { 
203       VXR_V03_OBSERVATION retVal = getTyped("OBSERVATION", VXR_V03_OBSERVATION.class);
204       return retVal;
205    }
206
207
208    /**
209     * Returns a specific repetition of
210     * OBSERVATION (a Group object) - creates it if necessary
211     *
212     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
213     * @throws HL7Exception if the repetition requested is more than one 
214     *     greater than the number of existing repetitions.
215     */
216    public VXR_V03_OBSERVATION getOBSERVATION(int rep) { 
217       VXR_V03_OBSERVATION retVal = getTyped("OBSERVATION", rep, VXR_V03_OBSERVATION.class);
218       return retVal;
219    }
220
221    /** 
222     * Returns the number of existing repetitions of OBSERVATION 
223     */ 
224    public int getOBSERVATIONReps() {  
225        return getReps("OBSERVATION");
226    } 
227
228    /** 
229     * <p>
230     * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
231     * <p>
232     * <p>
233     * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
234     * if none are already present, so an empty list may be returned.
235     * </p>
236     */ 
237    public List<VXR_V03_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
238        return getAllAsList("OBSERVATION", VXR_V03_OBSERVATION.class);
239    } 
240
241    /**
242     * Inserts a specific repetition of OBSERVATION (a Group object)
243     * @see AbstractGroup#insertRepetition(Structure, int) 
244     */
245    public void insertOBSERVATION(VXR_V03_OBSERVATION structure, int rep) throws HL7Exception { 
246       super.insertRepetition("OBSERVATION", structure, rep);
247    }
248
249
250    /**
251     * Inserts a specific repetition of OBSERVATION (a Group object)
252     * @see AbstractGroup#insertRepetition(Structure, int) 
253     */
254    public VXR_V03_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 
255       return (VXR_V03_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
256    }
257
258
259    /**
260     * Removes a specific repetition of OBSERVATION (a Group object)
261     * @see AbstractGroup#removeRepetition(String, int) 
262     */
263    public VXR_V03_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 
264       return (VXR_V03_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
265    }
266
267
268
269}
270