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