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