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