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.v27.group;
35
36 import ca.uhn.hl7v2.model.v27.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 OML_O39_OBSERVATION_REQUEST 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: OBR (Observation Request) <b> </b></li>
49 * <li>2: TCD (Test Code Detail) <b>optional </b></li>
50 * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li>
51 * <li>4: PRT (Participation Information) <b>optional repeating </b></li>
52 * <li>5: CTD (Contact Data) <b>optional </b></li>
53 * <li>6: DG1 (Diagnosis) <b>optional repeating </b></li>
54 * <li>7: OML_O39_OBSERVATION (a Group object) <b>optional repeating </b></li>
55 * <li>8: OML_O39_SPECIMEN_SHIPMENT (a Group object) <b>optional repeating </b></li>
56 * </ul>
57 */
58 //@SuppressWarnings("unused")
59 public class OML_O39_OBSERVATION_REQUEST extends AbstractGroup {
60
61 /**
62 * Creates a new OML_O39_OBSERVATION_REQUEST group
63 */
64 public OML_O39_OBSERVATION_REQUEST(Group parent, ModelClassFactory factory) {
65 super(parent, factory);
66 init(factory);
67 }
68
69 private void init(ModelClassFactory factory) {
70 try {
71 this.add(OBR.class, true, false, false);
72 this.add(TCD.class, false, false, false);
73 this.add(NTE.class, false, true, false);
74 this.add(PRT.class, false, true, false);
75 this.add(CTD.class, false, false, false);
76 this.add(DG1.class, false, true, false);
77 this.add(OML_O39_OBSERVATION.class, false, true, false);
78 this.add(OML_O39_SPECIMEN_SHIPMENT.class, false, true, false);
79 } catch(HL7Exception e) {
80 log.error("Unexpected error creating OML_O39_OBSERVATION_REQUEST - this is probably a bug in the source code generator.", e);
81 }
82 }
83
84 /**
85 * Returns "2.7"
86 */
87 public String getVersion() {
88 return "2.7";
89 }
90
91
92
93 /**
94 * Returns
95 * OBR (Observation Request) - creates it if necessary
96 */
97 public OBR getOBR() {
98 OBR retVal = getTyped("OBR", OBR.class);
99 return retVal;
100 }
101
102
103
104
105 /**
106 * Returns
107 * TCD (Test Code Detail) - creates it if necessary
108 */
109 public TCD getTCD() {
110 TCD retVal = getTyped("TCD", TCD.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 * PRT (Participation Information) - creates it if necessary
193 */
194 public PRT getPRT() {
195 PRT retVal = getTyped("PRT", PRT.class);
196 return retVal;
197 }
198
199
200 /**
201 * Returns a specific repetition of
202 * PRT (Participation Information) - 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 PRT getPRT(int rep) {
209 PRT retVal = getTyped("PRT", rep, PRT.class);
210 return retVal;
211 }
212
213 /**
214 * Returns the number of existing repetitions of PRT
215 */
216 public int getPRTReps() {
217 return getReps("PRT");
218 }
219
220 /**
221 * <p>
222 * Returns a non-modifiable List containing all current existing repetitions of PRT.
223 * <p>
224 * <p>
225 * Note that unlike {@link #getPRT()}, 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<PRT> getPRTAll() throws HL7Exception {
230 return getAllAsList("PRT", PRT.class);
231 }
232
233 /**
234 * Inserts a specific repetition of PRT (Participation Information)
235 * @see AbstractGroup#insertRepetition(Structure, int)
236 */
237 public void insertPRT(PRT structure, int rep) throws HL7Exception {
238 super.insertRepetition("PRT", structure, rep);
239 }
240
241
242 /**
243 * Inserts a specific repetition of PRT (Participation Information)
244 * @see AbstractGroup#insertRepetition(Structure, int)
245 */
246 public PRT insertPRT(int rep) throws HL7Exception {
247 return (PRT)super.insertRepetition("PRT", rep);
248 }
249
250
251 /**
252 * Removes a specific repetition of PRT (Participation Information)
253 * @see AbstractGroup#removeRepetition(String, int)
254 */
255 public PRT removePRT(int rep) throws HL7Exception {
256 return (PRT)super.removeRepetition("PRT", rep);
257 }
258
259
260
261 /**
262 * Returns
263 * CTD (Contact Data) - creates it if necessary
264 */
265 public CTD getCTD() {
266 CTD retVal = getTyped("CTD", CTD.class);
267 return retVal;
268 }
269
270
271
272
273 /**
274 * Returns
275 * the first repetition of
276 * DG1 (Diagnosis) - creates it if necessary
277 */
278 public DG1 getDG1() {
279 DG1 retVal = getTyped("DG1", DG1.class);
280 return retVal;
281 }
282
283
284 /**
285 * Returns a specific repetition of
286 * DG1 (Diagnosis) - 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 DG1 getDG1(int rep) {
293 DG1 retVal = getTyped("DG1", rep, DG1.class);
294 return retVal;
295 }
296
297 /**
298 * Returns the number of existing repetitions of DG1
299 */
300 public int getDG1Reps() {
301 return getReps("DG1");
302 }
303
304 /**
305 * <p>
306 * Returns a non-modifiable List containing all current existing repetitions of DG1.
307 * <p>
308 * <p>
309 * Note that unlike {@link #getDG1()}, 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<DG1> getDG1All() throws HL7Exception {
314 return getAllAsList("DG1", DG1.class);
315 }
316
317 /**
318 * Inserts a specific repetition of DG1 (Diagnosis)
319 * @see AbstractGroup#insertRepetition(Structure, int)
320 */
321 public void insertDG1(DG1 structure, int rep) throws HL7Exception {
322 super.insertRepetition("DG1", structure, rep);
323 }
324
325
326 /**
327 * Inserts a specific repetition of DG1 (Diagnosis)
328 * @see AbstractGroup#insertRepetition(Structure, int)
329 */
330 public DG1 insertDG1(int rep) throws HL7Exception {
331 return (DG1)super.insertRepetition("DG1", rep);
332 }
333
334
335 /**
336 * Removes a specific repetition of DG1 (Diagnosis)
337 * @see AbstractGroup#removeRepetition(String, int)
338 */
339 public DG1 removeDG1(int rep) throws HL7Exception {
340 return (DG1)super.removeRepetition("DG1", rep);
341 }
342
343
344
345 /**
346 * Returns
347 * the first repetition of
348 * OBSERVATION (a Group object) - creates it if necessary
349 */
350 public OML_O39_OBSERVATION getOBSERVATION() {
351 OML_O39_OBSERVATION retVal = getTyped("OBSERVATION", OML_O39_OBSERVATION.class);
352 return retVal;
353 }
354
355
356 /**
357 * Returns a specific repetition of
358 * OBSERVATION (a Group object) - 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 OML_O39_OBSERVATION getOBSERVATION(int rep) {
365 OML_O39_OBSERVATION retVal = getTyped("OBSERVATION", rep, OML_O39_OBSERVATION.class);
366 return retVal;
367 }
368
369 /**
370 * Returns the number of existing repetitions of OBSERVATION
371 */
372 public int getOBSERVATIONReps() {
373 return getReps("OBSERVATION");
374 }
375
376 /**
377 * <p>
378 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
379 * <p>
380 * <p>
381 * Note that unlike {@link #getOBSERVATION()}, 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<OML_O39_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
386 return getAllAsList("OBSERVATION", OML_O39_OBSERVATION.class);
387 }
388
389 /**
390 * Inserts a specific repetition of OBSERVATION (a Group object)
391 * @see AbstractGroup#insertRepetition(Structure, int)
392 */
393 public void insertOBSERVATION(OML_O39_OBSERVATION structure, int rep) throws HL7Exception {
394 super.insertRepetition("OBSERVATION", structure, rep);
395 }
396
397
398 /**
399 * Inserts a specific repetition of OBSERVATION (a Group object)
400 * @see AbstractGroup#insertRepetition(Structure, int)
401 */
402 public OML_O39_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
403 return (OML_O39_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
404 }
405
406
407 /**
408 * Removes a specific repetition of OBSERVATION (a Group object)
409 * @see AbstractGroup#removeRepetition(String, int)
410 */
411 public OML_O39_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
412 return (OML_O39_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
413 }
414
415
416
417 /**
418 * Returns
419 * the first repetition of
420 * SPECIMEN_SHIPMENT (a Group object) - creates it if necessary
421 */
422 public OML_O39_SPECIMEN_SHIPMENT getSPECIMEN_SHIPMENT() {
423 OML_O39_SPECIMEN_SHIPMENT retVal = getTyped("SPECIMEN_SHIPMENT", OML_O39_SPECIMEN_SHIPMENT.class);
424 return retVal;
425 }
426
427
428 /**
429 * Returns a specific repetition of
430 * SPECIMEN_SHIPMENT (a Group object) - creates it if necessary
431 *
432 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
433 * @throws HL7Exception if the repetition requested is more than one
434 * greater than the number of existing repetitions.
435 */
436 public OML_O39_SPECIMEN_SHIPMENT getSPECIMEN_SHIPMENT(int rep) {
437 OML_O39_SPECIMEN_SHIPMENT retVal = getTyped("SPECIMEN_SHIPMENT", rep, OML_O39_SPECIMEN_SHIPMENT.class);
438 return retVal;
439 }
440
441 /**
442 * Returns the number of existing repetitions of SPECIMEN_SHIPMENT
443 */
444 public int getSPECIMEN_SHIPMENTReps() {
445 return getReps("SPECIMEN_SHIPMENT");
446 }
447
448 /**
449 * <p>
450 * Returns a non-modifiable List containing all current existing repetitions of SPECIMEN_SHIPMENT.
451 * <p>
452 * <p>
453 * Note that unlike {@link #getSPECIMEN_SHIPMENT()}, this method will not create any reps
454 * if none are already present, so an empty list may be returned.
455 * </p>
456 */
457 public java.util.List<OML_O39_SPECIMEN_SHIPMENT> getSPECIMEN_SHIPMENTAll() throws HL7Exception {
458 return getAllAsList("SPECIMEN_SHIPMENT", OML_O39_SPECIMEN_SHIPMENT.class);
459 }
460
461 /**
462 * Inserts a specific repetition of SPECIMEN_SHIPMENT (a Group object)
463 * @see AbstractGroup#insertRepetition(Structure, int)
464 */
465 public void insertSPECIMEN_SHIPMENT(OML_O39_SPECIMEN_SHIPMENT structure, int rep) throws HL7Exception {
466 super.insertRepetition("SPECIMEN_SHIPMENT", structure, rep);
467 }
468
469
470 /**
471 * Inserts a specific repetition of SPECIMEN_SHIPMENT (a Group object)
472 * @see AbstractGroup#insertRepetition(Structure, int)
473 */
474 public OML_O39_SPECIMEN_SHIPMENT insertSPECIMEN_SHIPMENT(int rep) throws HL7Exception {
475 return (OML_O39_SPECIMEN_SHIPMENT)super.insertRepetition("SPECIMEN_SHIPMENT", rep);
476 }
477
478
479 /**
480 * Removes a specific repetition of SPECIMEN_SHIPMENT (a Group object)
481 * @see AbstractGroup#removeRepetition(String, int)
482 */
483 public OML_O39_SPECIMEN_SHIPMENT removeSPECIMEN_SHIPMENT(int rep) throws HL7Exception {
484 return (OML_O39_SPECIMEN_SHIPMENT)super.removeRepetition("SPECIMEN_SHIPMENT", rep);
485 }
486
487
488
489 }
490