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