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