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.v24.message;
35
36 import ca.uhn.hl7v2.model.v24.group.*;
37 import ca.uhn.hl7v2.model.v24.segment.*;
38
39 import ca.uhn.hl7v2.HL7Exception;
40 import ca.uhn.hl7v2.parser.ModelClassFactory;
41 import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
42 import ca.uhn.hl7v2.model.*;
43
44
45 /**
46 * <p>Represents a ORM_O01 message structure (see chapter 4). This structure contains the
47 * following elements: </p>
48 * <ul>
49 * <li>1: MSH (Message Header) <b> </b> </li>
50 * <li>2: NTE (Notes and Comments) <b>optional repeating</b> </li>
51 * <li>3: ORM_O01_PATIENT (a Group object) <b>optional </b> </li>
52 * <li>4: ORM_O01_ORDER (a Group object) <b> repeating</b> </li>
53 * </ul>
54 */
55 //@SuppressWarnings("unused")
56 public class ORM_O01 extends AbstractMessage {
57
58 /**
59 * Creates a new ORM_O01 message with DefaultModelClassFactory.
60 */
61 public ORM_O01() {
62 this(new DefaultModelClassFactory());
63 }
64
65 /**
66 * Creates a new ORM_O01 message with custom ModelClassFactory.
67 */
68 public ORM_O01(ModelClassFactory factory) {
69 super(factory);
70 init(factory);
71 }
72
73 private void init(ModelClassFactory factory) {
74 try {
75 this.add(MSH.class, true, false);
76 this.add(NTE.class, false, true);
77 this.add(ORM_O01_PATIENT.class, false, false);
78 this.add(ORM_O01_ORDER.class, true, true);
79 } catch(HL7Exception e) {
80 log.error("Unexpected error creating ORM_O01 - this is probably a bug in the source code generator.", e);
81 }
82 }
83
84
85 /**
86 * Returns "2.4"
87 */
88 public String getVersion() {
89 return "2.4";
90 }
91
92
93
94
95 /**
96 * <p>
97 * Returns
98 * MSH (Message Header) - creates it if necessary
99 * </p>
100 *
101 *
102 */
103 public MSH getMSH() {
104 return getTyped("MSH", MSH.class);
105 }
106
107
108
109
110
111 /**
112 * <p>
113 * Returns
114 * the first repetition of
115 * NTE (Notes and Comments) - creates it if necessary
116 * </p>
117 *
118 *
119 */
120 public NTE getNTE() {
121 return getTyped("NTE", NTE.class);
122 }
123
124
125 /**
126 * <p>
127 * Returns a specific repetition of
128 * NTE (Notes and Comments) - creates it if necessary
129 * </p>
130 *
131 *
132 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
133 * @throws HL7Exception if the repetition requested is more than one
134 * greater than the number of existing repetitions.
135 */
136 public NTE getNTE(int rep) {
137 return getTyped("NTE", rep, NTE.class);
138 }
139
140 /**
141 * <p>
142 * Returns the number of existing repetitions of NTE
143 * </p>
144 *
145 */
146 public int getNTEReps() {
147 return getReps("NTE");
148 }
149
150 /**
151 * <p>
152 * Returns a non-modifiable List containing all current existing repetitions of NTE.
153 * <p>
154 * <p>
155 * Note that unlike {@link #getNTE()}, this method will not create any reps
156 * if none are already present, so an empty list may be returned.
157 * </p>
158 *
159 */
160 public java.util.List<NTE> getNTEAll() throws HL7Exception {
161 return getAllAsList("NTE", NTE.class);
162 }
163
164 /**
165 * <p>
166 * Inserts a specific repetition of NTE (Notes and Comments)
167 * </p>
168 *
169 *
170 * @see AbstractGroup#insertRepetition(Structure, int)
171 */
172 public void insertNTE(NTE structure, int rep) throws HL7Exception {
173 super.insertRepetition( "NTE", structure, rep);
174 }
175
176
177 /**
178 * <p>
179 * Inserts a specific repetition of NTE (Notes and Comments)
180 * </p>
181 *
182 *
183 * @see AbstractGroup#insertRepetition(Structure, int)
184 */
185 public NTE insertNTE(int rep) throws HL7Exception {
186 return (NTE)super.insertRepetition("NTE", rep);
187 }
188
189
190 /**
191 * <p>
192 * Removes a specific repetition of NTE (Notes and Comments)
193 * </p>
194 *
195 *
196 * @see AbstractGroup#removeRepetition(String, int)
197 */
198 public NTE removeNTE(int rep) throws HL7Exception {
199 return (NTE)super.removeRepetition("NTE", rep);
200 }
201
202
203
204
205 /**
206 * <p>
207 * Returns
208 * PATIENT (a Group object) - creates it if necessary
209 * </p>
210 *
211 *
212 */
213 public ORM_O01_PATIENT getPATIENT() {
214 return getTyped("PATIENT", ORM_O01_PATIENT.class);
215 }
216
217
218
219
220
221 /**
222 * <p>
223 * Returns
224 * the first repetition of
225 * ORDER (a Group object) - creates it if necessary
226 * </p>
227 *
228 *
229 */
230 public ORM_O01_ORDER getORDER() {
231 return getTyped("ORDER", ORM_O01_ORDER.class);
232 }
233
234
235 /**
236 * <p>
237 * Returns a specific repetition of
238 * ORDER (a Group object) - creates it if necessary
239 * </p>
240 *
241 *
242 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
243 * @throws HL7Exception if the repetition requested is more than one
244 * greater than the number of existing repetitions.
245 */
246 public ORM_O01_ORDER getORDER(int rep) {
247 return getTyped("ORDER", rep, ORM_O01_ORDER.class);
248 }
249
250 /**
251 * <p>
252 * Returns the number of existing repetitions of ORDER
253 * </p>
254 *
255 */
256 public int getORDERReps() {
257 return getReps("ORDER");
258 }
259
260 /**
261 * <p>
262 * Returns a non-modifiable List containing all current existing repetitions of ORDER.
263 * <p>
264 * <p>
265 * Note that unlike {@link #getORDER()}, this method will not create any reps
266 * if none are already present, so an empty list may be returned.
267 * </p>
268 *
269 */
270 public java.util.List<ORM_O01_ORDER> getORDERAll() throws HL7Exception {
271 return getAllAsList("ORDER", ORM_O01_ORDER.class);
272 }
273
274 /**
275 * <p>
276 * Inserts a specific repetition of ORDER (a Group object)
277 * </p>
278 *
279 *
280 * @see AbstractGroup#insertRepetition(Structure, int)
281 */
282 public void insertORDER(ORM_O01_ORDER structure, int rep) throws HL7Exception {
283 super.insertRepetition( "ORDER", structure, rep);
284 }
285
286
287 /**
288 * <p>
289 * Inserts a specific repetition of ORDER (a Group object)
290 * </p>
291 *
292 *
293 * @see AbstractGroup#insertRepetition(Structure, int)
294 */
295 public ORM_O01_ORDER insertORDER(int rep) throws HL7Exception {
296 return (ORM_O01_ORDER)super.insertRepetition("ORDER", rep);
297 }
298
299
300 /**
301 * <p>
302 * Removes a specific repetition of ORDER (a Group object)
303 * </p>
304 *
305 *
306 * @see AbstractGroup#removeRepetition(String, int)
307 */
308 public ORM_O01_ORDER removeORDER(int rep) throws HL7Exception {
309 return (ORM_O01_ORDER)super.removeRepetition("ORDER", rep);
310 }
311
312
313
314 }
315