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 OMS_O05_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: OMS_O05_TIMING (a Group object) <b>optional repeating </b></li>
50 * <li>3: RQD (Requisition Detail) <b> </b></li>
51 * <li>4: RQ1 (Requisition Detail-1) <b>optional </b></li>
52 * <li>5: NTE (Notes and Comments) <b>optional repeating </b></li>
53 * <li>6: OMS_O05_OBSERVATION (a Group object) <b>optional repeating </b></li>
54 * <li>7: BLG (Billing) <b>optional </b></li>
55 * </ul>
56 */
57 //@SuppressWarnings("unused")
58 public class OMS_O05_ORDER extends AbstractGroup {
59
60 /**
61 * Creates a new OMS_O05_ORDER group
62 */
63 public OMS_O05_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, true, false, false);
71 this.add(OMS_O05_TIMING.class, false, true, false);
72 this.add(RQD.class, true, false, false);
73 this.add(RQ1.class, false, false, false);
74 this.add(NTE.class, false, true, false);
75 this.add(OMS_O05_OBSERVATION.class, false, true, false);
76 this.add(BLG.class, false, false, false);
77 } catch(HL7Exception e) {
78 log.error("Unexpected error creating OMS_O05_ORDER - this is probably a bug in the source code generator.", e);
79 }
80 }
81
82 /**
83 * Returns "2.7"
84 */
85 public String getVersion() {
86 return "2.7";
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 * the first repetition of
106 * TIMING (a Group object) - creates it if necessary
107 */
108 public OMS_O05_TIMING getTIMING() {
109 OMS_O05_TIMING retVal = getTyped("TIMING", OMS_O05_TIMING.class);
110 return retVal;
111 }
112
113
114 /**
115 * Returns a specific repetition of
116 * TIMING (a Group object) - creates it if necessary
117 *
118 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
119 * @throws HL7Exception if the repetition requested is more than one
120 * greater than the number of existing repetitions.
121 */
122 public OMS_O05_TIMING getTIMING(int rep) {
123 OMS_O05_TIMING retVal = getTyped("TIMING", rep, OMS_O05_TIMING.class);
124 return retVal;
125 }
126
127 /**
128 * Returns the number of existing repetitions of TIMING
129 */
130 public int getTIMINGReps() {
131 return getReps("TIMING");
132 }
133
134 /**
135 * <p>
136 * Returns a non-modifiable List containing all current existing repetitions of TIMING.
137 * <p>
138 * <p>
139 * Note that unlike {@link #getTIMING()}, this method will not create any reps
140 * if none are already present, so an empty list may be returned.
141 * </p>
142 */
143 public java.util.List<OMS_O05_TIMING> getTIMINGAll() throws HL7Exception {
144 return getAllAsList("TIMING", OMS_O05_TIMING.class);
145 }
146
147 /**
148 * Inserts a specific repetition of TIMING (a Group object)
149 * @see AbstractGroup#insertRepetition(Structure, int)
150 */
151 public void insertTIMING(OMS_O05_TIMING structure, int rep) throws HL7Exception {
152 super.insertRepetition("TIMING", structure, rep);
153 }
154
155
156 /**
157 * Inserts a specific repetition of TIMING (a Group object)
158 * @see AbstractGroup#insertRepetition(Structure, int)
159 */
160 public OMS_O05_TIMING insertTIMING(int rep) throws HL7Exception {
161 return (OMS_O05_TIMING)super.insertRepetition("TIMING", rep);
162 }
163
164
165 /**
166 * Removes a specific repetition of TIMING (a Group object)
167 * @see AbstractGroup#removeRepetition(String, int)
168 */
169 public OMS_O05_TIMING removeTIMING(int rep) throws HL7Exception {
170 return (OMS_O05_TIMING)super.removeRepetition("TIMING", rep);
171 }
172
173
174
175 /**
176 * Returns
177 * RQD (Requisition Detail) - creates it if necessary
178 */
179 public RQD getRQD() {
180 RQD retVal = getTyped("RQD", RQD.class);
181 return retVal;
182 }
183
184
185
186
187 /**
188 * Returns
189 * RQ1 (Requisition Detail-1) - creates it if necessary
190 */
191 public RQ1 getRQ1() {
192 RQ1 retVal = getTyped("RQ1", RQ1.class);
193 return retVal;
194 }
195
196
197
198
199 /**
200 * Returns
201 * the first repetition of
202 * NTE (Notes and Comments) - creates it if necessary
203 */
204 public NTE getNTE() {
205 NTE retVal = getTyped("NTE", NTE.class);
206 return retVal;
207 }
208
209
210 /**
211 * Returns a specific repetition of
212 * NTE (Notes and Comments) - creates it if necessary
213 *
214 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
215 * @throws HL7Exception if the repetition requested is more than one
216 * greater than the number of existing repetitions.
217 */
218 public NTE getNTE(int rep) {
219 NTE retVal = getTyped("NTE", rep, NTE.class);
220 return retVal;
221 }
222
223 /**
224 * Returns the number of existing repetitions of NTE
225 */
226 public int getNTEReps() {
227 return getReps("NTE");
228 }
229
230 /**
231 * <p>
232 * Returns a non-modifiable List containing all current existing repetitions of NTE.
233 * <p>
234 * <p>
235 * Note that unlike {@link #getNTE()}, this method will not create any reps
236 * if none are already present, so an empty list may be returned.
237 * </p>
238 */
239 public java.util.List<NTE> getNTEAll() throws HL7Exception {
240 return getAllAsList("NTE", NTE.class);
241 }
242
243 /**
244 * Inserts a specific repetition of NTE (Notes and Comments)
245 * @see AbstractGroup#insertRepetition(Structure, int)
246 */
247 public void insertNTE(NTE structure, int rep) throws HL7Exception {
248 super.insertRepetition("NTE", structure, rep);
249 }
250
251
252 /**
253 * Inserts a specific repetition of NTE (Notes and Comments)
254 * @see AbstractGroup#insertRepetition(Structure, int)
255 */
256 public NTE insertNTE(int rep) throws HL7Exception {
257 return (NTE)super.insertRepetition("NTE", rep);
258 }
259
260
261 /**
262 * Removes a specific repetition of NTE (Notes and Comments)
263 * @see AbstractGroup#removeRepetition(String, int)
264 */
265 public NTE removeNTE(int rep) throws HL7Exception {
266 return (NTE)super.removeRepetition("NTE", rep);
267 }
268
269
270
271 /**
272 * Returns
273 * the first repetition of
274 * OBSERVATION (a Group object) - creates it if necessary
275 */
276 public OMS_O05_OBSERVATION getOBSERVATION() {
277 OMS_O05_OBSERVATION retVal = getTyped("OBSERVATION", OMS_O05_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 OMS_O05_OBSERVATION getOBSERVATION(int rep) {
291 OMS_O05_OBSERVATION retVal = getTyped("OBSERVATION", rep, OMS_O05_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<OMS_O05_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
312 return getAllAsList("OBSERVATION", OMS_O05_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(OMS_O05_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 OMS_O05_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
329 return (OMS_O05_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 OMS_O05_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
338 return (OMS_O05_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
339 }
340
341
342
343 /**
344 * Returns
345 * BLG (Billing) - creates it if necessary
346 */
347 public BLG getBLG() {
348 BLG retVal = getTyped("BLG", BLG.class);
349 return retVal;
350 }
351
352
353
354
355 }
356