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