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