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.v28.group; 035 036import ca.uhn.hl7v2.model.v28.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a RAS_O17_ENCODING group structure (a Group object). 044 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. 045 * This Group contains the following elements: 046 * </p> 047 * <ul> 048 * <li>1: RXE (Pharmacy/Treatment Encoded Order) <b> </b></li> 049 * <li>2: PRT (Participation Information) <b>optional repeating </b></li> 050 * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li> 051 * <li>4: RAS_O17_TIMING_ENCODED (a Group object) <b> repeating </b></li> 052 * <li>5: RXR (Pharmacy/Treatment Route) <b> repeating </b></li> 053 * <li>6: RXC (Pharmacy/Treatment Component Order) <b>optional repeating </b></li> 054 * <li>7: CDO (Cumulative Dosage) <b>optional repeating </b></li> 055 * </ul> 056 */ 057//@SuppressWarnings("unused") 058public class RAS_O17_ENCODING extends AbstractGroup { 059 060 /** 061 * Creates a new RAS_O17_ENCODING group 062 */ 063 public RAS_O17_ENCODING(Group parent, ModelClassFactory factory) { 064 super(parent, factory); 065 init(factory); 066 } 067 068 private void init(ModelClassFactory factory) { 069 try { 070 this.add(RXE.class, true, false, false); 071 this.add(PRT.class, false, true, false); 072 this.add(NTE.class, false, true, false); 073 this.add(RAS_O17_TIMING_ENCODED.class, true, true, false); 074 this.add(RXR.class, true, true, false); 075 this.add(RXC.class, false, true, false); 076 this.add(CDO.class, false, true, false); 077 } catch(HL7Exception e) { 078 log.error("Unexpected error creating RAS_O17_ENCODING - this is probably a bug in the source code generator.", e); 079 } 080 } 081 082 /** 083 * Returns "2.8" 084 */ 085 public String getVersion() { 086 return "2.8"; 087 } 088 089 090 091 /** 092 * Returns 093 * RXE (Pharmacy/Treatment Encoded Order) - creates it if necessary 094 */ 095 public RXE getRXE() { 096 RXE retVal = getTyped("RXE", RXE.class); 097 return retVal; 098 } 099 100 101 102 103 /** 104 * Returns 105 * the first repetition of 106 * PRT (Participation Information) - creates it if necessary 107 */ 108 public PRT getPRT() { 109 PRT retVal = getTyped("PRT", PRT.class); 110 return retVal; 111 } 112 113 114 /** 115 * Returns a specific repetition of 116 * PRT (Participation Information) - creates it if necessary 117 * 118 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 119 * @throws HL7Exception if the repetition requested is more than one 120 * greater than the number of existing repetitions. 121 */ 122 public PRT getPRT(int rep) { 123 PRT retVal = getTyped("PRT", rep, PRT.class); 124 return retVal; 125 } 126 127 /** 128 * Returns the number of existing repetitions of PRT 129 */ 130 public int getPRTReps() { 131 return getReps("PRT"); 132 } 133 134 /** 135 * <p> 136 * Returns a non-modifiable List containing all current existing repetitions of PRT. 137 * <p> 138 * <p> 139 * Note that unlike {@link #getPRT()}, this method will not create any reps 140 * if none are already present, so an empty list may be returned. 141 * </p> 142 */ 143 public java.util.List<PRT> getPRTAll() throws HL7Exception { 144 return getAllAsList("PRT", PRT.class); 145 } 146 147 /** 148 * Inserts a specific repetition of PRT (Participation Information) 149 * @see AbstractGroup#insertRepetition(Structure, int) 150 */ 151 public void insertPRT(PRT structure, int rep) throws HL7Exception { 152 super.insertRepetition("PRT", structure, rep); 153 } 154 155 156 /** 157 * Inserts a specific repetition of PRT (Participation Information) 158 * @see AbstractGroup#insertRepetition(Structure, int) 159 */ 160 public PRT insertPRT(int rep) throws HL7Exception { 161 return (PRT)super.insertRepetition("PRT", rep); 162 } 163 164 165 /** 166 * Removes a specific repetition of PRT (Participation Information) 167 * @see AbstractGroup#removeRepetition(String, int) 168 */ 169 public PRT removePRT(int rep) throws HL7Exception { 170 return (PRT)super.removeRepetition("PRT", rep); 171 } 172 173 174 175 /** 176 * Returns 177 * the first repetition of 178 * NTE (Notes and Comments) - creates it if necessary 179 */ 180 public NTE getNTE() { 181 NTE retVal = getTyped("NTE", NTE.class); 182 return retVal; 183 } 184 185 186 /** 187 * Returns a specific repetition of 188 * NTE (Notes and Comments) - creates it if necessary 189 * 190 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 191 * @throws HL7Exception if the repetition requested is more than one 192 * greater than the number of existing repetitions. 193 */ 194 public NTE getNTE(int rep) { 195 NTE retVal = getTyped("NTE", rep, NTE.class); 196 return retVal; 197 } 198 199 /** 200 * Returns the number of existing repetitions of NTE 201 */ 202 public int getNTEReps() { 203 return getReps("NTE"); 204 } 205 206 /** 207 * <p> 208 * Returns a non-modifiable List containing all current existing repetitions of NTE. 209 * <p> 210 * <p> 211 * Note that unlike {@link #getNTE()}, this method will not create any reps 212 * if none are already present, so an empty list may be returned. 213 * </p> 214 */ 215 public java.util.List<NTE> getNTEAll() throws HL7Exception { 216 return getAllAsList("NTE", NTE.class); 217 } 218 219 /** 220 * Inserts a specific repetition of NTE (Notes and Comments) 221 * @see AbstractGroup#insertRepetition(Structure, int) 222 */ 223 public void insertNTE(NTE structure, int rep) throws HL7Exception { 224 super.insertRepetition("NTE", structure, rep); 225 } 226 227 228 /** 229 * Inserts a specific repetition of NTE (Notes and Comments) 230 * @see AbstractGroup#insertRepetition(Structure, int) 231 */ 232 public NTE insertNTE(int rep) throws HL7Exception { 233 return (NTE)super.insertRepetition("NTE", rep); 234 } 235 236 237 /** 238 * Removes a specific repetition of NTE (Notes and Comments) 239 * @see AbstractGroup#removeRepetition(String, int) 240 */ 241 public NTE removeNTE(int rep) throws HL7Exception { 242 return (NTE)super.removeRepetition("NTE", rep); 243 } 244 245 246 247 /** 248 * Returns 249 * the first repetition of 250 * TIMING_ENCODED (a Group object) - creates it if necessary 251 */ 252 public RAS_O17_TIMING_ENCODED getTIMING_ENCODED() { 253 RAS_O17_TIMING_ENCODED retVal = getTyped("TIMING_ENCODED", RAS_O17_TIMING_ENCODED.class); 254 return retVal; 255 } 256 257 258 /** 259 * Returns a specific repetition of 260 * TIMING_ENCODED (a Group object) - creates it if necessary 261 * 262 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 263 * @throws HL7Exception if the repetition requested is more than one 264 * greater than the number of existing repetitions. 265 */ 266 public RAS_O17_TIMING_ENCODED getTIMING_ENCODED(int rep) { 267 RAS_O17_TIMING_ENCODED retVal = getTyped("TIMING_ENCODED", rep, RAS_O17_TIMING_ENCODED.class); 268 return retVal; 269 } 270 271 /** 272 * Returns the number of existing repetitions of TIMING_ENCODED 273 */ 274 public int getTIMING_ENCODEDReps() { 275 return getReps("TIMING_ENCODED"); 276 } 277 278 /** 279 * <p> 280 * Returns a non-modifiable List containing all current existing repetitions of TIMING_ENCODED. 281 * <p> 282 * <p> 283 * Note that unlike {@link #getTIMING_ENCODED()}, this method will not create any reps 284 * if none are already present, so an empty list may be returned. 285 * </p> 286 */ 287 public java.util.List<RAS_O17_TIMING_ENCODED> getTIMING_ENCODEDAll() throws HL7Exception { 288 return getAllAsList("TIMING_ENCODED", RAS_O17_TIMING_ENCODED.class); 289 } 290 291 /** 292 * Inserts a specific repetition of TIMING_ENCODED (a Group object) 293 * @see AbstractGroup#insertRepetition(Structure, int) 294 */ 295 public void insertTIMING_ENCODED(RAS_O17_TIMING_ENCODED structure, int rep) throws HL7Exception { 296 super.insertRepetition("TIMING_ENCODED", structure, rep); 297 } 298 299 300 /** 301 * Inserts a specific repetition of TIMING_ENCODED (a Group object) 302 * @see AbstractGroup#insertRepetition(Structure, int) 303 */ 304 public RAS_O17_TIMING_ENCODED insertTIMING_ENCODED(int rep) throws HL7Exception { 305 return (RAS_O17_TIMING_ENCODED)super.insertRepetition("TIMING_ENCODED", rep); 306 } 307 308 309 /** 310 * Removes a specific repetition of TIMING_ENCODED (a Group object) 311 * @see AbstractGroup#removeRepetition(String, int) 312 */ 313 public RAS_O17_TIMING_ENCODED removeTIMING_ENCODED(int rep) throws HL7Exception { 314 return (RAS_O17_TIMING_ENCODED)super.removeRepetition("TIMING_ENCODED", rep); 315 } 316 317 318 319 /** 320 * Returns 321 * the first repetition of 322 * RXR (Pharmacy/Treatment Route) - creates it if necessary 323 */ 324 public RXR getRXR() { 325 RXR retVal = getTyped("RXR", RXR.class); 326 return retVal; 327 } 328 329 330 /** 331 * Returns a specific repetition of 332 * RXR (Pharmacy/Treatment Route) - creates it if necessary 333 * 334 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 335 * @throws HL7Exception if the repetition requested is more than one 336 * greater than the number of existing repetitions. 337 */ 338 public RXR getRXR(int rep) { 339 RXR retVal = getTyped("RXR", rep, RXR.class); 340 return retVal; 341 } 342 343 /** 344 * Returns the number of existing repetitions of RXR 345 */ 346 public int getRXRReps() { 347 return getReps("RXR"); 348 } 349 350 /** 351 * <p> 352 * Returns a non-modifiable List containing all current existing repetitions of RXR. 353 * <p> 354 * <p> 355 * Note that unlike {@link #getRXR()}, this method will not create any reps 356 * if none are already present, so an empty list may be returned. 357 * </p> 358 */ 359 public java.util.List<RXR> getRXRAll() throws HL7Exception { 360 return getAllAsList("RXR", RXR.class); 361 } 362 363 /** 364 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route) 365 * @see AbstractGroup#insertRepetition(Structure, int) 366 */ 367 public void insertRXR(RXR structure, int rep) throws HL7Exception { 368 super.insertRepetition("RXR", structure, rep); 369 } 370 371 372 /** 373 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route) 374 * @see AbstractGroup#insertRepetition(Structure, int) 375 */ 376 public RXR insertRXR(int rep) throws HL7Exception { 377 return (RXR)super.insertRepetition("RXR", rep); 378 } 379 380 381 /** 382 * Removes a specific repetition of RXR (Pharmacy/Treatment Route) 383 * @see AbstractGroup#removeRepetition(String, int) 384 */ 385 public RXR removeRXR(int rep) throws HL7Exception { 386 return (RXR)super.removeRepetition("RXR", rep); 387 } 388 389 390 391 /** 392 * Returns 393 * the first repetition of 394 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary 395 */ 396 public RXC getRXC() { 397 RXC retVal = getTyped("RXC", RXC.class); 398 return retVal; 399 } 400 401 402 /** 403 * Returns a specific repetition of 404 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary 405 * 406 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 407 * @throws HL7Exception if the repetition requested is more than one 408 * greater than the number of existing repetitions. 409 */ 410 public RXC getRXC(int rep) { 411 RXC retVal = getTyped("RXC", rep, RXC.class); 412 return retVal; 413 } 414 415 /** 416 * Returns the number of existing repetitions of RXC 417 */ 418 public int getRXCReps() { 419 return getReps("RXC"); 420 } 421 422 /** 423 * <p> 424 * Returns a non-modifiable List containing all current existing repetitions of RXC. 425 * <p> 426 * <p> 427 * Note that unlike {@link #getRXC()}, this method will not create any reps 428 * if none are already present, so an empty list may be returned. 429 * </p> 430 */ 431 public java.util.List<RXC> getRXCAll() throws HL7Exception { 432 return getAllAsList("RXC", RXC.class); 433 } 434 435 /** 436 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order) 437 * @see AbstractGroup#insertRepetition(Structure, int) 438 */ 439 public void insertRXC(RXC structure, int rep) throws HL7Exception { 440 super.insertRepetition("RXC", structure, rep); 441 } 442 443 444 /** 445 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order) 446 * @see AbstractGroup#insertRepetition(Structure, int) 447 */ 448 public RXC insertRXC(int rep) throws HL7Exception { 449 return (RXC)super.insertRepetition("RXC", rep); 450 } 451 452 453 /** 454 * Removes a specific repetition of RXC (Pharmacy/Treatment Component Order) 455 * @see AbstractGroup#removeRepetition(String, int) 456 */ 457 public RXC removeRXC(int rep) throws HL7Exception { 458 return (RXC)super.removeRepetition("RXC", rep); 459 } 460 461 462 463 /** 464 * Returns 465 * the first repetition of 466 * CDO (Cumulative Dosage) - creates it if necessary 467 */ 468 public CDO getCDO() { 469 CDO retVal = getTyped("CDO", CDO.class); 470 return retVal; 471 } 472 473 474 /** 475 * Returns a specific repetition of 476 * CDO (Cumulative Dosage) - creates it if necessary 477 * 478 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 479 * @throws HL7Exception if the repetition requested is more than one 480 * greater than the number of existing repetitions. 481 */ 482 public CDO getCDO(int rep) { 483 CDO retVal = getTyped("CDO", rep, CDO.class); 484 return retVal; 485 } 486 487 /** 488 * Returns the number of existing repetitions of CDO 489 */ 490 public int getCDOReps() { 491 return getReps("CDO"); 492 } 493 494 /** 495 * <p> 496 * Returns a non-modifiable List containing all current existing repetitions of CDO. 497 * <p> 498 * <p> 499 * Note that unlike {@link #getCDO()}, this method will not create any reps 500 * if none are already present, so an empty list may be returned. 501 * </p> 502 */ 503 public java.util.List<CDO> getCDOAll() throws HL7Exception { 504 return getAllAsList("CDO", CDO.class); 505 } 506 507 /** 508 * Inserts a specific repetition of CDO (Cumulative Dosage) 509 * @see AbstractGroup#insertRepetition(Structure, int) 510 */ 511 public void insertCDO(CDO structure, int rep) throws HL7Exception { 512 super.insertRepetition("CDO", structure, rep); 513 } 514 515 516 /** 517 * Inserts a specific repetition of CDO (Cumulative Dosage) 518 * @see AbstractGroup#insertRepetition(Structure, int) 519 */ 520 public CDO insertCDO(int rep) throws HL7Exception { 521 return (CDO)super.insertRepetition("CDO", rep); 522 } 523 524 525 /** 526 * Removes a specific repetition of CDO (Cumulative Dosage) 527 * @see AbstractGroup#removeRepetition(String, int) 528 */ 529 public CDO removeCDO(int rep) throws HL7Exception { 530 return (CDO)super.removeRepetition("CDO", rep); 531 } 532 533 534 535} 536