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