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