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