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.group;
35
36 import ca.uhn.hl7v2.model.v24.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_Z90_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: OBR (Observation Request) <b> </b></li>
50 * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li>
51 * <li>4: CTD (Contact Data) <b>optional </b></li>
52 * <li>5: RSP_Z90_OBSERVATION (a Group object) <b> repeating </b></li>
53 * </ul>
54 */
55 //@SuppressWarnings("unused")
56 public class RSP_Z90_COMMON_ORDER extends AbstractGroup {
57
58 /**
59 * Creates a new RSP_Z90_COMMON_ORDER group
60 */
61 public RSP_Z90_COMMON_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(OBR.class, true, false, false);
70 this.add(NTE.class, false, true, false);
71 this.add(CTD.class, false, false, false);
72 this.add(RSP_Z90_OBSERVATION.class, true, true, false);
73 } catch(HL7Exception e) {
74 log.error("Unexpected error creating RSP_Z90_COMMON_ORDER - this is probably a bug in the source code generator.", e);
75 }
76 }
77
78 /**
79 * Returns "2.4"
80 */
81 public String getVersion() {
82 return "2.4";
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 * OBR (Observation Request) - creates it if necessary
102 */
103 public OBR getOBR() {
104 OBR retVal = getTyped("OBR", OBR.class);
105 return retVal;
106 }
107
108
109
110
111 /**
112 * Returns
113 * the first repetition of
114 * NTE (Notes and Comments) - creates it if necessary
115 */
116 public NTE getNTE() {
117 NTE retVal = getTyped("NTE", NTE.class);
118 return retVal;
119 }
120
121
122 /**
123 * Returns a specific repetition of
124 * NTE (Notes and Comments) - creates it if necessary
125 *
126 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
127 * @throws HL7Exception if the repetition requested is more than one
128 * greater than the number of existing repetitions.
129 */
130 public NTE getNTE(int rep) {
131 NTE retVal = getTyped("NTE", rep, NTE.class);
132 return retVal;
133 }
134
135 /**
136 * Returns the number of existing repetitions of NTE
137 */
138 public int getNTEReps() {
139 return getReps("NTE");
140 }
141
142 /**
143 * <p>
144 * Returns a non-modifiable List containing all current existing repetitions of NTE.
145 * <p>
146 * <p>
147 * Note that unlike {@link #getNTE()}, this method will not create any reps
148 * if none are already present, so an empty list may be returned.
149 * </p>
150 */
151 public java.util.List<NTE> getNTEAll() throws HL7Exception {
152 return getAllAsList("NTE", NTE.class);
153 }
154
155 /**
156 * Inserts a specific repetition of NTE (Notes and Comments)
157 * @see AbstractGroup#insertRepetition(Structure, int)
158 */
159 public void insertNTE(NTE structure, int rep) throws HL7Exception {
160 super.insertRepetition("NTE", structure, rep);
161 }
162
163
164 /**
165 * Inserts a specific repetition of NTE (Notes and Comments)
166 * @see AbstractGroup#insertRepetition(Structure, int)
167 */
168 public NTE insertNTE(int rep) throws HL7Exception {
169 return (NTE)super.insertRepetition("NTE", rep);
170 }
171
172
173 /**
174 * Removes a specific repetition of NTE (Notes and Comments)
175 * @see AbstractGroup#removeRepetition(String, int)
176 */
177 public NTE removeNTE(int rep) throws HL7Exception {
178 return (NTE)super.removeRepetition("NTE", rep);
179 }
180
181
182
183 /**
184 * Returns
185 * CTD (Contact Data) - creates it if necessary
186 */
187 public CTD getCTD() {
188 CTD retVal = getTyped("CTD", CTD.class);
189 return retVal;
190 }
191
192
193
194
195 /**
196 * Returns
197 * the first repetition of
198 * OBSERVATION (a Group object) - creates it if necessary
199 */
200 public RSP_Z90_OBSERVATION getOBSERVATION() {
201 RSP_Z90_OBSERVATION retVal = getTyped("OBSERVATION", RSP_Z90_OBSERVATION.class);
202 return retVal;
203 }
204
205
206 /**
207 * Returns a specific repetition of
208 * OBSERVATION (a Group object) - creates it if necessary
209 *
210 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
211 * @throws HL7Exception if the repetition requested is more than one
212 * greater than the number of existing repetitions.
213 */
214 public RSP_Z90_OBSERVATION getOBSERVATION(int rep) {
215 RSP_Z90_OBSERVATION retVal = getTyped("OBSERVATION", rep, RSP_Z90_OBSERVATION.class);
216 return retVal;
217 }
218
219 /**
220 * Returns the number of existing repetitions of OBSERVATION
221 */
222 public int getOBSERVATIONReps() {
223 return getReps("OBSERVATION");
224 }
225
226 /**
227 * <p>
228 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
229 * <p>
230 * <p>
231 * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
232 * if none are already present, so an empty list may be returned.
233 * </p>
234 */
235 public java.util.List<RSP_Z90_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
236 return getAllAsList("OBSERVATION", RSP_Z90_OBSERVATION.class);
237 }
238
239 /**
240 * Inserts a specific repetition of OBSERVATION (a Group object)
241 * @see AbstractGroup#insertRepetition(Structure, int)
242 */
243 public void insertOBSERVATION(RSP_Z90_OBSERVATION structure, int rep) throws HL7Exception {
244 super.insertRepetition("OBSERVATION", structure, rep);
245 }
246
247
248 /**
249 * Inserts a specific repetition of OBSERVATION (a Group object)
250 * @see AbstractGroup#insertRepetition(Structure, int)
251 */
252 public RSP_Z90_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
253 return (RSP_Z90_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
254 }
255
256
257 /**
258 * Removes a specific repetition of OBSERVATION (a Group object)
259 * @see AbstractGroup#removeRepetition(String, int)
260 */
261 public RSP_Z90_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
262 return (RSP_Z90_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
263 }
264
265
266
267 }
268