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.v26.group;
35
36 import ca.uhn.hl7v2.model.v26.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 RDR_RDR_DISPENSE 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: RXD (Pharmacy/Treatment Dispense) <b> </b></li>
50 * <li>3: RXR (Pharmacy/Treatment Route) <b> repeating </b></li>
51 * <li>4: TQ1 (Timing/Quantity) <b> </b></li>
52 * <li>5: RXC (Pharmacy/Treatment Component Order) <b>optional repeating </b></li>
53 * <li>6: TQ2 (Timing/Quantity Relationship) <b>optional repeating </b></li>
54 * </ul>
55 */
56 //@SuppressWarnings("unused")
57 public class RDR_RDR_DISPENSE extends AbstractGroup {
58
59 /**
60 * Creates a new RDR_RDR_DISPENSE group
61 */
62 public RDR_RDR_DISPENSE(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(RXD.class, true, false, false);
71 this.add(RXR.class, true, true, false);
72 this.add(TQ1.class, true, false, false);
73 this.add(RXC.class, false, true, false);
74 this.add(TQ2.class, false, true, false);
75 } catch(HL7Exception e) {
76 log.error("Unexpected error creating RDR_RDR_DISPENSE - this is probably a bug in the source code generator.", e);
77 }
78 }
79
80 /**
81 * Returns "2.6"
82 */
83 public String getVersion() {
84 return "2.6";
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 * RXD (Pharmacy/Treatment Dispense) - creates it if necessary
104 */
105 public RXD getRXD() {
106 RXD retVal = getTyped("RXD", RXD.class);
107 return retVal;
108 }
109
110
111
112
113 /**
114 * Returns
115 * the first repetition of
116 * RXR (Pharmacy/Treatment Route) - creates it if necessary
117 */
118 public RXR getRXR() {
119 RXR retVal = getTyped("RXR", RXR.class);
120 return retVal;
121 }
122
123
124 /**
125 * Returns a specific repetition of
126 * RXR (Pharmacy/Treatment Route) - creates it if necessary
127 *
128 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
129 * @throws HL7Exception if the repetition requested is more than one
130 * greater than the number of existing repetitions.
131 */
132 public RXR getRXR(int rep) {
133 RXR retVal = getTyped("RXR", rep, RXR.class);
134 return retVal;
135 }
136
137 /**
138 * Returns the number of existing repetitions of RXR
139 */
140 public int getRXRReps() {
141 return getReps("RXR");
142 }
143
144 /**
145 * <p>
146 * Returns a non-modifiable List containing all current existing repetitions of RXR.
147 * <p>
148 * <p>
149 * Note that unlike {@link #getRXR()}, this method will not create any reps
150 * if none are already present, so an empty list may be returned.
151 * </p>
152 */
153 public java.util.List<RXR> getRXRAll() throws HL7Exception {
154 return getAllAsList("RXR", RXR.class);
155 }
156
157 /**
158 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
159 * @see AbstractGroup#insertRepetition(Structure, int)
160 */
161 public void insertRXR(RXR structure, int rep) throws HL7Exception {
162 super.insertRepetition("RXR", structure, rep);
163 }
164
165
166 /**
167 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
168 * @see AbstractGroup#insertRepetition(Structure, int)
169 */
170 public RXR insertRXR(int rep) throws HL7Exception {
171 return (RXR)super.insertRepetition("RXR", rep);
172 }
173
174
175 /**
176 * Removes a specific repetition of RXR (Pharmacy/Treatment Route)
177 * @see AbstractGroup#removeRepetition(String, int)
178 */
179 public RXR removeRXR(int rep) throws HL7Exception {
180 return (RXR)super.removeRepetition("RXR", rep);
181 }
182
183
184
185 /**
186 * Returns
187 * TQ1 (Timing/Quantity) - creates it if necessary
188 */
189 public TQ1 getTQ1() {
190 TQ1 retVal = getTyped("TQ1", TQ1.class);
191 return retVal;
192 }
193
194
195
196
197 /**
198 * Returns
199 * the first repetition of
200 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary
201 */
202 public RXC getRXC() {
203 RXC retVal = getTyped("RXC", RXC.class);
204 return retVal;
205 }
206
207
208 /**
209 * Returns a specific repetition of
210 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary
211 *
212 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
213 * @throws HL7Exception if the repetition requested is more than one
214 * greater than the number of existing repetitions.
215 */
216 public RXC getRXC(int rep) {
217 RXC retVal = getTyped("RXC", rep, RXC.class);
218 return retVal;
219 }
220
221 /**
222 * Returns the number of existing repetitions of RXC
223 */
224 public int getRXCReps() {
225 return getReps("RXC");
226 }
227
228 /**
229 * <p>
230 * Returns a non-modifiable List containing all current existing repetitions of RXC.
231 * <p>
232 * <p>
233 * Note that unlike {@link #getRXC()}, this method will not create any reps
234 * if none are already present, so an empty list may be returned.
235 * </p>
236 */
237 public java.util.List<RXC> getRXCAll() throws HL7Exception {
238 return getAllAsList("RXC", RXC.class);
239 }
240
241 /**
242 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
243 * @see AbstractGroup#insertRepetition(Structure, int)
244 */
245 public void insertRXC(RXC structure, int rep) throws HL7Exception {
246 super.insertRepetition("RXC", structure, rep);
247 }
248
249
250 /**
251 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
252 * @see AbstractGroup#insertRepetition(Structure, int)
253 */
254 public RXC insertRXC(int rep) throws HL7Exception {
255 return (RXC)super.insertRepetition("RXC", rep);
256 }
257
258
259 /**
260 * Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
261 * @see AbstractGroup#removeRepetition(String, int)
262 */
263 public RXC removeRXC(int rep) throws HL7Exception {
264 return (RXC)super.removeRepetition("RXC", rep);
265 }
266
267
268
269 /**
270 * Returns
271 * the first repetition of
272 * TQ2 (Timing/Quantity Relationship) - creates it if necessary
273 */
274 public TQ2 getTQ2() {
275 TQ2 retVal = getTyped("TQ2", TQ2.class);
276 return retVal;
277 }
278
279
280 /**
281 * Returns a specific repetition of
282 * TQ2 (Timing/Quantity Relationship) - creates it if necessary
283 *
284 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
285 * @throws HL7Exception if the repetition requested is more than one
286 * greater than the number of existing repetitions.
287 */
288 public TQ2 getTQ2(int rep) {
289 TQ2 retVal = getTyped("TQ2", rep, TQ2.class);
290 return retVal;
291 }
292
293 /**
294 * Returns the number of existing repetitions of TQ2
295 */
296 public int getTQ2Reps() {
297 return getReps("TQ2");
298 }
299
300 /**
301 * <p>
302 * Returns a non-modifiable List containing all current existing repetitions of TQ2.
303 * <p>
304 * <p>
305 * Note that unlike {@link #getTQ2()}, this method will not create any reps
306 * if none are already present, so an empty list may be returned.
307 * </p>
308 */
309 public java.util.List<TQ2> getTQ2All() throws HL7Exception {
310 return getAllAsList("TQ2", TQ2.class);
311 }
312
313 /**
314 * Inserts a specific repetition of TQ2 (Timing/Quantity Relationship)
315 * @see AbstractGroup#insertRepetition(Structure, int)
316 */
317 public void insertTQ2(TQ2 structure, int rep) throws HL7Exception {
318 super.insertRepetition("TQ2", structure, rep);
319 }
320
321
322 /**
323 * Inserts a specific repetition of TQ2 (Timing/Quantity Relationship)
324 * @see AbstractGroup#insertRepetition(Structure, int)
325 */
326 public TQ2 insertTQ2(int rep) throws HL7Exception {
327 return (TQ2)super.insertRepetition("TQ2", rep);
328 }
329
330
331 /**
332 * Removes a specific repetition of TQ2 (Timing/Quantity Relationship)
333 * @see AbstractGroup#removeRepetition(String, int)
334 */
335 public TQ2 removeTQ2(int rep) throws HL7Exception {
336 return (TQ2)super.removeRepetition("TQ2", rep);
337 }
338
339
340
341 }
342