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.v28.group;
35
36 import ca.uhn.hl7v2.model.v28.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 RSP_Z82_COMMON_ORDER 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 (Common Order) <b> </b></li>
49 * <li>2: RSP_Z82_TIMING (a Group object) <b>optional repeating </b></li>
50 * <li>3: RSP_Z82_ORDER_DETAIL (a Group object) <b>optional </b></li>
51 * <li>4: RSP_Z82_ENCODED_ORDER (a Group object) <b>optional </b></li>
52 * <li>5: RXD (Pharmacy/Treatment Dispense) <b> </b></li>
53 * <li>6: RXR (Pharmacy/Treatment Route) <b> repeating </b></li>
54 * <li>7: RXC (Pharmacy/Treatment Component Order) <b>optional repeating </b></li>
55 * <li>8: RSP_Z82_OBSERVATION (a Group object) <b> repeating </b></li>
56 * </ul>
57 */
58 //@SuppressWarnings("unused")
59 public class RSP_Z82_COMMON_ORDER extends AbstractGroup {
60
61 /**
62 * Creates a new RSP_Z82_COMMON_ORDER group
63 */
64 public RSP_Z82_COMMON_ORDER(Group parent, ModelClassFactory factory) {
65 super(parent, factory);
66 init(factory);
67 }
68
69 private void init(ModelClassFactory factory) {
70 try {
71 this.add(ORC.class, true, false, false);
72 this.add(RSP_Z82_TIMING.class, false, true, false);
73 this.add(RSP_Z82_ORDER_DETAIL.class, false, false, false);
74 this.add(RSP_Z82_ENCODED_ORDER.class, false, false, false);
75 this.add(RXD.class, true, false, false);
76 this.add(RXR.class, true, true, false);
77 this.add(RXC.class, false, true, false);
78 this.add(RSP_Z82_OBSERVATION.class, true, true, false);
79 } catch(HL7Exception e) {
80 log.error("Unexpected error creating RSP_Z82_COMMON_ORDER - this is probably a bug in the source code generator.", e);
81 }
82 }
83
84 /**
85 * Returns "2.8"
86 */
87 public String getVersion() {
88 return "2.8";
89 }
90
91
92
93 /**
94 * Returns
95 * ORC (Common Order) - creates it if necessary
96 */
97 public ORC getORC() {
98 ORC retVal = getTyped("ORC", ORC.class);
99 return retVal;
100 }
101
102
103
104
105 /**
106 * Returns
107 * the first repetition of
108 * TIMING (a Group object) - creates it if necessary
109 */
110 public RSP_Z82_TIMING getTIMING() {
111 RSP_Z82_TIMING retVal = getTyped("TIMING", RSP_Z82_TIMING.class);
112 return retVal;
113 }
114
115
116 /**
117 * Returns a specific repetition of
118 * TIMING (a Group object) - creates it if necessary
119 *
120 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
121 * @throws HL7Exception if the repetition requested is more than one
122 * greater than the number of existing repetitions.
123 */
124 public RSP_Z82_TIMING getTIMING(int rep) {
125 RSP_Z82_TIMING retVal = getTyped("TIMING", rep, RSP_Z82_TIMING.class);
126 return retVal;
127 }
128
129 /**
130 * Returns the number of existing repetitions of TIMING
131 */
132 public int getTIMINGReps() {
133 return getReps("TIMING");
134 }
135
136 /**
137 * <p>
138 * Returns a non-modifiable List containing all current existing repetitions of TIMING.
139 * <p>
140 * <p>
141 * Note that unlike {@link #getTIMING()}, this method will not create any reps
142 * if none are already present, so an empty list may be returned.
143 * </p>
144 */
145 public java.util.List<RSP_Z82_TIMING> getTIMINGAll() throws HL7Exception {
146 return getAllAsList("TIMING", RSP_Z82_TIMING.class);
147 }
148
149 /**
150 * Inserts a specific repetition of TIMING (a Group object)
151 * @see AbstractGroup#insertRepetition(Structure, int)
152 */
153 public void insertTIMING(RSP_Z82_TIMING structure, int rep) throws HL7Exception {
154 super.insertRepetition("TIMING", structure, rep);
155 }
156
157
158 /**
159 * Inserts a specific repetition of TIMING (a Group object)
160 * @see AbstractGroup#insertRepetition(Structure, int)
161 */
162 public RSP_Z82_TIMING insertTIMING(int rep) throws HL7Exception {
163 return (RSP_Z82_TIMING)super.insertRepetition("TIMING", rep);
164 }
165
166
167 /**
168 * Removes a specific repetition of TIMING (a Group object)
169 * @see AbstractGroup#removeRepetition(String, int)
170 */
171 public RSP_Z82_TIMING removeTIMING(int rep) throws HL7Exception {
172 return (RSP_Z82_TIMING)super.removeRepetition("TIMING", rep);
173 }
174
175
176
177 /**
178 * Returns
179 * ORDER_DETAIL (a Group object) - creates it if necessary
180 */
181 public RSP_Z82_ORDER_DETAIL getORDER_DETAIL() {
182 RSP_Z82_ORDER_DETAIL retVal = getTyped("ORDER_DETAIL", RSP_Z82_ORDER_DETAIL.class);
183 return retVal;
184 }
185
186
187
188
189 /**
190 * Returns
191 * ENCODED_ORDER (a Group object) - creates it if necessary
192 */
193 public RSP_Z82_ENCODED_ORDER getENCODED_ORDER() {
194 RSP_Z82_ENCODED_ORDER retVal = getTyped("ENCODED_ORDER", RSP_Z82_ENCODED_ORDER.class);
195 return retVal;
196 }
197
198
199
200
201 /**
202 * Returns
203 * RXD (Pharmacy/Treatment Dispense) - creates it if necessary
204 */
205 public RXD getRXD() {
206 RXD retVal = getTyped("RXD", RXD.class);
207 return retVal;
208 }
209
210
211
212
213 /**
214 * Returns
215 * the first repetition of
216 * RXR (Pharmacy/Treatment Route) - creates it if necessary
217 */
218 public RXR getRXR() {
219 RXR retVal = getTyped("RXR", RXR.class);
220 return retVal;
221 }
222
223
224 /**
225 * Returns a specific repetition of
226 * RXR (Pharmacy/Treatment Route) - creates it if necessary
227 *
228 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
229 * @throws HL7Exception if the repetition requested is more than one
230 * greater than the number of existing repetitions.
231 */
232 public RXR getRXR(int rep) {
233 RXR retVal = getTyped("RXR", rep, RXR.class);
234 return retVal;
235 }
236
237 /**
238 * Returns the number of existing repetitions of RXR
239 */
240 public int getRXRReps() {
241 return getReps("RXR");
242 }
243
244 /**
245 * <p>
246 * Returns a non-modifiable List containing all current existing repetitions of RXR.
247 * <p>
248 * <p>
249 * Note that unlike {@link #getRXR()}, this method will not create any reps
250 * if none are already present, so an empty list may be returned.
251 * </p>
252 */
253 public java.util.List<RXR> getRXRAll() throws HL7Exception {
254 return getAllAsList("RXR", RXR.class);
255 }
256
257 /**
258 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
259 * @see AbstractGroup#insertRepetition(Structure, int)
260 */
261 public void insertRXR(RXR structure, int rep) throws HL7Exception {
262 super.insertRepetition("RXR", structure, rep);
263 }
264
265
266 /**
267 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
268 * @see AbstractGroup#insertRepetition(Structure, int)
269 */
270 public RXR insertRXR(int rep) throws HL7Exception {
271 return (RXR)super.insertRepetition("RXR", rep);
272 }
273
274
275 /**
276 * Removes a specific repetition of RXR (Pharmacy/Treatment Route)
277 * @see AbstractGroup#removeRepetition(String, int)
278 */
279 public RXR removeRXR(int rep) throws HL7Exception {
280 return (RXR)super.removeRepetition("RXR", rep);
281 }
282
283
284
285 /**
286 * Returns
287 * the first repetition of
288 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary
289 */
290 public RXC getRXC() {
291 RXC retVal = getTyped("RXC", RXC.class);
292 return retVal;
293 }
294
295
296 /**
297 * Returns a specific repetition of
298 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary
299 *
300 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
301 * @throws HL7Exception if the repetition requested is more than one
302 * greater than the number of existing repetitions.
303 */
304 public RXC getRXC(int rep) {
305 RXC retVal = getTyped("RXC", rep, RXC.class);
306 return retVal;
307 }
308
309 /**
310 * Returns the number of existing repetitions of RXC
311 */
312 public int getRXCReps() {
313 return getReps("RXC");
314 }
315
316 /**
317 * <p>
318 * Returns a non-modifiable List containing all current existing repetitions of RXC.
319 * <p>
320 * <p>
321 * Note that unlike {@link #getRXC()}, this method will not create any reps
322 * if none are already present, so an empty list may be returned.
323 * </p>
324 */
325 public java.util.List<RXC> getRXCAll() throws HL7Exception {
326 return getAllAsList("RXC", RXC.class);
327 }
328
329 /**
330 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
331 * @see AbstractGroup#insertRepetition(Structure, int)
332 */
333 public void insertRXC(RXC structure, int rep) throws HL7Exception {
334 super.insertRepetition("RXC", structure, rep);
335 }
336
337
338 /**
339 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
340 * @see AbstractGroup#insertRepetition(Structure, int)
341 */
342 public RXC insertRXC(int rep) throws HL7Exception {
343 return (RXC)super.insertRepetition("RXC", rep);
344 }
345
346
347 /**
348 * Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
349 * @see AbstractGroup#removeRepetition(String, int)
350 */
351 public RXC removeRXC(int rep) throws HL7Exception {
352 return (RXC)super.removeRepetition("RXC", rep);
353 }
354
355
356
357 /**
358 * Returns
359 * the first repetition of
360 * OBSERVATION (a Group object) - creates it if necessary
361 */
362 public RSP_Z82_OBSERVATION getOBSERVATION() {
363 RSP_Z82_OBSERVATION retVal = getTyped("OBSERVATION", RSP_Z82_OBSERVATION.class);
364 return retVal;
365 }
366
367
368 /**
369 * Returns a specific repetition of
370 * OBSERVATION (a Group object) - creates it if necessary
371 *
372 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
373 * @throws HL7Exception if the repetition requested is more than one
374 * greater than the number of existing repetitions.
375 */
376 public RSP_Z82_OBSERVATION getOBSERVATION(int rep) {
377 RSP_Z82_OBSERVATION retVal = getTyped("OBSERVATION", rep, RSP_Z82_OBSERVATION.class);
378 return retVal;
379 }
380
381 /**
382 * Returns the number of existing repetitions of OBSERVATION
383 */
384 public int getOBSERVATIONReps() {
385 return getReps("OBSERVATION");
386 }
387
388 /**
389 * <p>
390 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
391 * <p>
392 * <p>
393 * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
394 * if none are already present, so an empty list may be returned.
395 * </p>
396 */
397 public java.util.List<RSP_Z82_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
398 return getAllAsList("OBSERVATION", RSP_Z82_OBSERVATION.class);
399 }
400
401 /**
402 * Inserts a specific repetition of OBSERVATION (a Group object)
403 * @see AbstractGroup#insertRepetition(Structure, int)
404 */
405 public void insertOBSERVATION(RSP_Z82_OBSERVATION structure, int rep) throws HL7Exception {
406 super.insertRepetition("OBSERVATION", structure, rep);
407 }
408
409
410 /**
411 * Inserts a specific repetition of OBSERVATION (a Group object)
412 * @see AbstractGroup#insertRepetition(Structure, int)
413 */
414 public RSP_Z82_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
415 return (RSP_Z82_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
416 }
417
418
419 /**
420 * Removes a specific repetition of OBSERVATION (a Group object)
421 * @see AbstractGroup#removeRepetition(String, int)
422 */
423 public RSP_Z82_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
424 return (RSP_Z82_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
425 }
426
427
428
429 }
430