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 RSP_Z86_COMMON_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: RSP_Z86_TIMING (a Group object) <b>optional repeating </b></li>
50 * <li>3: RSP_Z86_ORDER_DETAIL (a Group object) <b>optional </b></li>
51 * <li>4: RSP_Z86_ENCODED_ORDER (a Group object) <b>optional </b></li>
52 * <li>5: RSP_Z86_DISPENSE (a Group object) <b>optional </b></li>
53 * <li>6: RSP_Z86_GIVE (a Group object) <b>optional </b></li>
54 * <li>7: RSP_Z86_ADMINISTRATION (a Group object) <b>optional </b></li>
55 * <li>8: RSP_Z86_OBSERVATION (a Group object) <b> repeating </b></li>
56 * </ul>
57 */
58 //@SuppressWarnings("unused")
59 public class RSP_Z86_COMMON_ORDER extends AbstractGroup {
60
61 /**
62 * Creates a new RSP_Z86_COMMON_ORDER group
63 */
64 public RSP_Z86_COMMON_ORDER(Group parent, ModelClassFactory factory) {
65 super(parent, factory);
66 init(factory);
67 }
68
69 private void init(ModelClassFactory factory) {
70 try {
71 this.add(ORC.class, true, false, false);
72 this.add(RSP_Z86_TIMING.class, false, true, false);
73 this.add(RSP_Z86_ORDER_DETAIL.class, false, false, false);
74 this.add(RSP_Z86_ENCODED_ORDER.class, false, false, false);
75 this.add(RSP_Z86_DISPENSE.class, false, false, false);
76 this.add(RSP_Z86_GIVE.class, false, false, false);
77 this.add(RSP_Z86_ADMINISTRATION.class, false, false, false);
78 this.add(RSP_Z86_OBSERVATION.class, true, true, false);
79 } catch(HL7Exception e) {
80 log.error("Unexpected error creating RSP_Z86_COMMON_ORDER - this is probably a bug in the source code generator.", e);
81 }
82 }
83
84 /**
85 * Returns "2.8"
86 */
87 public String getVersion() {
88 return "2.8";
89 }
90
91
92
93 /**
94 * Returns
95 * ORC (Common Order) - creates it if necessary
96 */
97 public ORC getORC() {
98 ORC retVal = getTyped("ORC", ORC.class);
99 return retVal;
100 }
101
102
103
104
105 /**
106 * Returns
107 * the first repetition of
108 * TIMING (a Group object) - creates it if necessary
109 */
110 public RSP_Z86_TIMING getTIMING() {
111 RSP_Z86_TIMING retVal = getTyped("TIMING", RSP_Z86_TIMING.class);
112 return retVal;
113 }
114
115
116 /**
117 * Returns a specific repetition of
118 * TIMING (a Group object) - creates it if necessary
119 *
120 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
121 * @throws HL7Exception if the repetition requested is more than one
122 * greater than the number of existing repetitions.
123 */
124 public RSP_Z86_TIMING getTIMING(int rep) {
125 RSP_Z86_TIMING retVal = getTyped("TIMING", rep, RSP_Z86_TIMING.class);
126 return retVal;
127 }
128
129 /**
130 * Returns the number of existing repetitions of TIMING
131 */
132 public int getTIMINGReps() {
133 return getReps("TIMING");
134 }
135
136 /**
137 * <p>
138 * Returns a non-modifiable List containing all current existing repetitions of TIMING.
139 * <p>
140 * <p>
141 * Note that unlike {@link #getTIMING()}, this method will not create any reps
142 * if none are already present, so an empty list may be returned.
143 * </p>
144 */
145 public java.util.List<RSP_Z86_TIMING> getTIMINGAll() throws HL7Exception {
146 return getAllAsList("TIMING", RSP_Z86_TIMING.class);
147 }
148
149 /**
150 * Inserts a specific repetition of TIMING (a Group object)
151 * @see AbstractGroup#insertRepetition(Structure, int)
152 */
153 public void insertTIMING(RSP_Z86_TIMING structure, int rep) throws HL7Exception {
154 super.insertRepetition("TIMING", structure, rep);
155 }
156
157
158 /**
159 * Inserts a specific repetition of TIMING (a Group object)
160 * @see AbstractGroup#insertRepetition(Structure, int)
161 */
162 public RSP_Z86_TIMING insertTIMING(int rep) throws HL7Exception {
163 return (RSP_Z86_TIMING)super.insertRepetition("TIMING", rep);
164 }
165
166
167 /**
168 * Removes a specific repetition of TIMING (a Group object)
169 * @see AbstractGroup#removeRepetition(String, int)
170 */
171 public RSP_Z86_TIMING removeTIMING(int rep) throws HL7Exception {
172 return (RSP_Z86_TIMING)super.removeRepetition("TIMING", rep);
173 }
174
175
176
177 /**
178 * Returns
179 * ORDER_DETAIL (a Group object) - creates it if necessary
180 */
181 public RSP_Z86_ORDER_DETAIL getORDER_DETAIL() {
182 RSP_Z86_ORDER_DETAIL retVal = getTyped("ORDER_DETAIL", RSP_Z86_ORDER_DETAIL.class);
183 return retVal;
184 }
185
186
187
188
189 /**
190 * Returns
191 * ENCODED_ORDER (a Group object) - creates it if necessary
192 */
193 public RSP_Z86_ENCODED_ORDER getENCODED_ORDER() {
194 RSP_Z86_ENCODED_ORDER retVal = getTyped("ENCODED_ORDER", RSP_Z86_ENCODED_ORDER.class);
195 return retVal;
196 }
197
198
199
200
201 /**
202 * Returns
203 * DISPENSE (a Group object) - creates it if necessary
204 */
205 public RSP_Z86_DISPENSE getDISPENSE() {
206 RSP_Z86_DISPENSE retVal = getTyped("DISPENSE", RSP_Z86_DISPENSE.class);
207 return retVal;
208 }
209
210
211
212
213 /**
214 * Returns
215 * GIVE (a Group object) - creates it if necessary
216 */
217 public RSP_Z86_GIVE getGIVE() {
218 RSP_Z86_GIVE retVal = getTyped("GIVE", RSP_Z86_GIVE.class);
219 return retVal;
220 }
221
222
223
224
225 /**
226 * Returns
227 * ADMINISTRATION (a Group object) - creates it if necessary
228 */
229 public RSP_Z86_ADMINISTRATION getADMINISTRATION() {
230 RSP_Z86_ADMINISTRATION retVal = getTyped("ADMINISTRATION", RSP_Z86_ADMINISTRATION.class);
231 return retVal;
232 }
233
234
235
236
237 /**
238 * Returns
239 * the first repetition of
240 * OBSERVATION (a Group object) - creates it if necessary
241 */
242 public RSP_Z86_OBSERVATION getOBSERVATION() {
243 RSP_Z86_OBSERVATION retVal = getTyped("OBSERVATION", RSP_Z86_OBSERVATION.class);
244 return retVal;
245 }
246
247
248 /**
249 * Returns a specific repetition of
250 * OBSERVATION (a Group object) - creates it if necessary
251 *
252 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
253 * @throws HL7Exception if the repetition requested is more than one
254 * greater than the number of existing repetitions.
255 */
256 public RSP_Z86_OBSERVATION getOBSERVATION(int rep) {
257 RSP_Z86_OBSERVATION retVal = getTyped("OBSERVATION", rep, RSP_Z86_OBSERVATION.class);
258 return retVal;
259 }
260
261 /**
262 * Returns the number of existing repetitions of OBSERVATION
263 */
264 public int getOBSERVATIONReps() {
265 return getReps("OBSERVATION");
266 }
267
268 /**
269 * <p>
270 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
271 * <p>
272 * <p>
273 * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
274 * if none are already present, so an empty list may be returned.
275 * </p>
276 */
277 public java.util.List<RSP_Z86_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
278 return getAllAsList("OBSERVATION", RSP_Z86_OBSERVATION.class);
279 }
280
281 /**
282 * Inserts a specific repetition of OBSERVATION (a Group object)
283 * @see AbstractGroup#insertRepetition(Structure, int)
284 */
285 public void insertOBSERVATION(RSP_Z86_OBSERVATION structure, int rep) throws HL7Exception {
286 super.insertRepetition("OBSERVATION", structure, rep);
287 }
288
289
290 /**
291 * Inserts a specific repetition of OBSERVATION (a Group object)
292 * @see AbstractGroup#insertRepetition(Structure, int)
293 */
294 public RSP_Z86_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
295 return (RSP_Z86_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
296 }
297
298
299 /**
300 * Removes a specific repetition of OBSERVATION (a Group object)
301 * @see AbstractGroup#removeRepetition(String, int)
302 */
303 public RSP_Z86_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
304 return (RSP_Z86_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
305 }
306
307
308
309 }
310