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