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