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