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