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 BAR_P05 message structure (see chapter 6). This structure contains the
47 * following elements: </p>
48 * <ul>
49 * <li>1: MSH (Message Header) <b> </b> </li>
50 * <li>2: EVN (Event Type) <b> </b> </li>
51 * <li>3: PID (Patient identification) <b> </b> </li>
52 * <li>4: PD1 (patient additional demographic) <b>optional </b> </li>
53 * <li>5: ROL (Role) <b>optional repeating</b> </li>
54 * <li>6: BAR_P05_VISIT (a Group object) <b> repeating</b> </li>
55 * </ul>
56 */
57 //@SuppressWarnings("unused")
58 public class BAR_P05 extends AbstractMessage {
59
60 /**
61 * Creates a new BAR_P05 message with DefaultModelClassFactory.
62 */
63 public BAR_P05() {
64 this(new DefaultModelClassFactory());
65 }
66
67 /**
68 * Creates a new BAR_P05 message with custom ModelClassFactory.
69 */
70 public BAR_P05(ModelClassFactory factory) {
71 super(factory);
72 init(factory);
73 }
74
75 private void init(ModelClassFactory factory) {
76 try {
77 this.add(MSH.class, true, false);
78 this.add(EVN.class, true, false);
79 this.add(PID.class, true, false);
80 this.add(PD1.class, false, false);
81 this.add(ROL.class, false, true);
82 this.add(BAR_P05_VISIT.class, true, true);
83 } catch(HL7Exception e) {
84 log.error("Unexpected error creating BAR_P05 - this is probably a bug in the source code generator.", e);
85 }
86 }
87
88
89 /**
90 * Returns "2.4"
91 */
92 public String getVersion() {
93 return "2.4";
94 }
95
96
97
98
99 /**
100 * <p>
101 * Returns
102 * MSH (Message Header) - creates it if necessary
103 * </p>
104 *
105 *
106 */
107 public MSH getMSH() {
108 return getTyped("MSH", MSH.class);
109 }
110
111
112
113
114
115 /**
116 * <p>
117 * Returns
118 * EVN (Event Type) - creates it if necessary
119 * </p>
120 *
121 *
122 */
123 public EVN getEVN() {
124 return getTyped("EVN", EVN.class);
125 }
126
127
128
129
130
131 /**
132 * <p>
133 * Returns
134 * PID (Patient identification) - creates it if necessary
135 * </p>
136 *
137 *
138 */
139 public PID getPID() {
140 return getTyped("PID", PID.class);
141 }
142
143
144
145
146
147 /**
148 * <p>
149 * Returns
150 * PD1 (patient additional demographic) - creates it if necessary
151 * </p>
152 *
153 *
154 */
155 public PD1 getPD1() {
156 return getTyped("PD1", PD1.class);
157 }
158
159
160
161
162
163 /**
164 * <p>
165 * Returns
166 * the first repetition of
167 * ROL (Role) - creates it if necessary
168 * </p>
169 *
170 *
171 */
172 public ROL getROL() {
173 return getTyped("ROL", ROL.class);
174 }
175
176
177 /**
178 * <p>
179 * Returns a specific repetition of
180 * ROL (Role) - creates it if necessary
181 * </p>
182 *
183 *
184 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
185 * @throws HL7Exception if the repetition requested is more than one
186 * greater than the number of existing repetitions.
187 */
188 public ROL getROL(int rep) {
189 return getTyped("ROL", rep, ROL.class);
190 }
191
192 /**
193 * <p>
194 * Returns the number of existing repetitions of ROL
195 * </p>
196 *
197 */
198 public int getROLReps() {
199 return getReps("ROL");
200 }
201
202 /**
203 * <p>
204 * Returns a non-modifiable List containing all current existing repetitions of ROL.
205 * <p>
206 * <p>
207 * Note that unlike {@link #getROL()}, this method will not create any reps
208 * if none are already present, so an empty list may be returned.
209 * </p>
210 *
211 */
212 public java.util.List<ROL> getROLAll() throws HL7Exception {
213 return getAllAsList("ROL", ROL.class);
214 }
215
216 /**
217 * <p>
218 * Inserts a specific repetition of ROL (Role)
219 * </p>
220 *
221 *
222 * @see AbstractGroup#insertRepetition(Structure, int)
223 */
224 public void insertROL(ROL structure, int rep) throws HL7Exception {
225 super.insertRepetition( "ROL", structure, rep);
226 }
227
228
229 /**
230 * <p>
231 * Inserts a specific repetition of ROL (Role)
232 * </p>
233 *
234 *
235 * @see AbstractGroup#insertRepetition(Structure, int)
236 */
237 public ROL insertROL(int rep) throws HL7Exception {
238 return (ROL)super.insertRepetition("ROL", rep);
239 }
240
241
242 /**
243 * <p>
244 * Removes a specific repetition of ROL (Role)
245 * </p>
246 *
247 *
248 * @see AbstractGroup#removeRepetition(String, int)
249 */
250 public ROL removeROL(int rep) throws HL7Exception {
251 return (ROL)super.removeRepetition("ROL", rep);
252 }
253
254
255
256
257 /**
258 * <p>
259 * Returns
260 * the first repetition of
261 * VISIT (a Group object) - creates it if necessary
262 * </p>
263 *
264 *
265 */
266 public BAR_P05_VISIT getVISIT() {
267 return getTyped("VISIT", BAR_P05_VISIT.class);
268 }
269
270
271 /**
272 * <p>
273 * Returns a specific repetition of
274 * VISIT (a Group object) - creates it if necessary
275 * </p>
276 *
277 *
278 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
279 * @throws HL7Exception if the repetition requested is more than one
280 * greater than the number of existing repetitions.
281 */
282 public BAR_P05_VISIT getVISIT(int rep) {
283 return getTyped("VISIT", rep, BAR_P05_VISIT.class);
284 }
285
286 /**
287 * <p>
288 * Returns the number of existing repetitions of VISIT
289 * </p>
290 *
291 */
292 public int getVISITReps() {
293 return getReps("VISIT");
294 }
295
296 /**
297 * <p>
298 * Returns a non-modifiable List containing all current existing repetitions of VISIT.
299 * <p>
300 * <p>
301 * Note that unlike {@link #getVISIT()}, this method will not create any reps
302 * if none are already present, so an empty list may be returned.
303 * </p>
304 *
305 */
306 public java.util.List<BAR_P05_VISIT> getVISITAll() throws HL7Exception {
307 return getAllAsList("VISIT", BAR_P05_VISIT.class);
308 }
309
310 /**
311 * <p>
312 * Inserts a specific repetition of VISIT (a Group object)
313 * </p>
314 *
315 *
316 * @see AbstractGroup#insertRepetition(Structure, int)
317 */
318 public void insertVISIT(BAR_P05_VISIT structure, int rep) throws HL7Exception {
319 super.insertRepetition( "VISIT", structure, rep);
320 }
321
322
323 /**
324 * <p>
325 * Inserts a specific repetition of VISIT (a Group object)
326 * </p>
327 *
328 *
329 * @see AbstractGroup#insertRepetition(Structure, int)
330 */
331 public BAR_P05_VISIT insertVISIT(int rep) throws HL7Exception {
332 return (BAR_P05_VISIT)super.insertRepetition("VISIT", rep);
333 }
334
335
336 /**
337 * <p>
338 * Removes a specific repetition of VISIT (a Group object)
339 * </p>
340 *
341 *
342 * @see AbstractGroup#removeRepetition(String, int)
343 */
344 public BAR_P05_VISIT removeVISIT(int rep) throws HL7Exception {
345 return (BAR_P05_VISIT)super.removeRepetition("VISIT", rep);
346 }
347
348
349
350 }
351