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