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 RGV_O15_GIVE 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: RXG (Pharmacy/Treatment Give) <b> </b></li> 049 * <li>2: RGV_O15_TIMING_GIVE (a Group object) <b> repeating </b></li> 050 * <li>3: RXR (Pharmacy/Treatment Route) <b> repeating </b></li> 051 * <li>4: RXC (Pharmacy/Treatment Component Order) <b>optional repeating </b></li> 052 * <li>5: CDO (Cumulative Dosage) <b>optional repeating </b></li> 053 * <li>6: RGV_O15_OBSERVATION (a Group object) <b>optional repeating </b></li> 054 * </ul> 055 */ 056//@SuppressWarnings("unused") 057public class RGV_O15_GIVE extends AbstractGroup { 058 059 /** 060 * Creates a new RGV_O15_GIVE group 061 */ 062 public RGV_O15_GIVE(Group parent, ModelClassFactory factory) { 063 super(parent, factory); 064 init(factory); 065 } 066 067 private void init(ModelClassFactory factory) { 068 try { 069 this.add(RXG.class, true, false, false); 070 this.add(RGV_O15_TIMING_GIVE.class, true, true, false); 071 this.add(RXR.class, true, true, false); 072 this.add(RXC.class, false, true, false); 073 this.add(CDO.class, false, true, false); 074 this.add(RGV_O15_OBSERVATION.class, false, true, false); 075 } catch(HL7Exception e) { 076 log.error("Unexpected error creating RGV_O15_GIVE - this is probably a bug in the source code generator.", e); 077 } 078 } 079 080 /** 081 * Returns "2.8" 082 */ 083 public String getVersion() { 084 return "2.8"; 085 } 086 087 088 089 /** 090 * Returns 091 * RXG (Pharmacy/Treatment Give) - creates it if necessary 092 */ 093 public RXG getRXG() { 094 RXG retVal = getTyped("RXG", RXG.class); 095 return retVal; 096 } 097 098 099 100 101 /** 102 * Returns 103 * the first repetition of 104 * TIMING_GIVE (a Group object) - creates it if necessary 105 */ 106 public RGV_O15_TIMING_GIVE getTIMING_GIVE() { 107 RGV_O15_TIMING_GIVE retVal = getTyped("TIMING_GIVE", RGV_O15_TIMING_GIVE.class); 108 return retVal; 109 } 110 111 112 /** 113 * Returns a specific repetition of 114 * TIMING_GIVE (a Group object) - 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 RGV_O15_TIMING_GIVE getTIMING_GIVE(int rep) { 121 RGV_O15_TIMING_GIVE retVal = getTyped("TIMING_GIVE", rep, RGV_O15_TIMING_GIVE.class); 122 return retVal; 123 } 124 125 /** 126 * Returns the number of existing repetitions of TIMING_GIVE 127 */ 128 public int getTIMING_GIVEReps() { 129 return getReps("TIMING_GIVE"); 130 } 131 132 /** 133 * <p> 134 * Returns a non-modifiable List containing all current existing repetitions of TIMING_GIVE. 135 * <p> 136 * <p> 137 * Note that unlike {@link #getTIMING_GIVE()}, 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<RGV_O15_TIMING_GIVE> getTIMING_GIVEAll() throws HL7Exception { 142 return getAllAsList("TIMING_GIVE", RGV_O15_TIMING_GIVE.class); 143 } 144 145 /** 146 * Inserts a specific repetition of TIMING_GIVE (a Group object) 147 * @see AbstractGroup#insertRepetition(Structure, int) 148 */ 149 public void insertTIMING_GIVE(RGV_O15_TIMING_GIVE structure, int rep) throws HL7Exception { 150 super.insertRepetition("TIMING_GIVE", structure, rep); 151 } 152 153 154 /** 155 * Inserts a specific repetition of TIMING_GIVE (a Group object) 156 * @see AbstractGroup#insertRepetition(Structure, int) 157 */ 158 public RGV_O15_TIMING_GIVE insertTIMING_GIVE(int rep) throws HL7Exception { 159 return (RGV_O15_TIMING_GIVE)super.insertRepetition("TIMING_GIVE", rep); 160 } 161 162 163 /** 164 * Removes a specific repetition of TIMING_GIVE (a Group object) 165 * @see AbstractGroup#removeRepetition(String, int) 166 */ 167 public RGV_O15_TIMING_GIVE removeTIMING_GIVE(int rep) throws HL7Exception { 168 return (RGV_O15_TIMING_GIVE)super.removeRepetition("TIMING_GIVE", rep); 169 } 170 171 172 173 /** 174 * Returns 175 * the first repetition of 176 * RXR (Pharmacy/Treatment Route) - creates it if necessary 177 */ 178 public RXR getRXR() { 179 RXR retVal = getTyped("RXR", RXR.class); 180 return retVal; 181 } 182 183 184 /** 185 * Returns a specific repetition of 186 * RXR (Pharmacy/Treatment Route) - 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 RXR getRXR(int rep) { 193 RXR retVal = getTyped("RXR", rep, RXR.class); 194 return retVal; 195 } 196 197 /** 198 * Returns the number of existing repetitions of RXR 199 */ 200 public int getRXRReps() { 201 return getReps("RXR"); 202 } 203 204 /** 205 * <p> 206 * Returns a non-modifiable List containing all current existing repetitions of RXR. 207 * <p> 208 * <p> 209 * Note that unlike {@link #getRXR()}, 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<RXR> getRXRAll() throws HL7Exception { 214 return getAllAsList("RXR", RXR.class); 215 } 216 217 /** 218 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route) 219 * @see AbstractGroup#insertRepetition(Structure, int) 220 */ 221 public void insertRXR(RXR structure, int rep) throws HL7Exception { 222 super.insertRepetition("RXR", structure, rep); 223 } 224 225 226 /** 227 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route) 228 * @see AbstractGroup#insertRepetition(Structure, int) 229 */ 230 public RXR insertRXR(int rep) throws HL7Exception { 231 return (RXR)super.insertRepetition("RXR", rep); 232 } 233 234 235 /** 236 * Removes a specific repetition of RXR (Pharmacy/Treatment Route) 237 * @see AbstractGroup#removeRepetition(String, int) 238 */ 239 public RXR removeRXR(int rep) throws HL7Exception { 240 return (RXR)super.removeRepetition("RXR", rep); 241 } 242 243 244 245 /** 246 * Returns 247 * the first repetition of 248 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary 249 */ 250 public RXC getRXC() { 251 RXC retVal = getTyped("RXC", RXC.class); 252 return retVal; 253 } 254 255 256 /** 257 * Returns a specific repetition of 258 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary 259 * 260 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 261 * @throws HL7Exception if the repetition requested is more than one 262 * greater than the number of existing repetitions. 263 */ 264 public RXC getRXC(int rep) { 265 RXC retVal = getTyped("RXC", rep, RXC.class); 266 return retVal; 267 } 268 269 /** 270 * Returns the number of existing repetitions of RXC 271 */ 272 public int getRXCReps() { 273 return getReps("RXC"); 274 } 275 276 /** 277 * <p> 278 * Returns a non-modifiable List containing all current existing repetitions of RXC. 279 * <p> 280 * <p> 281 * Note that unlike {@link #getRXC()}, this method will not create any reps 282 * if none are already present, so an empty list may be returned. 283 * </p> 284 */ 285 public java.util.List<RXC> getRXCAll() throws HL7Exception { 286 return getAllAsList("RXC", RXC.class); 287 } 288 289 /** 290 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order) 291 * @see AbstractGroup#insertRepetition(Structure, int) 292 */ 293 public void insertRXC(RXC structure, int rep) throws HL7Exception { 294 super.insertRepetition("RXC", structure, rep); 295 } 296 297 298 /** 299 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order) 300 * @see AbstractGroup#insertRepetition(Structure, int) 301 */ 302 public RXC insertRXC(int rep) throws HL7Exception { 303 return (RXC)super.insertRepetition("RXC", rep); 304 } 305 306 307 /** 308 * Removes a specific repetition of RXC (Pharmacy/Treatment Component Order) 309 * @see AbstractGroup#removeRepetition(String, int) 310 */ 311 public RXC removeRXC(int rep) throws HL7Exception { 312 return (RXC)super.removeRepetition("RXC", rep); 313 } 314 315 316 317 /** 318 * Returns 319 * the first repetition of 320 * CDO (Cumulative Dosage) - creates it if necessary 321 */ 322 public CDO getCDO() { 323 CDO retVal = getTyped("CDO", CDO.class); 324 return retVal; 325 } 326 327 328 /** 329 * Returns a specific repetition of 330 * CDO (Cumulative Dosage) - creates it if necessary 331 * 332 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 333 * @throws HL7Exception if the repetition requested is more than one 334 * greater than the number of existing repetitions. 335 */ 336 public CDO getCDO(int rep) { 337 CDO retVal = getTyped("CDO", rep, CDO.class); 338 return retVal; 339 } 340 341 /** 342 * Returns the number of existing repetitions of CDO 343 */ 344 public int getCDOReps() { 345 return getReps("CDO"); 346 } 347 348 /** 349 * <p> 350 * Returns a non-modifiable List containing all current existing repetitions of CDO. 351 * <p> 352 * <p> 353 * Note that unlike {@link #getCDO()}, this method will not create any reps 354 * if none are already present, so an empty list may be returned. 355 * </p> 356 */ 357 public java.util.List<CDO> getCDOAll() throws HL7Exception { 358 return getAllAsList("CDO", CDO.class); 359 } 360 361 /** 362 * Inserts a specific repetition of CDO (Cumulative Dosage) 363 * @see AbstractGroup#insertRepetition(Structure, int) 364 */ 365 public void insertCDO(CDO structure, int rep) throws HL7Exception { 366 super.insertRepetition("CDO", structure, rep); 367 } 368 369 370 /** 371 * Inserts a specific repetition of CDO (Cumulative Dosage) 372 * @see AbstractGroup#insertRepetition(Structure, int) 373 */ 374 public CDO insertCDO(int rep) throws HL7Exception { 375 return (CDO)super.insertRepetition("CDO", rep); 376 } 377 378 379 /** 380 * Removes a specific repetition of CDO (Cumulative Dosage) 381 * @see AbstractGroup#removeRepetition(String, int) 382 */ 383 public CDO removeCDO(int rep) throws HL7Exception { 384 return (CDO)super.removeRepetition("CDO", rep); 385 } 386 387 388 389 /** 390 * Returns 391 * the first repetition of 392 * OBSERVATION (a Group object) - creates it if necessary 393 */ 394 public RGV_O15_OBSERVATION getOBSERVATION() { 395 RGV_O15_OBSERVATION retVal = getTyped("OBSERVATION", RGV_O15_OBSERVATION.class); 396 return retVal; 397 } 398 399 400 /** 401 * Returns a specific repetition of 402 * OBSERVATION (a Group object) - creates it if necessary 403 * 404 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 405 * @throws HL7Exception if the repetition requested is more than one 406 * greater than the number of existing repetitions. 407 */ 408 public RGV_O15_OBSERVATION getOBSERVATION(int rep) { 409 RGV_O15_OBSERVATION retVal = getTyped("OBSERVATION", rep, RGV_O15_OBSERVATION.class); 410 return retVal; 411 } 412 413 /** 414 * Returns the number of existing repetitions of OBSERVATION 415 */ 416 public int getOBSERVATIONReps() { 417 return getReps("OBSERVATION"); 418 } 419 420 /** 421 * <p> 422 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION. 423 * <p> 424 * <p> 425 * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps 426 * if none are already present, so an empty list may be returned. 427 * </p> 428 */ 429 public java.util.List<RGV_O15_OBSERVATION> getOBSERVATIONAll() throws HL7Exception { 430 return getAllAsList("OBSERVATION", RGV_O15_OBSERVATION.class); 431 } 432 433 /** 434 * Inserts a specific repetition of OBSERVATION (a Group object) 435 * @see AbstractGroup#insertRepetition(Structure, int) 436 */ 437 public void insertOBSERVATION(RGV_O15_OBSERVATION structure, int rep) throws HL7Exception { 438 super.insertRepetition("OBSERVATION", structure, rep); 439 } 440 441 442 /** 443 * Inserts a specific repetition of OBSERVATION (a Group object) 444 * @see AbstractGroup#insertRepetition(Structure, int) 445 */ 446 public RGV_O15_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 447 return (RGV_O15_OBSERVATION)super.insertRepetition("OBSERVATION", rep); 448 } 449 450 451 /** 452 * Removes a specific repetition of OBSERVATION (a Group object) 453 * @see AbstractGroup#removeRepetition(String, int) 454 */ 455 public RGV_O15_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 456 return (RGV_O15_OBSERVATION)super.removeRepetition("OBSERVATION", rep); 457 } 458 459 460 461} 462