001/* 002 * This class is an auto-generated source file for a HAPI 003 * HL7 v2.x standard structure class. 004 * 005 * For more information, visit: http://hl7api.sourceforge.net/ 006 * 007 * The contents of this file are subject to the Mozilla Public License Version 1.1 008 * (the "License"); you may not use this file except in compliance with the License. 009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 010 * Software distributed under the License is distributed on an "AS IS" basis, 011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 012 * specific language governing rights and limitations under the License. 013 * 014 * The Original Code is "[file_name]". Description: 015 * "[one_line_description]" 016 * 017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 018 * 2012. All Rights Reserved. 019 * 020 * Contributor(s): ______________________________________. 021 * 022 * Alternatively, the contents of this file may be used under the terms of the 023 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are 024 * applicable instead of those above. If you wish to allow use of your version of this 025 * file only under the terms of the GPL and not to allow others to use your version 026 * of this file under the MPL, indicate your decision by deleting the provisions above 027 * and replace them with the notice and other provisions required by the GPL License. 028 * If you do not delete the provisions above, a recipient may use your version of 029 * this file under either the MPL or the GPL. 030 * 031 */ 032 033 034package ca.uhn.hl7v2.model.v26.group; 035 036import ca.uhn.hl7v2.model.v26.segment.*; 037 038import java.util.List; 039 040import ca.uhn.hl7v2.HL7Exception; 041import ca.uhn.hl7v2.parser.ModelClassFactory; 042import ca.uhn.hl7v2.model.*; 043 044/** 045 * <p>Represents a EHC_E01_PATIENT_INFO group structure (a Group object). 046 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. 047 * This Group contains the following elements: 048 * </p> 049 * <ul> 050 * <li>1: PID (Patient Identification) <b> </b></li> 051 * <li>2: PV1 (Patient Visit) <b>optional </b></li> 052 * <li>3: PV2 (Patient Visit - Additional Information) <b>optional </b></li> 053 * <li>4: ACC (Accident) <b>optional repeating</b></li> 054 * <li>5: EHC_E01_INSURANCE (a Group object) <b> repeating</b></li> 055 * <li>6: EHC_E01_DIAGNOSIS (a Group object) <b>optional repeating</b></li> 056 * <li>7: OBX (Observation/Result) <b>optional repeating</b></li> 057 * </ul> 058 */ 059@SuppressWarnings("unused") 060public class EHC_E01_PATIENT_INFO extends AbstractGroup { 061 062 /** 063 * Creates a new EHC_E01_PATIENT_INFO group 064 */ 065 public EHC_E01_PATIENT_INFO(Group parent, ModelClassFactory factory) { 066 super(parent, factory); 067 init(factory); 068 } 069 070 private void init(ModelClassFactory factory) { 071 try { 072 this.add(PID.class, true, false); 073 this.add(PV1.class, false, false); 074 this.add(PV2.class, false, false); 075 this.add(ACC.class, false, true); 076 this.add(EHC_E01_INSURANCE.class, true, true); 077 this.add(EHC_E01_DIAGNOSIS.class, false, true); 078 this.add(OBX.class, false, true); 079 } catch(HL7Exception e) { 080 log.error("Unexpected error creating EHC_E01_PATIENT_INFO - this is probably a bug in the source code generator.", e); 081 } 082 } 083 084 /** 085 * Returns "2.6" 086 */ 087 public String getVersion() { 088 return "2.6"; 089 } 090 091 092 093 /** 094 * Returns 095 * PID (Patient Identification) - creates it if necessary 096 */ 097 public PID getPID() { 098 PID retVal = getTyped("PID", PID.class); 099 return retVal; 100 } 101 102 103 104 105 /** 106 * Returns 107 * PV1 (Patient Visit) - creates it if necessary 108 */ 109 public PV1 getPV1() { 110 PV1 retVal = getTyped("PV1", PV1.class); 111 return retVal; 112 } 113 114 115 116 117 /** 118 * Returns 119 * PV2 (Patient Visit - Additional Information) - creates it if necessary 120 */ 121 public PV2 getPV2() { 122 PV2 retVal = getTyped("PV2", PV2.class); 123 return retVal; 124 } 125 126 127 128 129 /** 130 * Returns 131 * the first repetition of 132 * ACC (Accident) - creates it if necessary 133 */ 134 public ACC getACC() { 135 ACC retVal = getTyped("ACC", ACC.class); 136 return retVal; 137 } 138 139 140 /** 141 * Returns a specific repetition of 142 * ACC (Accident) - creates it if necessary 143 * 144 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 145 * @throws HL7Exception if the repetition requested is more than one 146 * greater than the number of existing repetitions. 147 */ 148 public ACC getACC(int rep) { 149 ACC retVal = getTyped("ACC", rep, ACC.class); 150 return retVal; 151 } 152 153 /** 154 * Returns the number of existing repetitions of ACC 155 */ 156 public int getACCReps() { 157 return getReps("ACC"); 158 } 159 160 /** 161 * <p> 162 * Returns a non-modifiable List containing all current existing repetitions of ACC. 163 * <p> 164 * <p> 165 * Note that unlike {@link #getACC()}, this method will not create any reps 166 * if none are already present, so an empty list may be returned. 167 * </p> 168 */ 169 public List<ACC> getACCAll() throws HL7Exception { 170 return getAllAsList("ACC", ACC.class); 171 } 172 173 /** 174 * Inserts a specific repetition of ACC (Accident) 175 * @see AbstractGroup#insertRepetition(Structure, int) 176 */ 177 public void insertACC(ACC structure, int rep) throws HL7Exception { 178 super.insertRepetition("ACC", structure, rep); 179 } 180 181 182 /** 183 * Inserts a specific repetition of ACC (Accident) 184 * @see AbstractGroup#insertRepetition(Structure, int) 185 */ 186 public ACC insertACC(int rep) throws HL7Exception { 187 return (ACC)super.insertRepetition("ACC", rep); 188 } 189 190 191 /** 192 * Removes a specific repetition of ACC (Accident) 193 * @see AbstractGroup#removeRepetition(String, int) 194 */ 195 public ACC removeACC(int rep) throws HL7Exception { 196 return (ACC)super.removeRepetition("ACC", rep); 197 } 198 199 200 201 /** 202 * Returns 203 * the first repetition of 204 * INSURANCE (a Group object) - creates it if necessary 205 */ 206 public EHC_E01_INSURANCE getINSURANCE() { 207 EHC_E01_INSURANCE retVal = getTyped("INSURANCE", EHC_E01_INSURANCE.class); 208 return retVal; 209 } 210 211 212 /** 213 * Returns a specific repetition of 214 * INSURANCE (a Group object) - creates it if necessary 215 * 216 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 217 * @throws HL7Exception if the repetition requested is more than one 218 * greater than the number of existing repetitions. 219 */ 220 public EHC_E01_INSURANCE getINSURANCE(int rep) { 221 EHC_E01_INSURANCE retVal = getTyped("INSURANCE", rep, EHC_E01_INSURANCE.class); 222 return retVal; 223 } 224 225 /** 226 * Returns the number of existing repetitions of INSURANCE 227 */ 228 public int getINSURANCEReps() { 229 return getReps("INSURANCE"); 230 } 231 232 /** 233 * <p> 234 * Returns a non-modifiable List containing all current existing repetitions of INSURANCE. 235 * <p> 236 * <p> 237 * Note that unlike {@link #getINSURANCE()}, this method will not create any reps 238 * if none are already present, so an empty list may be returned. 239 * </p> 240 */ 241 public List<EHC_E01_INSURANCE> getINSURANCEAll() throws HL7Exception { 242 return getAllAsList("INSURANCE", EHC_E01_INSURANCE.class); 243 } 244 245 /** 246 * Inserts a specific repetition of INSURANCE (a Group object) 247 * @see AbstractGroup#insertRepetition(Structure, int) 248 */ 249 public void insertINSURANCE(EHC_E01_INSURANCE structure, int rep) throws HL7Exception { 250 super.insertRepetition("INSURANCE", structure, rep); 251 } 252 253 254 /** 255 * Inserts a specific repetition of INSURANCE (a Group object) 256 * @see AbstractGroup#insertRepetition(Structure, int) 257 */ 258 public EHC_E01_INSURANCE insertINSURANCE(int rep) throws HL7Exception { 259 return (EHC_E01_INSURANCE)super.insertRepetition("INSURANCE", rep); 260 } 261 262 263 /** 264 * Removes a specific repetition of INSURANCE (a Group object) 265 * @see AbstractGroup#removeRepetition(String, int) 266 */ 267 public EHC_E01_INSURANCE removeINSURANCE(int rep) throws HL7Exception { 268 return (EHC_E01_INSURANCE)super.removeRepetition("INSURANCE", rep); 269 } 270 271 272 273 /** 274 * Returns 275 * the first repetition of 276 * DIAGNOSIS (a Group object) - creates it if necessary 277 */ 278 public EHC_E01_DIAGNOSIS getDIAGNOSIS() { 279 EHC_E01_DIAGNOSIS retVal = getTyped("DIAGNOSIS", EHC_E01_DIAGNOSIS.class); 280 return retVal; 281 } 282 283 284 /** 285 * Returns a specific repetition of 286 * DIAGNOSIS (a Group object) - creates it if necessary 287 * 288 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 289 * @throws HL7Exception if the repetition requested is more than one 290 * greater than the number of existing repetitions. 291 */ 292 public EHC_E01_DIAGNOSIS getDIAGNOSIS(int rep) { 293 EHC_E01_DIAGNOSIS retVal = getTyped("DIAGNOSIS", rep, EHC_E01_DIAGNOSIS.class); 294 return retVal; 295 } 296 297 /** 298 * Returns the number of existing repetitions of DIAGNOSIS 299 */ 300 public int getDIAGNOSISReps() { 301 return getReps("DIAGNOSIS"); 302 } 303 304 /** 305 * <p> 306 * Returns a non-modifiable List containing all current existing repetitions of DIAGNOSIS. 307 * <p> 308 * <p> 309 * Note that unlike {@link #getDIAGNOSIS()}, this method will not create any reps 310 * if none are already present, so an empty list may be returned. 311 * </p> 312 */ 313 public List<EHC_E01_DIAGNOSIS> getDIAGNOSISAll() throws HL7Exception { 314 return getAllAsList("DIAGNOSIS", EHC_E01_DIAGNOSIS.class); 315 } 316 317 /** 318 * Inserts a specific repetition of DIAGNOSIS (a Group object) 319 * @see AbstractGroup#insertRepetition(Structure, int) 320 */ 321 public void insertDIAGNOSIS(EHC_E01_DIAGNOSIS structure, int rep) throws HL7Exception { 322 super.insertRepetition("DIAGNOSIS", structure, rep); 323 } 324 325 326 /** 327 * Inserts a specific repetition of DIAGNOSIS (a Group object) 328 * @see AbstractGroup#insertRepetition(Structure, int) 329 */ 330 public EHC_E01_DIAGNOSIS insertDIAGNOSIS(int rep) throws HL7Exception { 331 return (EHC_E01_DIAGNOSIS)super.insertRepetition("DIAGNOSIS", rep); 332 } 333 334 335 /** 336 * Removes a specific repetition of DIAGNOSIS (a Group object) 337 * @see AbstractGroup#removeRepetition(String, int) 338 */ 339 public EHC_E01_DIAGNOSIS removeDIAGNOSIS(int rep) throws HL7Exception { 340 return (EHC_E01_DIAGNOSIS)super.removeRepetition("DIAGNOSIS", rep); 341 } 342 343 344 345 /** 346 * Returns 347 * the first repetition of 348 * OBX (Observation/Result) - creates it if necessary 349 */ 350 public OBX getOBX() { 351 OBX retVal = getTyped("OBX", OBX.class); 352 return retVal; 353 } 354 355 356 /** 357 * Returns a specific repetition of 358 * OBX (Observation/Result) - creates it if necessary 359 * 360 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 361 * @throws HL7Exception if the repetition requested is more than one 362 * greater than the number of existing repetitions. 363 */ 364 public OBX getOBX(int rep) { 365 OBX retVal = getTyped("OBX", rep, OBX.class); 366 return retVal; 367 } 368 369 /** 370 * Returns the number of existing repetitions of OBX 371 */ 372 public int getOBXReps() { 373 return getReps("OBX"); 374 } 375 376 /** 377 * <p> 378 * Returns a non-modifiable List containing all current existing repetitions of OBX. 379 * <p> 380 * <p> 381 * Note that unlike {@link #getOBX()}, this method will not create any reps 382 * if none are already present, so an empty list may be returned. 383 * </p> 384 */ 385 public List<OBX> getOBXAll() throws HL7Exception { 386 return getAllAsList("OBX", OBX.class); 387 } 388 389 /** 390 * Inserts a specific repetition of OBX (Observation/Result) 391 * @see AbstractGroup#insertRepetition(Structure, int) 392 */ 393 public void insertOBX(OBX structure, int rep) throws HL7Exception { 394 super.insertRepetition("OBX", structure, rep); 395 } 396 397 398 /** 399 * Inserts a specific repetition of OBX (Observation/Result) 400 * @see AbstractGroup#insertRepetition(Structure, int) 401 */ 402 public OBX insertOBX(int rep) throws HL7Exception { 403 return (OBX)super.insertRepetition("OBX", rep); 404 } 405 406 407 /** 408 * Removes a specific repetition of OBX (Observation/Result) 409 * @see AbstractGroup#removeRepetition(String, int) 410 */ 411 public OBX removeOBX(int rep) throws HL7Exception { 412 return (OBX)super.removeRepetition("OBX", rep); 413 } 414 415 416 417} 418