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