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 CSU_C09_PATIENT 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: PID (Patient Identification) <b> </b></li>
49 * <li>2: PD1 (Patient Additional Demographic) <b>optional </b></li>
50 * <li>3: PRT (Participation Information) <b>optional repeating </b></li>
51 * <li>4: NTE (Notes and Comments) <b>optional repeating </b></li>
52 * <li>5: CSU_C09_VISIT (a Group object) <b>optional </b></li>
53 * <li>6: CSR (Clinical Study Registration) <b> </b></li>
54 * <li>7: CSU_C09_STUDY_PHASE (a Group object) <b> repeating </b></li>
55 * </ul>
56 */
57 //@SuppressWarnings("unused")
58 public class CSU_C09_PATIENT extends AbstractGroup {
59
60 /**
61 * Creates a new CSU_C09_PATIENT group
62 */
63 public CSU_C09_PATIENT(Group parent, ModelClassFactory factory) {
64 super(parent, factory);
65 init(factory);
66 }
67
68 private void init(ModelClassFactory factory) {
69 try {
70 this.add(PID.class, true, false, false);
71 this.add(PD1.class, false, false, false);
72 this.add(PRT.class, false, true, false);
73 this.add(NTE.class, false, true, false);
74 this.add(CSU_C09_VISIT.class, false, false, false);
75 this.add(CSR.class, true, false, false);
76 this.add(CSU_C09_STUDY_PHASE.class, true, true, false);
77 } catch(HL7Exception e) {
78 log.error("Unexpected error creating CSU_C09_PATIENT - this is probably a bug in the source code generator.", e);
79 }
80 }
81
82 /**
83 * Returns "2.7"
84 */
85 public String getVersion() {
86 return "2.7";
87 }
88
89
90
91 /**
92 * Returns
93 * PID (Patient Identification) - creates it if necessary
94 */
95 public PID getPID() {
96 PID retVal = getTyped("PID", PID.class);
97 return retVal;
98 }
99
100
101
102
103 /**
104 * Returns
105 * PD1 (Patient Additional Demographic) - creates it if necessary
106 */
107 public PD1 getPD1() {
108 PD1 retVal = getTyped("PD1", PD1.class);
109 return retVal;
110 }
111
112
113
114
115 /**
116 * Returns
117 * the first repetition of
118 * PRT (Participation Information) - creates it if necessary
119 */
120 public PRT getPRT() {
121 PRT retVal = getTyped("PRT", PRT.class);
122 return retVal;
123 }
124
125
126 /**
127 * Returns a specific repetition of
128 * PRT (Participation Information) - creates it if necessary
129 *
130 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
131 * @throws HL7Exception if the repetition requested is more than one
132 * greater than the number of existing repetitions.
133 */
134 public PRT getPRT(int rep) {
135 PRT retVal = getTyped("PRT", rep, PRT.class);
136 return retVal;
137 }
138
139 /**
140 * Returns the number of existing repetitions of PRT
141 */
142 public int getPRTReps() {
143 return getReps("PRT");
144 }
145
146 /**
147 * <p>
148 * Returns a non-modifiable List containing all current existing repetitions of PRT.
149 * <p>
150 * <p>
151 * Note that unlike {@link #getPRT()}, this method will not create any reps
152 * if none are already present, so an empty list may be returned.
153 * </p>
154 */
155 public java.util.List<PRT> getPRTAll() throws HL7Exception {
156 return getAllAsList("PRT", PRT.class);
157 }
158
159 /**
160 * Inserts a specific repetition of PRT (Participation Information)
161 * @see AbstractGroup#insertRepetition(Structure, int)
162 */
163 public void insertPRT(PRT structure, int rep) throws HL7Exception {
164 super.insertRepetition("PRT", structure, rep);
165 }
166
167
168 /**
169 * Inserts a specific repetition of PRT (Participation Information)
170 * @see AbstractGroup#insertRepetition(Structure, int)
171 */
172 public PRT insertPRT(int rep) throws HL7Exception {
173 return (PRT)super.insertRepetition("PRT", rep);
174 }
175
176
177 /**
178 * Removes a specific repetition of PRT (Participation Information)
179 * @see AbstractGroup#removeRepetition(String, int)
180 */
181 public PRT removePRT(int rep) throws HL7Exception {
182 return (PRT)super.removeRepetition("PRT", rep);
183 }
184
185
186
187 /**
188 * Returns
189 * the first repetition of
190 * NTE (Notes and Comments) - creates it if necessary
191 */
192 public NTE getNTE() {
193 NTE retVal = getTyped("NTE", NTE.class);
194 return retVal;
195 }
196
197
198 /**
199 * Returns a specific repetition of
200 * NTE (Notes and Comments) - creates it if necessary
201 *
202 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
203 * @throws HL7Exception if the repetition requested is more than one
204 * greater than the number of existing repetitions.
205 */
206 public NTE getNTE(int rep) {
207 NTE retVal = getTyped("NTE", rep, NTE.class);
208 return retVal;
209 }
210
211 /**
212 * Returns the number of existing repetitions of NTE
213 */
214 public int getNTEReps() {
215 return getReps("NTE");
216 }
217
218 /**
219 * <p>
220 * Returns a non-modifiable List containing all current existing repetitions of NTE.
221 * <p>
222 * <p>
223 * Note that unlike {@link #getNTE()}, this method will not create any reps
224 * if none are already present, so an empty list may be returned.
225 * </p>
226 */
227 public java.util.List<NTE> getNTEAll() throws HL7Exception {
228 return getAllAsList("NTE", NTE.class);
229 }
230
231 /**
232 * Inserts a specific repetition of NTE (Notes and Comments)
233 * @see AbstractGroup#insertRepetition(Structure, int)
234 */
235 public void insertNTE(NTE structure, int rep) throws HL7Exception {
236 super.insertRepetition("NTE", structure, rep);
237 }
238
239
240 /**
241 * Inserts a specific repetition of NTE (Notes and Comments)
242 * @see AbstractGroup#insertRepetition(Structure, int)
243 */
244 public NTE insertNTE(int rep) throws HL7Exception {
245 return (NTE)super.insertRepetition("NTE", rep);
246 }
247
248
249 /**
250 * Removes a specific repetition of NTE (Notes and Comments)
251 * @see AbstractGroup#removeRepetition(String, int)
252 */
253 public NTE removeNTE(int rep) throws HL7Exception {
254 return (NTE)super.removeRepetition("NTE", rep);
255 }
256
257
258
259 /**
260 * Returns
261 * VISIT (a Group object) - creates it if necessary
262 */
263 public CSU_C09_VISIT getVISIT() {
264 CSU_C09_VISIT retVal = getTyped("VISIT", CSU_C09_VISIT.class);
265 return retVal;
266 }
267
268
269
270
271 /**
272 * Returns
273 * CSR (Clinical Study Registration) - creates it if necessary
274 */
275 public CSR getCSR() {
276 CSR retVal = getTyped("CSR", CSR.class);
277 return retVal;
278 }
279
280
281
282
283 /**
284 * Returns
285 * the first repetition of
286 * STUDY_PHASE (a Group object) - creates it if necessary
287 */
288 public CSU_C09_STUDY_PHASE getSTUDY_PHASE() {
289 CSU_C09_STUDY_PHASE retVal = getTyped("STUDY_PHASE", CSU_C09_STUDY_PHASE.class);
290 return retVal;
291 }
292
293
294 /**
295 * Returns a specific repetition of
296 * STUDY_PHASE (a Group object) - creates it if necessary
297 *
298 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
299 * @throws HL7Exception if the repetition requested is more than one
300 * greater than the number of existing repetitions.
301 */
302 public CSU_C09_STUDY_PHASE getSTUDY_PHASE(int rep) {
303 CSU_C09_STUDY_PHASE retVal = getTyped("STUDY_PHASE", rep, CSU_C09_STUDY_PHASE.class);
304 return retVal;
305 }
306
307 /**
308 * Returns the number of existing repetitions of STUDY_PHASE
309 */
310 public int getSTUDY_PHASEReps() {
311 return getReps("STUDY_PHASE");
312 }
313
314 /**
315 * <p>
316 * Returns a non-modifiable List containing all current existing repetitions of STUDY_PHASE.
317 * <p>
318 * <p>
319 * Note that unlike {@link #getSTUDY_PHASE()}, this method will not create any reps
320 * if none are already present, so an empty list may be returned.
321 * </p>
322 */
323 public java.util.List<CSU_C09_STUDY_PHASE> getSTUDY_PHASEAll() throws HL7Exception {
324 return getAllAsList("STUDY_PHASE", CSU_C09_STUDY_PHASE.class);
325 }
326
327 /**
328 * Inserts a specific repetition of STUDY_PHASE (a Group object)
329 * @see AbstractGroup#insertRepetition(Structure, int)
330 */
331 public void insertSTUDY_PHASE(CSU_C09_STUDY_PHASE structure, int rep) throws HL7Exception {
332 super.insertRepetition("STUDY_PHASE", structure, rep);
333 }
334
335
336 /**
337 * Inserts a specific repetition of STUDY_PHASE (a Group object)
338 * @see AbstractGroup#insertRepetition(Structure, int)
339 */
340 public CSU_C09_STUDY_PHASE insertSTUDY_PHASE(int rep) throws HL7Exception {
341 return (CSU_C09_STUDY_PHASE)super.insertRepetition("STUDY_PHASE", rep);
342 }
343
344
345 /**
346 * Removes a specific repetition of STUDY_PHASE (a Group object)
347 * @see AbstractGroup#removeRepetition(String, int)
348 */
349 public CSU_C09_STUDY_PHASE removeSTUDY_PHASE(int rep) throws HL7Exception {
350 return (CSU_C09_STUDY_PHASE)super.removeRepetition("STUDY_PHASE", rep);
351 }
352
353
354
355 }
356