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