1 /*
2 * This class is an auto-generated source file for a HAPI
3 * HL7 v2.x standard structure class.
4 *
5 * For more information, visit: http://hl7api.sourceforge.net/
6 *
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * (the "License"); you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
12 * specific language governing rights and limitations under the License.
13 *
14 * The Original Code is "[file_name]". Description:
15 * "[one_line_description]"
16 *
17 * The Initial Developer of the Original Code is University Health Network. Copyright (C)
18 * 2012. All Rights Reserved.
19 *
20 * Contributor(s): ______________________________________.
21 *
22 * Alternatively, the contents of this file may be used under the terms of the
23 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are
24 * applicable instead of those above. If you wish to allow use of your version of this
25 * file only under the terms of the GPL and not to allow others to use your version
26 * of this file under the MPL, indicate your decision by deleting the provisions above
27 * and replace them with the notice and other provisions required by the GPL License.
28 * If you do not delete the provisions above, a recipient may use your version of
29 * this file under either the MPL or the GPL.
30 *
31 */
32
33
34 package ca.uhn.hl7v2.model.v231.group;
35
36 import ca.uhn.hl7v2.model.v231.segment.*;
37
38 import ca.uhn.hl7v2.HL7Exception;
39 import ca.uhn.hl7v2.parser.ModelClassFactory;
40 import ca.uhn.hl7v2.model.*;
41
42 /**
43 * <p>Represents a RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI group structure (a Group object).
44 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
45 * This Group contains the following elements:
46 * </p>
47 * <ul>
48 * <li>1: ORC (ORC - common order segment) <b> </b></li>
49 * <li>2: RAS_O01_RXONTERXRRXCNTE (a Group object) <b>optional </b></li>
50 * <li>3: RAS_O01_RXERXRRXC (a Group object) <b>optional </b></li>
51 * <li>4: RXA (RXA - pharmacy/treatment administration segment) <b> repeating </b></li>
52 * <li>5: RXR (RXR - pharmacy/treatment route segment) <b> </b></li>
53 * <li>6: RAS_O01_OBXNTE (a Group object) <b>optional repeating </b></li>
54 * <li>7: CTI (CTI - clinical trial identification segment) <b>optional repeating </b></li>
55 * </ul>
56 */
57 //@SuppressWarnings("unused")
58 public class RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI extends AbstractGroup {
59
60 /**
61 * Creates a new RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI group
62 */
63 public RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI(Group parent, ModelClassFactory factory) {
64 super(parent, factory);
65 init(factory);
66 }
67
68 private void init(ModelClassFactory factory) {
69 try {
70 this.add(ORC.class, true, false, false);
71 this.add(RAS_O01_RXONTERXRRXCNTE.class, false, false, false);
72 this.add(RAS_O01_RXERXRRXC.class, false, false, false);
73 this.add(RXA.class, true, true, false);
74 this.add(RXR.class, true, false, false);
75 this.add(RAS_O01_OBXNTE.class, false, true, false);
76 this.add(CTI.class, false, true, false);
77 } catch(HL7Exception e) {
78 log.error("Unexpected error creating RAS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXARXROBXNTECTI - this is probably a bug in the source code generator.", e);
79 }
80 }
81
82 /**
83 * Returns "2.3.1"
84 */
85 public String getVersion() {
86 return "2.3.1";
87 }
88
89
90
91 /**
92 * Returns
93 * ORC (ORC - common order segment) - creates it if necessary
94 */
95 public ORC getORC() {
96 ORC retVal = getTyped("ORC", ORC.class);
97 return retVal;
98 }
99
100
101
102
103 /**
104 * Returns
105 * RXONTERXRRXCNTE (a Group object) - creates it if necessary
106 */
107 public RAS_O01_RXONTERXRRXCNTE getRXONTERXRRXCNTE() {
108 RAS_O01_RXONTERXRRXCNTE retVal = getTyped("RXONTERXRRXCNTE", RAS_O01_RXONTERXRRXCNTE.class);
109 return retVal;
110 }
111
112
113
114
115 /**
116 * Returns
117 * RXERXRRXC (a Group object) - creates it if necessary
118 */
119 public RAS_O01_RXERXRRXC getRXERXRRXC() {
120 RAS_O01_RXERXRRXC retVal = getTyped("RXERXRRXC", RAS_O01_RXERXRRXC.class);
121 return retVal;
122 }
123
124
125
126
127 /**
128 * Returns
129 * the first repetition of
130 * RXA (RXA - pharmacy/treatment administration segment) - creates it if necessary
131 */
132 public RXA getRXA() {
133 RXA retVal = getTyped("RXA", RXA.class);
134 return retVal;
135 }
136
137
138 /**
139 * Returns a specific repetition of
140 * RXA (RXA - pharmacy/treatment administration 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 RXA getRXA(int rep) {
147 RXA retVal = getTyped("RXA", rep, RXA.class);
148 return retVal;
149 }
150
151 /**
152 * Returns the number of existing repetitions of RXA
153 */
154 public int getRXAReps() {
155 return getReps("RXA");
156 }
157
158 /**
159 * <p>
160 * Returns a non-modifiable List containing all current existing repetitions of RXA.
161 * <p>
162 * <p>
163 * Note that unlike {@link #getRXA()}, 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<RXA> getRXAAll() throws HL7Exception {
168 return getAllAsList("RXA", RXA.class);
169 }
170
171 /**
172 * Inserts a specific repetition of RXA (RXA - pharmacy/treatment administration segment)
173 * @see AbstractGroup#insertRepetition(Structure, int)
174 */
175 public void insertRXA(RXA structure, int rep) throws HL7Exception {
176 super.insertRepetition("RXA", structure, rep);
177 }
178
179
180 /**
181 * Inserts a specific repetition of RXA (RXA - pharmacy/treatment administration segment)
182 * @see AbstractGroup#insertRepetition(Structure, int)
183 */
184 public RXA insertRXA(int rep) throws HL7Exception {
185 return (RXA)super.insertRepetition("RXA", rep);
186 }
187
188
189 /**
190 * Removes a specific repetition of RXA (RXA - pharmacy/treatment administration segment)
191 * @see AbstractGroup#removeRepetition(String, int)
192 */
193 public RXA removeRXA(int rep) throws HL7Exception {
194 return (RXA)super.removeRepetition("RXA", rep);
195 }
196
197
198
199 /**
200 * Returns
201 * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
202 */
203 public RXR getRXR() {
204 RXR retVal = getTyped("RXR", RXR.class);
205 return retVal;
206 }
207
208
209
210
211 /**
212 * Returns
213 * the first repetition of
214 * OBXNTE (a Group object) - creates it if necessary
215 */
216 public RAS_O01_OBXNTE getOBXNTE() {
217 RAS_O01_OBXNTE retVal = getTyped("OBXNTE", RAS_O01_OBXNTE.class);
218 return retVal;
219 }
220
221
222 /**
223 * Returns a specific repetition of
224 * OBXNTE (a Group object) - creates it if necessary
225 *
226 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
227 * @throws HL7Exception if the repetition requested is more than one
228 * greater than the number of existing repetitions.
229 */
230 public RAS_O01_OBXNTE getOBXNTE(int rep) {
231 RAS_O01_OBXNTE retVal = getTyped("OBXNTE", rep, RAS_O01_OBXNTE.class);
232 return retVal;
233 }
234
235 /**
236 * Returns the number of existing repetitions of OBXNTE
237 */
238 public int getOBXNTEReps() {
239 return getReps("OBXNTE");
240 }
241
242 /**
243 * <p>
244 * Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
245 * <p>
246 * <p>
247 * Note that unlike {@link #getOBXNTE()}, this method will not create any reps
248 * if none are already present, so an empty list may be returned.
249 * </p>
250 */
251 public java.util.List<RAS_O01_OBXNTE> getOBXNTEAll() throws HL7Exception {
252 return getAllAsList("OBXNTE", RAS_O01_OBXNTE.class);
253 }
254
255 /**
256 * Inserts a specific repetition of OBXNTE (a Group object)
257 * @see AbstractGroup#insertRepetition(Structure, int)
258 */
259 public void insertOBXNTE(RAS_O01_OBXNTE structure, int rep) throws HL7Exception {
260 super.insertRepetition("OBXNTE", structure, rep);
261 }
262
263
264 /**
265 * Inserts a specific repetition of OBXNTE (a Group object)
266 * @see AbstractGroup#insertRepetition(Structure, int)
267 */
268 public RAS_O01_OBXNTE insertOBXNTE(int rep) throws HL7Exception {
269 return (RAS_O01_OBXNTE)super.insertRepetition("OBXNTE", rep);
270 }
271
272
273 /**
274 * Removes a specific repetition of OBXNTE (a Group object)
275 * @see AbstractGroup#removeRepetition(String, int)
276 */
277 public RAS_O01_OBXNTE removeOBXNTE(int rep) throws HL7Exception {
278 return (RAS_O01_OBXNTE)super.removeRepetition("OBXNTE", rep);
279 }
280
281
282
283 /**
284 * Returns
285 * the first repetition of
286 * CTI (CTI - clinical trial identification segment) - creates it if necessary
287 */
288 public CTI getCTI() {
289 CTI retVal = getTyped("CTI", CTI.class);
290 return retVal;
291 }
292
293
294 /**
295 * Returns a specific repetition of
296 * CTI (CTI - clinical trial identification segment) - creates it if necessary
297 *
298 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
299 * @throws HL7Exception if the repetition requested is more than one
300 * greater than the number of existing repetitions.
301 */
302 public CTI getCTI(int rep) {
303 CTI retVal = getTyped("CTI", rep, CTI.class);
304 return retVal;
305 }
306
307 /**
308 * Returns the number of existing repetitions of CTI
309 */
310 public int getCTIReps() {
311 return getReps("CTI");
312 }
313
314 /**
315 * <p>
316 * Returns a non-modifiable List containing all current existing repetitions of CTI.
317 * <p>
318 * <p>
319 * Note that unlike {@link #getCTI()}, this method will not create any reps
320 * if none are already present, so an empty list may be returned.
321 * </p>
322 */
323 public java.util.List<CTI> getCTIAll() throws HL7Exception {
324 return getAllAsList("CTI", CTI.class);
325 }
326
327 /**
328 * Inserts a specific repetition of CTI (CTI - clinical trial identification segment)
329 * @see AbstractGroup#insertRepetition(Structure, int)
330 */
331 public void insertCTI(CTI structure, int rep) throws HL7Exception {
332 super.insertRepetition("CTI", structure, rep);
333 }
334
335
336 /**
337 * Inserts a specific repetition of CTI (CTI - clinical trial identification segment)
338 * @see AbstractGroup#insertRepetition(Structure, int)
339 */
340 public CTI insertCTI(int rep) throws HL7Exception {
341 return (CTI)super.insertRepetition("CTI", rep);
342 }
343
344
345 /**
346 * Removes a specific repetition of CTI (CTI - clinical trial identification segment)
347 * @see AbstractGroup#removeRepetition(String, int)
348 */
349 public CTI removeCTI(int rep) throws HL7Exception {
350 return (CTI)super.removeRepetition("CTI", rep);
351 }
352
353
354
355 }
356