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 ORI_O24_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: ORI_O24_TIMING (a Group object) <b>optional repeating </b></li>
50 * <li>3: OBR (Observation Request) <b> </b></li>
51 * <li>4: NTE (Notes and Comments) <b>optional repeating </b></li>
52 * <li>5: IPC (Imaging Procedure Control Segment) <b> repeating </b></li>
53 * </ul>
54 */
55 //@SuppressWarnings("unused")
56 public class ORI_O24_ORDER extends AbstractGroup {
57
58 /**
59 * Creates a new ORI_O24_ORDER group
60 */
61 public ORI_O24_ORDER(Group parent, ModelClassFactory factory) {
62 super(parent, factory);
63 init(factory);
64 }
65
66 private void init(ModelClassFactory factory) {
67 try {
68 this.add(ORC.class, true, false, false);
69 this.add(ORI_O24_TIMING.class, false, true, false);
70 this.add(OBR.class, true, false, false);
71 this.add(NTE.class, false, true, false);
72 this.add(IPC.class, true, true, false);
73 } catch(HL7Exception e) {
74 log.error("Unexpected error creating ORI_O24_ORDER - this is probably a bug in the source code generator.", e);
75 }
76 }
77
78 /**
79 * Returns "2.5"
80 */
81 public String getVersion() {
82 return "2.5";
83 }
84
85
86
87 /**
88 * Returns
89 * ORC (Common Order) - creates it if necessary
90 */
91 public ORC getORC() {
92 ORC retVal = getTyped("ORC", ORC.class);
93 return retVal;
94 }
95
96
97
98
99 /**
100 * Returns
101 * the first repetition of
102 * TIMING (a Group object) - creates it if necessary
103 */
104 public ORI_O24_TIMING getTIMING() {
105 ORI_O24_TIMING retVal = getTyped("TIMING", ORI_O24_TIMING.class);
106 return retVal;
107 }
108
109
110 /**
111 * Returns a specific repetition of
112 * TIMING (a Group object) - creates it if necessary
113 *
114 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
115 * @throws HL7Exception if the repetition requested is more than one
116 * greater than the number of existing repetitions.
117 */
118 public ORI_O24_TIMING getTIMING(int rep) {
119 ORI_O24_TIMING retVal = getTyped("TIMING", rep, ORI_O24_TIMING.class);
120 return retVal;
121 }
122
123 /**
124 * Returns the number of existing repetitions of TIMING
125 */
126 public int getTIMINGReps() {
127 return getReps("TIMING");
128 }
129
130 /**
131 * <p>
132 * Returns a non-modifiable List containing all current existing repetitions of TIMING.
133 * <p>
134 * <p>
135 * Note that unlike {@link #getTIMING()}, this method will not create any reps
136 * if none are already present, so an empty list may be returned.
137 * </p>
138 */
139 public java.util.List<ORI_O24_TIMING> getTIMINGAll() throws HL7Exception {
140 return getAllAsList("TIMING", ORI_O24_TIMING.class);
141 }
142
143 /**
144 * Inserts a specific repetition of TIMING (a Group object)
145 * @see AbstractGroup#insertRepetition(Structure, int)
146 */
147 public void insertTIMING(ORI_O24_TIMING structure, int rep) throws HL7Exception {
148 super.insertRepetition("TIMING", structure, rep);
149 }
150
151
152 /**
153 * Inserts a specific repetition of TIMING (a Group object)
154 * @see AbstractGroup#insertRepetition(Structure, int)
155 */
156 public ORI_O24_TIMING insertTIMING(int rep) throws HL7Exception {
157 return (ORI_O24_TIMING)super.insertRepetition("TIMING", rep);
158 }
159
160
161 /**
162 * Removes a specific repetition of TIMING (a Group object)
163 * @see AbstractGroup#removeRepetition(String, int)
164 */
165 public ORI_O24_TIMING removeTIMING(int rep) throws HL7Exception {
166 return (ORI_O24_TIMING)super.removeRepetition("TIMING", rep);
167 }
168
169
170
171 /**
172 * Returns
173 * OBR (Observation Request) - creates it if necessary
174 */
175 public OBR getOBR() {
176 OBR retVal = getTyped("OBR", OBR.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 * IPC (Imaging Procedure Control Segment) - creates it if necessary
259 */
260 public IPC getIPC() {
261 IPC retVal = getTyped("IPC", IPC.class);
262 return retVal;
263 }
264
265
266 /**
267 * Returns a specific repetition of
268 * IPC (Imaging Procedure Control Segment) - 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 IPC getIPC(int rep) {
275 IPC retVal = getTyped("IPC", rep, IPC.class);
276 return retVal;
277 }
278
279 /**
280 * Returns the number of existing repetitions of IPC
281 */
282 public int getIPCReps() {
283 return getReps("IPC");
284 }
285
286 /**
287 * <p>
288 * Returns a non-modifiable List containing all current existing repetitions of IPC.
289 * <p>
290 * <p>
291 * Note that unlike {@link #getIPC()}, 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<IPC> getIPCAll() throws HL7Exception {
296 return getAllAsList("IPC", IPC.class);
297 }
298
299 /**
300 * Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
301 * @see AbstractGroup#insertRepetition(Structure, int)
302 */
303 public void insertIPC(IPC structure, int rep) throws HL7Exception {
304 super.insertRepetition("IPC", structure, rep);
305 }
306
307
308 /**
309 * Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
310 * @see AbstractGroup#insertRepetition(Structure, int)
311 */
312 public IPC insertIPC(int rep) throws HL7Exception {
313 return (IPC)super.insertRepetition("IPC", rep);
314 }
315
316
317 /**
318 * Removes a specific repetition of IPC (Imaging Procedure Control Segment)
319 * @see AbstractGroup#removeRepetition(String, int)
320 */
321 public IPC removeIPC(int rep) throws HL7Exception {
322 return (IPC)super.removeRepetition("IPC", rep);
323 }
324
325
326
327 }
328