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