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.v281.group;
35
36 import ca.uhn.hl7v2.model.v281.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 OMQ_O42_ORDER_DOCUMENT 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: SGH (Segment Group Header) <b> </b></li>
49 * <li>2: OBX (Observation/Result) <b> </b></li>
50 * <li>3: PRT (Participation Information) <b>optional repeating </b></li>
51 * <li>4: TXA (Transcription Document Header) <b>optional </b></li>
52 * <li>5: NTE (Notes and Comments) <b>optional repeating </b></li>
53 * <li>6: SGT (Segment Group Trailer) <b> </b></li>
54 * </ul>
55 */
56 //@SuppressWarnings("unused")
57 public class OMQ_O42_ORDER_DOCUMENT extends AbstractGroup {
58
59 /**
60 * Creates a new OMQ_O42_ORDER_DOCUMENT group
61 */
62 public OMQ_O42_ORDER_DOCUMENT(Group parent, ModelClassFactory factory) {
63 super(parent, factory);
64 init(factory);
65 }
66
67 private void init(ModelClassFactory factory) {
68 try {
69 this.add(SGH.class, true, false, false);
70 this.add(OBX.class, true, false, false);
71 this.add(PRT.class, false, true, false);
72 this.add(TXA.class, false, false, false);
73 this.add(NTE.class, false, true, false);
74 this.add(SGT.class, true, false, false);
75 } catch(HL7Exception e) {
76 log.error("Unexpected error creating OMQ_O42_ORDER_DOCUMENT - this is probably a bug in the source code generator.", e);
77 }
78 }
79
80 /**
81 * Returns "2.8.1"
82 */
83 public String getVersion() {
84 return "2.8.1";
85 }
86
87
88
89 /**
90 * Returns
91 * SGH (Segment Group Header) - creates it if necessary
92 */
93 public SGH getSGH() {
94 SGH retVal = getTyped("SGH", SGH.class);
95 return retVal;
96 }
97
98
99
100
101 /**
102 * Returns
103 * OBX (Observation/Result) - creates it if necessary
104 */
105 public OBX getOBX() {
106 OBX retVal = getTyped("OBX", OBX.class);
107 return retVal;
108 }
109
110
111
112
113 /**
114 * Returns
115 * the first repetition of
116 * PRT (Participation Information) - creates it if necessary
117 */
118 public PRT getPRT() {
119 PRT retVal = getTyped("PRT", PRT.class);
120 return retVal;
121 }
122
123
124 /**
125 * Returns a specific repetition of
126 * PRT (Participation Information) - creates it if necessary
127 *
128 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
129 * @throws HL7Exception if the repetition requested is more than one
130 * greater than the number of existing repetitions.
131 */
132 public PRT getPRT(int rep) {
133 PRT retVal = getTyped("PRT", rep, PRT.class);
134 return retVal;
135 }
136
137 /**
138 * Returns the number of existing repetitions of PRT
139 */
140 public int getPRTReps() {
141 return getReps("PRT");
142 }
143
144 /**
145 * <p>
146 * Returns a non-modifiable List containing all current existing repetitions of PRT.
147 * <p>
148 * <p>
149 * Note that unlike {@link #getPRT()}, this method will not create any reps
150 * if none are already present, so an empty list may be returned.
151 * </p>
152 */
153 public java.util.List<PRT> getPRTAll() throws HL7Exception {
154 return getAllAsList("PRT", PRT.class);
155 }
156
157 /**
158 * Inserts a specific repetition of PRT (Participation Information)
159 * @see AbstractGroup#insertRepetition(Structure, int)
160 */
161 public void insertPRT(PRT structure, int rep) throws HL7Exception {
162 super.insertRepetition("PRT", structure, rep);
163 }
164
165
166 /**
167 * Inserts a specific repetition of PRT (Participation Information)
168 * @see AbstractGroup#insertRepetition(Structure, int)
169 */
170 public PRT insertPRT(int rep) throws HL7Exception {
171 return (PRT)super.insertRepetition("PRT", rep);
172 }
173
174
175 /**
176 * Removes a specific repetition of PRT (Participation Information)
177 * @see AbstractGroup#removeRepetition(String, int)
178 */
179 public PRT removePRT(int rep) throws HL7Exception {
180 return (PRT)super.removeRepetition("PRT", rep);
181 }
182
183
184
185 /**
186 * Returns
187 * TXA (Transcription Document Header) - creates it if necessary
188 */
189 public TXA getTXA() {
190 TXA retVal = getTyped("TXA", TXA.class);
191 return retVal;
192 }
193
194
195
196
197 /**
198 * Returns
199 * the first repetition of
200 * NTE (Notes and Comments) - creates it if necessary
201 */
202 public NTE getNTE() {
203 NTE retVal = getTyped("NTE", NTE.class);
204 return retVal;
205 }
206
207
208 /**
209 * Returns a specific repetition of
210 * NTE (Notes and Comments) - creates it if necessary
211 *
212 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
213 * @throws HL7Exception if the repetition requested is more than one
214 * greater than the number of existing repetitions.
215 */
216 public NTE getNTE(int rep) {
217 NTE retVal = getTyped("NTE", rep, NTE.class);
218 return retVal;
219 }
220
221 /**
222 * Returns the number of existing repetitions of NTE
223 */
224 public int getNTEReps() {
225 return getReps("NTE");
226 }
227
228 /**
229 * <p>
230 * Returns a non-modifiable List containing all current existing repetitions of NTE.
231 * <p>
232 * <p>
233 * Note that unlike {@link #getNTE()}, this method will not create any reps
234 * if none are already present, so an empty list may be returned.
235 * </p>
236 */
237 public java.util.List<NTE> getNTEAll() throws HL7Exception {
238 return getAllAsList("NTE", NTE.class);
239 }
240
241 /**
242 * Inserts a specific repetition of NTE (Notes and Comments)
243 * @see AbstractGroup#insertRepetition(Structure, int)
244 */
245 public void insertNTE(NTE structure, int rep) throws HL7Exception {
246 super.insertRepetition("NTE", structure, rep);
247 }
248
249
250 /**
251 * Inserts a specific repetition of NTE (Notes and Comments)
252 * @see AbstractGroup#insertRepetition(Structure, int)
253 */
254 public NTE insertNTE(int rep) throws HL7Exception {
255 return (NTE)super.insertRepetition("NTE", rep);
256 }
257
258
259 /**
260 * Removes a specific repetition of NTE (Notes and Comments)
261 * @see AbstractGroup#removeRepetition(String, int)
262 */
263 public NTE removeNTE(int rep) throws HL7Exception {
264 return (NTE)super.removeRepetition("NTE", rep);
265 }
266
267
268
269 /**
270 * Returns
271 * SGT (Segment Group Trailer) - creates it if necessary
272 */
273 public SGT getSGT() {
274 SGT retVal = getTyped("SGT", SGT.class);
275 return retVal;
276 }
277
278
279
280
281 }
282