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.v23.segment; 035 036// import ca.uhn.hl7v2.model.v23.group.*; 037import ca.uhn.hl7v2.model.v23.datatype.*; 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 041import ca.uhn.hl7v2.model.AbstractMessage; 042import ca.uhn.hl7v2.model.Group; 043import ca.uhn.hl7v2.model.Type; 044import ca.uhn.hl7v2.model.AbstractSegment; 045import ca.uhn.hl7v2.model.Varies; 046 047/** 048 *<p>Represents an HL7 TXA message segment (Document notification segment). 049 * This segment has the following fields:</p> 050 * <ul> 051 * <li>TXA-1: Set ID- TXA (SI) <b> </b> 052 * <li>TXA-2: Document Type (IS) <b> </b> 053 * <li>TXA-3: Document Content Presentation (ID) <b>optional </b> 054 * <li>TXA-4: Activity Date/Time (TS) <b>optional </b> 055 * <li>TXA-5: Primary Activity Provider Code/Name (XCN) <b>optional </b> 056 * <li>TXA-6: Origination Date/Time (TS) <b>optional </b> 057 * <li>TXA-7: Transcription Date/Time (TS) <b>optional </b> 058 * <li>TXA-8: Edit Date/Time (TS) <b>optional repeating</b> 059 * <li>TXA-9: Originator Code/Name (XCN) <b>optional </b> 060 * <li>TXA-10: Assigned Document Authenticator (XCN) <b>optional repeating</b> 061 * <li>TXA-11: Transcriptionist Code/Name (XCN) <b>optional </b> 062 * <li>TXA-12: Unique Document Number (EI) <b> </b> 063 * <li>TXA-13: Parent Document Number (EI) <b>optional </b> 064 * <li>TXA-14: Placer Order Number (EI) <b>optional repeating</b> 065 * <li>TXA-15: Filler Order Number (EI) <b>optional </b> 066 * <li>TXA-16: Unique Document File Name (ST) <b>optional </b> 067 * <li>TXA-17: Document Completion Status (ID) <b> repeating</b> 068 * <li>TXA-18: Document Confidentiality Status (ID) <b>optional </b> 069 * <li>TXA-19: Document Availability Status (ID) <b>optional </b> 070 * <li>TXA-20: Document Storage Status (ID) <b>optional </b> 071 * <li>TXA-21: Document Change Reason (ST) <b>optional </b> 072 * <li>TXA-22: Authentication Person, Time Stamp (PPN) <b>optional repeating</b> 073 * <li>TXA-23: Distributed Copies (Code and Name of Recipients) (XCN) <b>optional repeating</b> 074 * </ul> 075 */ 076@SuppressWarnings("unused") 077public class TXA extends AbstractSegment { 078 079 /** 080 * Creates a new TXA segment 081 */ 082 public TXA(Group parent, ModelClassFactory factory) { 083 super(parent, factory); 084 init(factory); 085 } 086 087 private void init(ModelClassFactory factory) { 088 try { 089 this.add(SI.class, true, 1, 4, new Object[]{ getMessage() }, "Set ID- TXA"); 090 this.add(IS.class, true, 1, 30, new Object[]{ getMessage(), new Integer(270) }, "Document Type"); 091 this.add(ID.class, false, 1, 2, new Object[]{ getMessage(), new Integer(191) }, "Document Content Presentation"); 092 this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Activity Date/Time"); 093 this.add(XCN.class, false, 1, 60, new Object[]{ getMessage() }, "Primary Activity Provider Code/Name"); 094 this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Origination Date/Time"); 095 this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Transcription Date/Time"); 096 this.add(TS.class, false, 0, 26, new Object[]{ getMessage() }, "Edit Date/Time"); 097 this.add(XCN.class, false, 1, 60, new Object[]{ getMessage() }, "Originator Code/Name"); 098 this.add(XCN.class, false, 0, 60, new Object[]{ getMessage() }, "Assigned Document Authenticator"); 099 this.add(XCN.class, false, 1, 48, new Object[]{ getMessage() }, "Transcriptionist Code/Name"); 100 this.add(EI.class, true, 1, 30, new Object[]{ getMessage() }, "Unique Document Number"); 101 this.add(EI.class, false, 1, 30, new Object[]{ getMessage() }, "Parent Document Number"); 102 this.add(EI.class, false, 0, 22, new Object[]{ getMessage() }, "Placer Order Number"); 103 this.add(EI.class, false, 1, 22, new Object[]{ getMessage() }, "Filler Order Number"); 104 this.add(ST.class, false, 1, 30, new Object[]{ getMessage() }, "Unique Document File Name"); 105 this.add(ID.class, true, 0, 2, new Object[]{ getMessage(), new Integer(271) }, "Document Completion Status"); 106 this.add(ID.class, false, 1, 2, new Object[]{ getMessage(), new Integer(272) }, "Document Confidentiality Status"); 107 this.add(ID.class, false, 1, 2, new Object[]{ getMessage(), new Integer(273) }, "Document Availability Status"); 108 this.add(ID.class, false, 1, 2, new Object[]{ getMessage(), new Integer(275) }, "Document Storage Status"); 109 this.add(ST.class, false, 1, 30, new Object[]{ getMessage() }, "Document Change Reason"); 110 this.add(PPN.class, false, 0, 60, new Object[]{ getMessage() }, "Authentication Person, Time Stamp"); 111 this.add(XCN.class, false, 0, 60, new Object[]{ getMessage() }, "Distributed Copies (Code and Name of Recipients)"); 112 } catch(HL7Exception e) { 113 log.error("Unexpected error creating TXA - this is probably a bug in the source code generator.", e); 114 } 115 } 116 117 118 119 /** 120 * Returns 121 * TXA-1: "Set ID- TXA" - creates it if necessary 122 */ 123 public SI getSetIDTXA() { 124 SI retVal = this.getTypedField(1, 0); 125 return retVal; 126 } 127 128 /** 129 * Returns 130 * TXA-1: "Set ID- TXA" - creates it if necessary 131 */ 132 public SI getTxa1_SetIDTXA() { 133 SI retVal = this.getTypedField(1, 0); 134 return retVal; 135 } 136 137 138 139 /** 140 * Returns 141 * TXA-2: "Document Type" - creates it if necessary 142 */ 143 public IS getDocumentType() { 144 IS retVal = this.getTypedField(2, 0); 145 return retVal; 146 } 147 148 /** 149 * Returns 150 * TXA-2: "Document Type" - creates it if necessary 151 */ 152 public IS getTxa2_DocumentType() { 153 IS retVal = this.getTypedField(2, 0); 154 return retVal; 155 } 156 157 158 159 /** 160 * Returns 161 * TXA-3: "Document Content Presentation" - creates it if necessary 162 */ 163 public ID getDocumentContentPresentation() { 164 ID retVal = this.getTypedField(3, 0); 165 return retVal; 166 } 167 168 /** 169 * Returns 170 * TXA-3: "Document Content Presentation" - creates it if necessary 171 */ 172 public ID getTxa3_DocumentContentPresentation() { 173 ID retVal = this.getTypedField(3, 0); 174 return retVal; 175 } 176 177 178 179 /** 180 * Returns 181 * TXA-4: "Activity Date/Time" - creates it if necessary 182 */ 183 public TS getActivityDateTime() { 184 TS retVal = this.getTypedField(4, 0); 185 return retVal; 186 } 187 188 /** 189 * Returns 190 * TXA-4: "Activity Date/Time" - creates it if necessary 191 */ 192 public TS getTxa4_ActivityDateTime() { 193 TS retVal = this.getTypedField(4, 0); 194 return retVal; 195 } 196 197 198 199 /** 200 * Returns 201 * TXA-5: "Primary Activity Provider Code/Name" - creates it if necessary 202 */ 203 public XCN getPrimaryActivityProviderCodeName() { 204 XCN retVal = this.getTypedField(5, 0); 205 return retVal; 206 } 207 208 /** 209 * Returns 210 * TXA-5: "Primary Activity Provider Code/Name" - creates it if necessary 211 */ 212 public XCN getTxa5_PrimaryActivityProviderCodeName() { 213 XCN retVal = this.getTypedField(5, 0); 214 return retVal; 215 } 216 217 218 219 /** 220 * Returns 221 * TXA-6: "Origination Date/Time" - creates it if necessary 222 */ 223 public TS getOriginationDateTime() { 224 TS retVal = this.getTypedField(6, 0); 225 return retVal; 226 } 227 228 /** 229 * Returns 230 * TXA-6: "Origination Date/Time" - creates it if necessary 231 */ 232 public TS getTxa6_OriginationDateTime() { 233 TS retVal = this.getTypedField(6, 0); 234 return retVal; 235 } 236 237 238 239 /** 240 * Returns 241 * TXA-7: "Transcription Date/Time" - creates it if necessary 242 */ 243 public TS getTranscriptionDateTime() { 244 TS retVal = this.getTypedField(7, 0); 245 return retVal; 246 } 247 248 /** 249 * Returns 250 * TXA-7: "Transcription Date/Time" - creates it if necessary 251 */ 252 public TS getTxa7_TranscriptionDateTime() { 253 TS retVal = this.getTypedField(7, 0); 254 return retVal; 255 } 256 257 258 /** 259 * Returns all repetitions of Edit Date/Time (TXA-8). 260 */ 261 public TS[] getEditDateTime() { 262 TS[] retVal = this.getTypedField(8, new TS[0]); 263 return retVal; 264 } 265 266 267 /** 268 * Returns all repetitions of Edit Date/Time (TXA-8). 269 */ 270 public TS[] getTxa8_EditDateTime() { 271 TS[] retVal = this.getTypedField(8, new TS[0]); 272 return retVal; 273 } 274 275 276 /** 277 * Returns a count of the current number of repetitions of Edit Date/Time (TXA-8). 278 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 279 * it will return zero. 280 */ 281 public int getEditDateTimeReps() { 282 return this.getReps(8); 283 } 284 285 286 /** 287 * Returns a specific repetition of 288 * TXA-8: "Edit Date/Time" - creates it if necessary 289 * 290 * @param rep The repetition index (0-indexed) 291 */ 292 public TS getEditDateTime(int rep) { 293 TS retVal = this.getTypedField(8, rep); 294 return retVal; 295 } 296 297 /** 298 * Returns a specific repetition of 299 * TXA-8: "Edit Date/Time" - creates it if necessary 300 * 301 * @param rep The repetition index (0-indexed) 302 */ 303 public TS getTxa8_EditDateTime(int rep) { 304 TS retVal = this.getTypedField(8, rep); 305 return retVal; 306 } 307 308 /** 309 * Returns a count of the current number of repetitions of Edit Date/Time (TXA-8). 310 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 311 * it will return zero. 312 */ 313 public int getTxa8_EditDateTimeReps() { 314 return this.getReps(8); 315 } 316 317 318 /** 319 * Inserts a repetition of 320 * TXA-8: "Edit Date/Time" at a specific index 321 * 322 * @param rep The repetition index (0-indexed) 323 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 324 */ 325 public TS insertEditDateTime(int rep) throws HL7Exception { 326 return (TS) super.insertRepetition(8, rep); 327 } 328 329 330 /** 331 * Inserts a repetition of 332 * TXA-8: "Edit Date/Time" at a specific index 333 * 334 * @param rep The repetition index (0-indexed) 335 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 336 */ 337 public TS insertTxa8_EditDateTime(int rep) throws HL7Exception { 338 return (TS) super.insertRepetition(8, rep); 339 } 340 341 342 /** 343 * Removes a repetition of 344 * TXA-8: "Edit Date/Time" at a specific index 345 * 346 * @param rep The repetition index (0-indexed) 347 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 348 */ 349 public TS removeEditDateTime(int rep) throws HL7Exception { 350 return (TS) super.removeRepetition(8, rep); 351 } 352 353 354 /** 355 * Removes a repetition of 356 * TXA-8: "Edit Date/Time" at a specific index 357 * 358 * @param rep The repetition index (0-indexed) 359 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 360 */ 361 public TS removeTxa8_EditDateTime(int rep) throws HL7Exception { 362 return (TS) super.removeRepetition(8, rep); 363 } 364 365 366 367 368 /** 369 * Returns 370 * TXA-9: "Originator Code/Name" - creates it if necessary 371 */ 372 public XCN getOriginatorCodeName() { 373 XCN retVal = this.getTypedField(9, 0); 374 return retVal; 375 } 376 377 /** 378 * Returns 379 * TXA-9: "Originator Code/Name" - creates it if necessary 380 */ 381 public XCN getTxa9_OriginatorCodeName() { 382 XCN retVal = this.getTypedField(9, 0); 383 return retVal; 384 } 385 386 387 /** 388 * Returns all repetitions of Assigned Document Authenticator (TXA-10). 389 */ 390 public XCN[] getAssignedDocumentAuthenticator() { 391 XCN[] retVal = this.getTypedField(10, new XCN[0]); 392 return retVal; 393 } 394 395 396 /** 397 * Returns all repetitions of Assigned Document Authenticator (TXA-10). 398 */ 399 public XCN[] getTxa10_AssignedDocumentAuthenticator() { 400 XCN[] retVal = this.getTypedField(10, new XCN[0]); 401 return retVal; 402 } 403 404 405 /** 406 * Returns a count of the current number of repetitions of Assigned Document Authenticator (TXA-10). 407 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 408 * it will return zero. 409 */ 410 public int getAssignedDocumentAuthenticatorReps() { 411 return this.getReps(10); 412 } 413 414 415 /** 416 * Returns a specific repetition of 417 * TXA-10: "Assigned Document Authenticator" - creates it if necessary 418 * 419 * @param rep The repetition index (0-indexed) 420 */ 421 public XCN getAssignedDocumentAuthenticator(int rep) { 422 XCN retVal = this.getTypedField(10, rep); 423 return retVal; 424 } 425 426 /** 427 * Returns a specific repetition of 428 * TXA-10: "Assigned Document Authenticator" - creates it if necessary 429 * 430 * @param rep The repetition index (0-indexed) 431 */ 432 public XCN getTxa10_AssignedDocumentAuthenticator(int rep) { 433 XCN retVal = this.getTypedField(10, rep); 434 return retVal; 435 } 436 437 /** 438 * Returns a count of the current number of repetitions of Assigned Document Authenticator (TXA-10). 439 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 440 * it will return zero. 441 */ 442 public int getTxa10_AssignedDocumentAuthenticatorReps() { 443 return this.getReps(10); 444 } 445 446 447 /** 448 * Inserts a repetition of 449 * TXA-10: "Assigned Document Authenticator" at a specific index 450 * 451 * @param rep The repetition index (0-indexed) 452 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 453 */ 454 public XCN insertAssignedDocumentAuthenticator(int rep) throws HL7Exception { 455 return (XCN) super.insertRepetition(10, rep); 456 } 457 458 459 /** 460 * Inserts a repetition of 461 * TXA-10: "Assigned Document Authenticator" at a specific index 462 * 463 * @param rep The repetition index (0-indexed) 464 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 465 */ 466 public XCN insertTxa10_AssignedDocumentAuthenticator(int rep) throws HL7Exception { 467 return (XCN) super.insertRepetition(10, rep); 468 } 469 470 471 /** 472 * Removes a repetition of 473 * TXA-10: "Assigned Document Authenticator" at a specific index 474 * 475 * @param rep The repetition index (0-indexed) 476 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 477 */ 478 public XCN removeAssignedDocumentAuthenticator(int rep) throws HL7Exception { 479 return (XCN) super.removeRepetition(10, rep); 480 } 481 482 483 /** 484 * Removes a repetition of 485 * TXA-10: "Assigned Document Authenticator" at a specific index 486 * 487 * @param rep The repetition index (0-indexed) 488 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 489 */ 490 public XCN removeTxa10_AssignedDocumentAuthenticator(int rep) throws HL7Exception { 491 return (XCN) super.removeRepetition(10, rep); 492 } 493 494 495 496 497 /** 498 * Returns 499 * TXA-11: "Transcriptionist Code/Name" - creates it if necessary 500 */ 501 public XCN getTranscriptionistCodeName() { 502 XCN retVal = this.getTypedField(11, 0); 503 return retVal; 504 } 505 506 /** 507 * Returns 508 * TXA-11: "Transcriptionist Code/Name" - creates it if necessary 509 */ 510 public XCN getTxa11_TranscriptionistCodeName() { 511 XCN retVal = this.getTypedField(11, 0); 512 return retVal; 513 } 514 515 516 517 /** 518 * Returns 519 * TXA-12: "Unique Document Number" - creates it if necessary 520 */ 521 public EI getUniqueDocumentNumber() { 522 EI retVal = this.getTypedField(12, 0); 523 return retVal; 524 } 525 526 /** 527 * Returns 528 * TXA-12: "Unique Document Number" - creates it if necessary 529 */ 530 public EI getTxa12_UniqueDocumentNumber() { 531 EI retVal = this.getTypedField(12, 0); 532 return retVal; 533 } 534 535 536 537 /** 538 * Returns 539 * TXA-13: "Parent Document Number" - creates it if necessary 540 */ 541 public EI getParentDocumentNumber() { 542 EI retVal = this.getTypedField(13, 0); 543 return retVal; 544 } 545 546 /** 547 * Returns 548 * TXA-13: "Parent Document Number" - creates it if necessary 549 */ 550 public EI getTxa13_ParentDocumentNumber() { 551 EI retVal = this.getTypedField(13, 0); 552 return retVal; 553 } 554 555 556 /** 557 * Returns all repetitions of Placer Order Number (TXA-14). 558 */ 559 public EI[] getPlacerOrderNumber() { 560 EI[] retVal = this.getTypedField(14, new EI[0]); 561 return retVal; 562 } 563 564 565 /** 566 * Returns all repetitions of Placer Order Number (TXA-14). 567 */ 568 public EI[] getTxa14_PlacerOrderNumber() { 569 EI[] retVal = this.getTypedField(14, new EI[0]); 570 return retVal; 571 } 572 573 574 /** 575 * Returns a count of the current number of repetitions of Placer Order Number (TXA-14). 576 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 577 * it will return zero. 578 */ 579 public int getPlacerOrderNumberReps() { 580 return this.getReps(14); 581 } 582 583 584 /** 585 * Returns a specific repetition of 586 * TXA-14: "Placer Order Number" - creates it if necessary 587 * 588 * @param rep The repetition index (0-indexed) 589 */ 590 public EI getPlacerOrderNumber(int rep) { 591 EI retVal = this.getTypedField(14, rep); 592 return retVal; 593 } 594 595 /** 596 * Returns a specific repetition of 597 * TXA-14: "Placer Order Number" - creates it if necessary 598 * 599 * @param rep The repetition index (0-indexed) 600 */ 601 public EI getTxa14_PlacerOrderNumber(int rep) { 602 EI retVal = this.getTypedField(14, rep); 603 return retVal; 604 } 605 606 /** 607 * Returns a count of the current number of repetitions of Placer Order Number (TXA-14). 608 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 609 * it will return zero. 610 */ 611 public int getTxa14_PlacerOrderNumberReps() { 612 return this.getReps(14); 613 } 614 615 616 /** 617 * Inserts a repetition of 618 * TXA-14: "Placer Order Number" at a specific index 619 * 620 * @param rep The repetition index (0-indexed) 621 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 622 */ 623 public EI insertPlacerOrderNumber(int rep) throws HL7Exception { 624 return (EI) super.insertRepetition(14, rep); 625 } 626 627 628 /** 629 * Inserts a repetition of 630 * TXA-14: "Placer Order Number" at a specific index 631 * 632 * @param rep The repetition index (0-indexed) 633 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 634 */ 635 public EI insertTxa14_PlacerOrderNumber(int rep) throws HL7Exception { 636 return (EI) super.insertRepetition(14, rep); 637 } 638 639 640 /** 641 * Removes a repetition of 642 * TXA-14: "Placer Order Number" at a specific index 643 * 644 * @param rep The repetition index (0-indexed) 645 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 646 */ 647 public EI removePlacerOrderNumber(int rep) throws HL7Exception { 648 return (EI) super.removeRepetition(14, rep); 649 } 650 651 652 /** 653 * Removes a repetition of 654 * TXA-14: "Placer Order Number" at a specific index 655 * 656 * @param rep The repetition index (0-indexed) 657 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 658 */ 659 public EI removeTxa14_PlacerOrderNumber(int rep) throws HL7Exception { 660 return (EI) super.removeRepetition(14, rep); 661 } 662 663 664 665 666 /** 667 * Returns 668 * TXA-15: "Filler Order Number" - creates it if necessary 669 */ 670 public EI getFillerOrderNumber() { 671 EI retVal = this.getTypedField(15, 0); 672 return retVal; 673 } 674 675 /** 676 * Returns 677 * TXA-15: "Filler Order Number" - creates it if necessary 678 */ 679 public EI getTxa15_FillerOrderNumber() { 680 EI retVal = this.getTypedField(15, 0); 681 return retVal; 682 } 683 684 685 686 /** 687 * Returns 688 * TXA-16: "Unique Document File Name" - creates it if necessary 689 */ 690 public ST getUniqueDocumentFileName() { 691 ST retVal = this.getTypedField(16, 0); 692 return retVal; 693 } 694 695 /** 696 * Returns 697 * TXA-16: "Unique Document File Name" - creates it if necessary 698 */ 699 public ST getTxa16_UniqueDocumentFileName() { 700 ST retVal = this.getTypedField(16, 0); 701 return retVal; 702 } 703 704 705 /** 706 * Returns all repetitions of Document Completion Status (TXA-17). 707 */ 708 public ID[] getDocumentCompletionStatus() { 709 ID[] retVal = this.getTypedField(17, new ID[0]); 710 return retVal; 711 } 712 713 714 /** 715 * Returns all repetitions of Document Completion Status (TXA-17). 716 */ 717 public ID[] getTxa17_DocumentCompletionStatus() { 718 ID[] retVal = this.getTypedField(17, new ID[0]); 719 return retVal; 720 } 721 722 723 /** 724 * Returns a count of the current number of repetitions of Document Completion Status (TXA-17). 725 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 726 * it will return zero. 727 */ 728 public int getDocumentCompletionStatusReps() { 729 return this.getReps(17); 730 } 731 732 733 /** 734 * Returns a specific repetition of 735 * TXA-17: "Document Completion Status" - creates it if necessary 736 * 737 * @param rep The repetition index (0-indexed) 738 */ 739 public ID getDocumentCompletionStatus(int rep) { 740 ID retVal = this.getTypedField(17, rep); 741 return retVal; 742 } 743 744 /** 745 * Returns a specific repetition of 746 * TXA-17: "Document Completion Status" - creates it if necessary 747 * 748 * @param rep The repetition index (0-indexed) 749 */ 750 public ID getTxa17_DocumentCompletionStatus(int rep) { 751 ID retVal = this.getTypedField(17, rep); 752 return retVal; 753 } 754 755 /** 756 * Returns a count of the current number of repetitions of Document Completion Status (TXA-17). 757 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 758 * it will return zero. 759 */ 760 public int getTxa17_DocumentCompletionStatusReps() { 761 return this.getReps(17); 762 } 763 764 765 /** 766 * Inserts a repetition of 767 * TXA-17: "Document Completion Status" at a specific index 768 * 769 * @param rep The repetition index (0-indexed) 770 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 771 */ 772 public ID insertDocumentCompletionStatus(int rep) throws HL7Exception { 773 return (ID) super.insertRepetition(17, rep); 774 } 775 776 777 /** 778 * Inserts a repetition of 779 * TXA-17: "Document Completion Status" at a specific index 780 * 781 * @param rep The repetition index (0-indexed) 782 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 783 */ 784 public ID insertTxa17_DocumentCompletionStatus(int rep) throws HL7Exception { 785 return (ID) super.insertRepetition(17, rep); 786 } 787 788 789 /** 790 * Removes a repetition of 791 * TXA-17: "Document Completion Status" at a specific index 792 * 793 * @param rep The repetition index (0-indexed) 794 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 795 */ 796 public ID removeDocumentCompletionStatus(int rep) throws HL7Exception { 797 return (ID) super.removeRepetition(17, rep); 798 } 799 800 801 /** 802 * Removes a repetition of 803 * TXA-17: "Document Completion Status" at a specific index 804 * 805 * @param rep The repetition index (0-indexed) 806 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 807 */ 808 public ID removeTxa17_DocumentCompletionStatus(int rep) throws HL7Exception { 809 return (ID) super.removeRepetition(17, rep); 810 } 811 812 813 814 815 /** 816 * Returns 817 * TXA-18: "Document Confidentiality Status" - creates it if necessary 818 */ 819 public ID getDocumentConfidentialityStatus() { 820 ID retVal = this.getTypedField(18, 0); 821 return retVal; 822 } 823 824 /** 825 * Returns 826 * TXA-18: "Document Confidentiality Status" - creates it if necessary 827 */ 828 public ID getTxa18_DocumentConfidentialityStatus() { 829 ID retVal = this.getTypedField(18, 0); 830 return retVal; 831 } 832 833 834 835 /** 836 * Returns 837 * TXA-19: "Document Availability Status" - creates it if necessary 838 */ 839 public ID getDocumentAvailabilityStatus() { 840 ID retVal = this.getTypedField(19, 0); 841 return retVal; 842 } 843 844 /** 845 * Returns 846 * TXA-19: "Document Availability Status" - creates it if necessary 847 */ 848 public ID getTxa19_DocumentAvailabilityStatus() { 849 ID retVal = this.getTypedField(19, 0); 850 return retVal; 851 } 852 853 854 855 /** 856 * Returns 857 * TXA-20: "Document Storage Status" - creates it if necessary 858 */ 859 public ID getDocumentStorageStatus() { 860 ID retVal = this.getTypedField(20, 0); 861 return retVal; 862 } 863 864 /** 865 * Returns 866 * TXA-20: "Document Storage Status" - creates it if necessary 867 */ 868 public ID getTxa20_DocumentStorageStatus() { 869 ID retVal = this.getTypedField(20, 0); 870 return retVal; 871 } 872 873 874 875 /** 876 * Returns 877 * TXA-21: "Document Change Reason" - creates it if necessary 878 */ 879 public ST getDocumentChangeReason() { 880 ST retVal = this.getTypedField(21, 0); 881 return retVal; 882 } 883 884 /** 885 * Returns 886 * TXA-21: "Document Change Reason" - creates it if necessary 887 */ 888 public ST getTxa21_DocumentChangeReason() { 889 ST retVal = this.getTypedField(21, 0); 890 return retVal; 891 } 892 893 894 /** 895 * Returns all repetitions of Authentication Person, Time Stamp (TXA-22). 896 */ 897 public PPN[] getAuthenticationPersonTimeStamp() { 898 PPN[] retVal = this.getTypedField(22, new PPN[0]); 899 return retVal; 900 } 901 902 903 /** 904 * Returns all repetitions of Authentication Person, Time Stamp (TXA-22). 905 */ 906 public PPN[] getTxa22_AuthenticationPersonTimeStamp() { 907 PPN[] retVal = this.getTypedField(22, new PPN[0]); 908 return retVal; 909 } 910 911 912 /** 913 * Returns a count of the current number of repetitions of Authentication Person, Time Stamp (TXA-22). 914 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 915 * it will return zero. 916 */ 917 public int getAuthenticationPersonTimeStampReps() { 918 return this.getReps(22); 919 } 920 921 922 /** 923 * Returns a specific repetition of 924 * TXA-22: "Authentication Person, Time Stamp" - creates it if necessary 925 * 926 * @param rep The repetition index (0-indexed) 927 */ 928 public PPN getAuthenticationPersonTimeStamp(int rep) { 929 PPN retVal = this.getTypedField(22, rep); 930 return retVal; 931 } 932 933 /** 934 * Returns a specific repetition of 935 * TXA-22: "Authentication Person, Time Stamp" - creates it if necessary 936 * 937 * @param rep The repetition index (0-indexed) 938 */ 939 public PPN getTxa22_AuthenticationPersonTimeStamp(int rep) { 940 PPN retVal = this.getTypedField(22, rep); 941 return retVal; 942 } 943 944 /** 945 * Returns a count of the current number of repetitions of Authentication Person, Time Stamp (TXA-22). 946 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 947 * it will return zero. 948 */ 949 public int getTxa22_AuthenticationPersonTimeStampReps() { 950 return this.getReps(22); 951 } 952 953 954 /** 955 * Inserts a repetition of 956 * TXA-22: "Authentication Person, Time Stamp" at a specific index 957 * 958 * @param rep The repetition index (0-indexed) 959 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 960 */ 961 public PPN insertAuthenticationPersonTimeStamp(int rep) throws HL7Exception { 962 return (PPN) super.insertRepetition(22, rep); 963 } 964 965 966 /** 967 * Inserts a repetition of 968 * TXA-22: "Authentication Person, Time Stamp" at a specific index 969 * 970 * @param rep The repetition index (0-indexed) 971 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 972 */ 973 public PPN insertTxa22_AuthenticationPersonTimeStamp(int rep) throws HL7Exception { 974 return (PPN) super.insertRepetition(22, rep); 975 } 976 977 978 /** 979 * Removes a repetition of 980 * TXA-22: "Authentication Person, Time Stamp" at a specific index 981 * 982 * @param rep The repetition index (0-indexed) 983 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 984 */ 985 public PPN removeAuthenticationPersonTimeStamp(int rep) throws HL7Exception { 986 return (PPN) super.removeRepetition(22, rep); 987 } 988 989 990 /** 991 * Removes a repetition of 992 * TXA-22: "Authentication Person, Time Stamp" at a specific index 993 * 994 * @param rep The repetition index (0-indexed) 995 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 996 */ 997 public PPN removeTxa22_AuthenticationPersonTimeStamp(int rep) throws HL7Exception { 998 return (PPN) super.removeRepetition(22, rep); 999 } 1000 1001 1002 1003 /** 1004 * Returns all repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23). 1005 */ 1006 public XCN[] getDistributedCopiesCodeandNameofRecipients() { 1007 XCN[] retVal = this.getTypedField(23, new XCN[0]); 1008 return retVal; 1009 } 1010 1011 1012 /** 1013 * Returns all repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23). 1014 */ 1015 public XCN[] getTxa23_DistributedCopiesCodeandNameofRecipients() { 1016 XCN[] retVal = this.getTypedField(23, new XCN[0]); 1017 return retVal; 1018 } 1019 1020 1021 /** 1022 * Returns a count of the current number of repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23). 1023 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 1024 * it will return zero. 1025 */ 1026 public int getDistributedCopiesCodeandNameofRecipientsReps() { 1027 return this.getReps(23); 1028 } 1029 1030 1031 /** 1032 * Returns a specific repetition of 1033 * TXA-23: "Distributed Copies (Code and Name of Recipients)" - creates it if necessary 1034 * 1035 * @param rep The repetition index (0-indexed) 1036 */ 1037 public XCN getDistributedCopiesCodeandNameofRecipients(int rep) { 1038 XCN retVal = this.getTypedField(23, rep); 1039 return retVal; 1040 } 1041 1042 /** 1043 * Returns a specific repetition of 1044 * TXA-23: "Distributed Copies (Code and Name of Recipients)" - creates it if necessary 1045 * 1046 * @param rep The repetition index (0-indexed) 1047 */ 1048 public XCN getTxa23_DistributedCopiesCodeandNameofRecipients(int rep) { 1049 XCN retVal = this.getTypedField(23, rep); 1050 return retVal; 1051 } 1052 1053 /** 1054 * Returns a count of the current number of repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23). 1055 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 1056 * it will return zero. 1057 */ 1058 public int getTxa23_DistributedCopiesCodeandNameofRecipientsReps() { 1059 return this.getReps(23); 1060 } 1061 1062 1063 /** 1064 * Inserts a repetition of 1065 * TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index 1066 * 1067 * @param rep The repetition index (0-indexed) 1068 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1069 */ 1070 public XCN insertDistributedCopiesCodeandNameofRecipients(int rep) throws HL7Exception { 1071 return (XCN) super.insertRepetition(23, rep); 1072 } 1073 1074 1075 /** 1076 * Inserts a repetition of 1077 * TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index 1078 * 1079 * @param rep The repetition index (0-indexed) 1080 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1081 */ 1082 public XCN insertTxa23_DistributedCopiesCodeandNameofRecipients(int rep) throws HL7Exception { 1083 return (XCN) super.insertRepetition(23, rep); 1084 } 1085 1086 1087 /** 1088 * Removes a repetition of 1089 * TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index 1090 * 1091 * @param rep The repetition index (0-indexed) 1092 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1093 */ 1094 public XCN removeDistributedCopiesCodeandNameofRecipients(int rep) throws HL7Exception { 1095 return (XCN) super.removeRepetition(23, rep); 1096 } 1097 1098 1099 /** 1100 * Removes a repetition of 1101 * TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index 1102 * 1103 * @param rep The repetition index (0-indexed) 1104 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1105 */ 1106 public XCN removeTxa23_DistributedCopiesCodeandNameofRecipients(int rep) throws HL7Exception { 1107 return (XCN) super.removeRepetition(23, rep); 1108 } 1109 1110 1111 1112 1113 1114 1115 /** {@inheritDoc} */ 1116 protected Type createNewTypeWithoutReflection(int field) { 1117 switch (field) { 1118 case 0: return new SI(getMessage()); 1119 case 1: return new IS(getMessage(), new Integer( 270 )); 1120 case 2: return new ID(getMessage(), new Integer( 191 )); 1121 case 3: return new TS(getMessage()); 1122 case 4: return new XCN(getMessage()); 1123 case 5: return new TS(getMessage()); 1124 case 6: return new TS(getMessage()); 1125 case 7: return new TS(getMessage()); 1126 case 8: return new XCN(getMessage()); 1127 case 9: return new XCN(getMessage()); 1128 case 10: return new XCN(getMessage()); 1129 case 11: return new EI(getMessage()); 1130 case 12: return new EI(getMessage()); 1131 case 13: return new EI(getMessage()); 1132 case 14: return new EI(getMessage()); 1133 case 15: return new ST(getMessage()); 1134 case 16: return new ID(getMessage(), new Integer( 271 )); 1135 case 17: return new ID(getMessage(), new Integer( 272 )); 1136 case 18: return new ID(getMessage(), new Integer( 273 )); 1137 case 19: return new ID(getMessage(), new Integer( 275 )); 1138 case 20: return new ST(getMessage()); 1139 case 21: return new PPN(getMessage()); 1140 case 22: return new XCN(getMessage()); 1141 default: return null; 1142 } 1143 } 1144 1145 1146} 1147