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