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