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