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