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.v25.group;
35
36 import ca.uhn.hl7v2.model.v25.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 OSR_Q06_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: OSR_Q06_TIMING (a Group object) <b>optional repeating </b></li>
50 * <li>3: OBR (Observation Request) <b> choice</b></li>
51 * <li>4: RQD (Requisition Detail) <b> choice</b></li>
52 * <li>5: RQ1 (Requisition Detail-1) <b> choice</b></li>
53 * <li>6: RXO (Pharmacy/Treatment Order) <b> choice</b></li>
54 * <li>7: ODS (Dietary Orders, Supplements, and Preferences) <b> choice</b></li>
55 * <li>8: ODT (Diet Tray Instructions) <b> choice</b></li>
56 * <li>9: NTE (Notes and Comments) <b>optional repeating </b></li>
57 * <li>10: CTI (Clinical Trial Identification) <b>optional repeating </b></li>
58 * </ul>
59 * <p>
60 * Note that this structure has "choice" elements. This means that one of the
61 * structures above marked as "choice" must be present, but no more than one.
62 * </p>
63 */
64 //@SuppressWarnings("unused")
65 public class OSR_Q06_ORDER extends AbstractGroup {
66
67 /**
68 * Creates a new OSR_Q06_ORDER group
69 */
70 public OSR_Q06_ORDER(Group parent, ModelClassFactory factory) {
71 super(parent, factory);
72 init(factory);
73 }
74
75 private void init(ModelClassFactory factory) {
76 try {
77 this.add(ORC.class, true, false, false);
78 this.add(OSR_Q06_TIMING.class, false, true, false);
79 this.add(OBR.class, true, false, true);
80 this.add(RQD.class, true, false, true);
81 this.add(RQ1.class, true, false, true);
82 this.add(RXO.class, true, false, true);
83 this.add(ODS.class, true, false, true);
84 this.add(ODT.class, true, false, true);
85 this.add(NTE.class, false, true, false);
86 this.add(CTI.class, false, true, false);
87 } catch(HL7Exception e) {
88 log.error("Unexpected error creating OSR_Q06_ORDER - this is probably a bug in the source code generator.", e);
89 }
90 }
91
92 /**
93 * Returns "2.5"
94 */
95 public String getVersion() {
96 return "2.5";
97 }
98
99
100
101 /**
102 * Returns
103 * ORC (Common Order) - creates it if necessary
104 */
105 public ORC getORC() {
106 ORC retVal = getTyped("ORC", ORC.class);
107 return retVal;
108 }
109
110
111
112
113 /**
114 * Returns
115 * the first repetition of
116 * TIMING (a Group object) - creates it if necessary
117 */
118 public OSR_Q06_TIMING getTIMING() {
119 OSR_Q06_TIMING retVal = getTyped("TIMING", OSR_Q06_TIMING.class);
120 return retVal;
121 }
122
123
124 /**
125 * Returns a specific repetition of
126 * TIMING (a Group object) - 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 OSR_Q06_TIMING getTIMING(int rep) {
133 OSR_Q06_TIMING retVal = getTyped("TIMING", rep, OSR_Q06_TIMING.class);
134 return retVal;
135 }
136
137 /**
138 * Returns the number of existing repetitions of TIMING
139 */
140 public int getTIMINGReps() {
141 return getReps("TIMING");
142 }
143
144 /**
145 * <p>
146 * Returns a non-modifiable List containing all current existing repetitions of TIMING.
147 * <p>
148 * <p>
149 * Note that unlike {@link #getTIMING()}, 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<OSR_Q06_TIMING> getTIMINGAll() throws HL7Exception {
154 return getAllAsList("TIMING", OSR_Q06_TIMING.class);
155 }
156
157 /**
158 * Inserts a specific repetition of TIMING (a Group object)
159 * @see AbstractGroup#insertRepetition(Structure, int)
160 */
161 public void insertTIMING(OSR_Q06_TIMING structure, int rep) throws HL7Exception {
162 super.insertRepetition("TIMING", structure, rep);
163 }
164
165
166 /**
167 * Inserts a specific repetition of TIMING (a Group object)
168 * @see AbstractGroup#insertRepetition(Structure, int)
169 */
170 public OSR_Q06_TIMING insertTIMING(int rep) throws HL7Exception {
171 return (OSR_Q06_TIMING)super.insertRepetition("TIMING", rep);
172 }
173
174
175 /**
176 * Removes a specific repetition of TIMING (a Group object)
177 * @see AbstractGroup#removeRepetition(String, int)
178 */
179 public OSR_Q06_TIMING removeTIMING(int rep) throws HL7Exception {
180 return (OSR_Q06_TIMING)super.removeRepetition("TIMING", rep);
181 }
182
183
184
185 /**
186 * Returns
187 * OBR (Observation Request) - creates it if necessary
188 */
189 public OBR getOBR() {
190 OBR retVal = getTyped("OBR", OBR.class);
191 return retVal;
192 }
193
194
195
196
197 /**
198 * Returns
199 * RQD (Requisition Detail) - creates it if necessary
200 */
201 public RQD getRQD() {
202 RQD retVal = getTyped("RQD", RQD.class);
203 return retVal;
204 }
205
206
207
208
209 /**
210 * Returns
211 * RQ1 (Requisition Detail-1) - creates it if necessary
212 */
213 public RQ1 getRQ1() {
214 RQ1 retVal = getTyped("RQ1", RQ1.class);
215 return retVal;
216 }
217
218
219
220
221 /**
222 * Returns
223 * RXO (Pharmacy/Treatment Order) - creates it if necessary
224 */
225 public RXO getRXO() {
226 RXO retVal = getTyped("RXO", RXO.class);
227 return retVal;
228 }
229
230
231
232
233 /**
234 * Returns
235 * ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
236 */
237 public ODS getODS() {
238 ODS retVal = getTyped("ODS", ODS.class);
239 return retVal;
240 }
241
242
243
244
245 /**
246 * Returns
247 * ODT (Diet Tray Instructions) - creates it if necessary
248 */
249 public ODT getODT() {
250 ODT retVal = getTyped("ODT", ODT.class);
251 return retVal;
252 }
253
254
255
256
257 /**
258 * Returns
259 * the first repetition of
260 * NTE (Notes and Comments) - creates it if necessary
261 */
262 public NTE getNTE() {
263 NTE retVal = getTyped("NTE", NTE.class);
264 return retVal;
265 }
266
267
268 /**
269 * Returns a specific repetition of
270 * NTE (Notes and Comments) - creates it if necessary
271 *
272 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
273 * @throws HL7Exception if the repetition requested is more than one
274 * greater than the number of existing repetitions.
275 */
276 public NTE getNTE(int rep) {
277 NTE retVal = getTyped("NTE", rep, NTE.class);
278 return retVal;
279 }
280
281 /**
282 * Returns the number of existing repetitions of NTE
283 */
284 public int getNTEReps() {
285 return getReps("NTE");
286 }
287
288 /**
289 * <p>
290 * Returns a non-modifiable List containing all current existing repetitions of NTE.
291 * <p>
292 * <p>
293 * Note that unlike {@link #getNTE()}, this method will not create any reps
294 * if none are already present, so an empty list may be returned.
295 * </p>
296 */
297 public java.util.List<NTE> getNTEAll() throws HL7Exception {
298 return getAllAsList("NTE", NTE.class);
299 }
300
301 /**
302 * Inserts a specific repetition of NTE (Notes and Comments)
303 * @see AbstractGroup#insertRepetition(Structure, int)
304 */
305 public void insertNTE(NTE structure, int rep) throws HL7Exception {
306 super.insertRepetition("NTE", structure, rep);
307 }
308
309
310 /**
311 * Inserts a specific repetition of NTE (Notes and Comments)
312 * @see AbstractGroup#insertRepetition(Structure, int)
313 */
314 public NTE insertNTE(int rep) throws HL7Exception {
315 return (NTE)super.insertRepetition("NTE", rep);
316 }
317
318
319 /**
320 * Removes a specific repetition of NTE (Notes and Comments)
321 * @see AbstractGroup#removeRepetition(String, int)
322 */
323 public NTE removeNTE(int rep) throws HL7Exception {
324 return (NTE)super.removeRepetition("NTE", rep);
325 }
326
327
328
329 /**
330 * Returns
331 * the first repetition of
332 * CTI (Clinical Trial Identification) - creates it if necessary
333 */
334 public CTI getCTI() {
335 CTI retVal = getTyped("CTI", CTI.class);
336 return retVal;
337 }
338
339
340 /**
341 * Returns a specific repetition of
342 * CTI (Clinical Trial Identification) - creates it if necessary
343 *
344 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
345 * @throws HL7Exception if the repetition requested is more than one
346 * greater than the number of existing repetitions.
347 */
348 public CTI getCTI(int rep) {
349 CTI retVal = getTyped("CTI", rep, CTI.class);
350 return retVal;
351 }
352
353 /**
354 * Returns the number of existing repetitions of CTI
355 */
356 public int getCTIReps() {
357 return getReps("CTI");
358 }
359
360 /**
361 * <p>
362 * Returns a non-modifiable List containing all current existing repetitions of CTI.
363 * <p>
364 * <p>
365 * Note that unlike {@link #getCTI()}, this method will not create any reps
366 * if none are already present, so an empty list may be returned.
367 * </p>
368 */
369 public java.util.List<CTI> getCTIAll() throws HL7Exception {
370 return getAllAsList("CTI", CTI.class);
371 }
372
373 /**
374 * Inserts a specific repetition of CTI (Clinical Trial Identification)
375 * @see AbstractGroup#insertRepetition(Structure, int)
376 */
377 public void insertCTI(CTI structure, int rep) throws HL7Exception {
378 super.insertRepetition("CTI", structure, rep);
379 }
380
381
382 /**
383 * Inserts a specific repetition of CTI (Clinical Trial Identification)
384 * @see AbstractGroup#insertRepetition(Structure, int)
385 */
386 public CTI insertCTI(int rep) throws HL7Exception {
387 return (CTI)super.insertRepetition("CTI", rep);
388 }
389
390
391 /**
392 * Removes a specific repetition of CTI (Clinical Trial Identification)
393 * @see AbstractGroup#removeRepetition(String, int)
394 */
395 public CTI removeCTI(int rep) throws HL7Exception {
396 return (CTI)super.removeRepetition("CTI", rep);
397 }
398
399
400
401 }
402