001/* 002 * This class is an auto-generated source file for a HAPI 003 * HL7 v2.x standard structure class. 004 * 005 * For more information, visit: http://hl7api.sourceforge.net/ 006 * 007 * The contents of this file are subject to the Mozilla Public License Version 1.1 008 * (the "License"); you may not use this file except in compliance with the License. 009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 010 * Software distributed under the License is distributed on an "AS IS" basis, 011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 012 * specific language governing rights and limitations under the License. 013 * 014 * The Original Code is "[file_name]". Description: 015 * "[one_line_description]" 016 * 017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 018 * 2012. All Rights Reserved. 019 * 020 * Contributor(s): ______________________________________. 021 * 022 * Alternatively, the contents of this file may be used under the terms of the 023 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are 024 * applicable instead of those above. If you wish to allow use of your version of this 025 * file only under the terms of the GPL and not to allow others to use your version 026 * of this file under the MPL, indicate your decision by deleting the provisions above 027 * and replace them with the notice and other provisions required by the GPL License. 028 * If you do not delete the provisions above, a recipient may use your version of 029 * this file under either the MPL or the GPL. 030 * 031 */ 032 033 034package ca.uhn.hl7v2.model.v231.segment; 035 036// import ca.uhn.hl7v2.model.v231.group.*; 037import ca.uhn.hl7v2.model.v231.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 repeating</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 repeating</b> 061 * <li>TXA-10: Assigned Document Authenticator (XCN) <b>optional repeating</b> 062 * <li>TXA-11: Transcriptionist Code/Name (XCN) <b>optional repeating</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> </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, 0, 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, 0, 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, 0, 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, 1, 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 * Returns all repetitions of Primary Activity Provider Code/Name (TXA-5). 201 */ 202 public XCN[] getPrimaryActivityProviderCodeName() { 203 XCN[] retVal = this.getTypedField(5, new XCN[0]); 204 return retVal; 205 } 206 207 208 /** 209 * Returns all repetitions of Primary Activity Provider Code/Name (TXA-5). 210 */ 211 public XCN[] getTxa5_PrimaryActivityProviderCodeName() { 212 XCN[] retVal = this.getTypedField(5, new XCN[0]); 213 return retVal; 214 } 215 216 217 /** 218 * Returns a count of the current number of repetitions of Primary Activity Provider Code/Name (TXA-5). 219 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 220 * it will return zero. 221 */ 222 public int getPrimaryActivityProviderCodeNameReps() { 223 return this.getReps(5); 224 } 225 226 227 /** 228 * Returns a specific repetition of 229 * TXA-5: "Primary Activity Provider Code/Name" - creates it if necessary 230 * 231 * @param rep The repetition index (0-indexed) 232 */ 233 public XCN getPrimaryActivityProviderCodeName(int rep) { 234 XCN retVal = this.getTypedField(5, rep); 235 return retVal; 236 } 237 238 /** 239 * Returns a specific repetition of 240 * TXA-5: "Primary Activity Provider Code/Name" - creates it if necessary 241 * 242 * @param rep The repetition index (0-indexed) 243 */ 244 public XCN getTxa5_PrimaryActivityProviderCodeName(int rep) { 245 XCN retVal = this.getTypedField(5, rep); 246 return retVal; 247 } 248 249 /** 250 * Returns a count of the current number of repetitions of Primary Activity Provider Code/Name (TXA-5). 251 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 252 * it will return zero. 253 */ 254 public int getTxa5_PrimaryActivityProviderCodeNameReps() { 255 return this.getReps(5); 256 } 257 258 259 /** 260 * Inserts a repetition of 261 * TXA-5: "Primary Activity Provider Code/Name" at a specific index 262 * 263 * @param rep The repetition index (0-indexed) 264 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 265 */ 266 public XCN insertPrimaryActivityProviderCodeName(int rep) throws HL7Exception { 267 return (XCN) super.insertRepetition(5, rep); 268 } 269 270 271 /** 272 * Inserts a repetition of 273 * TXA-5: "Primary Activity Provider Code/Name" at a specific index 274 * 275 * @param rep The repetition index (0-indexed) 276 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 277 */ 278 public XCN insertTxa5_PrimaryActivityProviderCodeName(int rep) throws HL7Exception { 279 return (XCN) super.insertRepetition(5, rep); 280 } 281 282 283 /** 284 * Removes a repetition of 285 * TXA-5: "Primary Activity Provider Code/Name" at a specific index 286 * 287 * @param rep The repetition index (0-indexed) 288 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 289 */ 290 public XCN removePrimaryActivityProviderCodeName(int rep) throws HL7Exception { 291 return (XCN) super.removeRepetition(5, rep); 292 } 293 294 295 /** 296 * Removes a repetition of 297 * TXA-5: "Primary Activity Provider Code/Name" at a specific index 298 * 299 * @param rep The repetition index (0-indexed) 300 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 301 */ 302 public XCN removeTxa5_PrimaryActivityProviderCodeName(int rep) throws HL7Exception { 303 return (XCN) super.removeRepetition(5, rep); 304 } 305 306 307 308 309 /** 310 * Returns 311 * TXA-6: "Origination Date/Time" - creates it if necessary 312 */ 313 public TS getOriginationDateTime() { 314 TS retVal = this.getTypedField(6, 0); 315 return retVal; 316 } 317 318 /** 319 * Returns 320 * TXA-6: "Origination Date/Time" - creates it if necessary 321 */ 322 public TS getTxa6_OriginationDateTime() { 323 TS retVal = this.getTypedField(6, 0); 324 return retVal; 325 } 326 327 328 329 /** 330 * Returns 331 * TXA-7: "Transcription Date/Time" - creates it if necessary 332 */ 333 public TS getTranscriptionDateTime() { 334 TS retVal = this.getTypedField(7, 0); 335 return retVal; 336 } 337 338 /** 339 * Returns 340 * TXA-7: "Transcription Date/Time" - creates it if necessary 341 */ 342 public TS getTxa7_TranscriptionDateTime() { 343 TS retVal = this.getTypedField(7, 0); 344 return retVal; 345 } 346 347 348 /** 349 * Returns all repetitions of Edit Date/Time (TXA-8). 350 */ 351 public TS[] getEditDateTime() { 352 TS[] retVal = this.getTypedField(8, new TS[0]); 353 return retVal; 354 } 355 356 357 /** 358 * Returns all repetitions of Edit Date/Time (TXA-8). 359 */ 360 public TS[] getTxa8_EditDateTime() { 361 TS[] retVal = this.getTypedField(8, new TS[0]); 362 return retVal; 363 } 364 365 366 /** 367 * Returns a count of the current number of repetitions of Edit Date/Time (TXA-8). 368 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 369 * it will return zero. 370 */ 371 public int getEditDateTimeReps() { 372 return this.getReps(8); 373 } 374 375 376 /** 377 * Returns a specific repetition of 378 * TXA-8: "Edit Date/Time" - creates it if necessary 379 * 380 * @param rep The repetition index (0-indexed) 381 */ 382 public TS getEditDateTime(int rep) { 383 TS retVal = this.getTypedField(8, rep); 384 return retVal; 385 } 386 387 /** 388 * Returns a specific repetition of 389 * TXA-8: "Edit Date/Time" - creates it if necessary 390 * 391 * @param rep The repetition index (0-indexed) 392 */ 393 public TS getTxa8_EditDateTime(int rep) { 394 TS retVal = this.getTypedField(8, rep); 395 return retVal; 396 } 397 398 /** 399 * Returns a count of the current number of repetitions of Edit Date/Time (TXA-8). 400 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 401 * it will return zero. 402 */ 403 public int getTxa8_EditDateTimeReps() { 404 return this.getReps(8); 405 } 406 407 408 /** 409 * Inserts a repetition of 410 * TXA-8: "Edit Date/Time" at a specific index 411 * 412 * @param rep The repetition index (0-indexed) 413 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 414 */ 415 public TS insertEditDateTime(int rep) throws HL7Exception { 416 return (TS) super.insertRepetition(8, rep); 417 } 418 419 420 /** 421 * Inserts a repetition of 422 * TXA-8: "Edit Date/Time" at a specific index 423 * 424 * @param rep The repetition index (0-indexed) 425 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 426 */ 427 public TS insertTxa8_EditDateTime(int rep) throws HL7Exception { 428 return (TS) super.insertRepetition(8, rep); 429 } 430 431 432 /** 433 * Removes a repetition of 434 * TXA-8: "Edit Date/Time" at a specific index 435 * 436 * @param rep The repetition index (0-indexed) 437 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 438 */ 439 public TS removeEditDateTime(int rep) throws HL7Exception { 440 return (TS) super.removeRepetition(8, rep); 441 } 442 443 444 /** 445 * Removes a repetition of 446 * TXA-8: "Edit Date/Time" at a specific index 447 * 448 * @param rep The repetition index (0-indexed) 449 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 450 */ 451 public TS removeTxa8_EditDateTime(int rep) throws HL7Exception { 452 return (TS) super.removeRepetition(8, rep); 453 } 454 455 456 457 /** 458 * Returns all repetitions of Originator Code/Name (TXA-9). 459 */ 460 public XCN[] getOriginatorCodeName() { 461 XCN[] retVal = this.getTypedField(9, new XCN[0]); 462 return retVal; 463 } 464 465 466 /** 467 * Returns all repetitions of Originator Code/Name (TXA-9). 468 */ 469 public XCN[] getTxa9_OriginatorCodeName() { 470 XCN[] retVal = this.getTypedField(9, new XCN[0]); 471 return retVal; 472 } 473 474 475 /** 476 * Returns a count of the current number of repetitions of Originator Code/Name (TXA-9). 477 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 478 * it will return zero. 479 */ 480 public int getOriginatorCodeNameReps() { 481 return this.getReps(9); 482 } 483 484 485 /** 486 * Returns a specific repetition of 487 * TXA-9: "Originator Code/Name" - creates it if necessary 488 * 489 * @param rep The repetition index (0-indexed) 490 */ 491 public XCN getOriginatorCodeName(int rep) { 492 XCN retVal = this.getTypedField(9, rep); 493 return retVal; 494 } 495 496 /** 497 * Returns a specific repetition of 498 * TXA-9: "Originator Code/Name" - creates it if necessary 499 * 500 * @param rep The repetition index (0-indexed) 501 */ 502 public XCN getTxa9_OriginatorCodeName(int rep) { 503 XCN retVal = this.getTypedField(9, rep); 504 return retVal; 505 } 506 507 /** 508 * Returns a count of the current number of repetitions of Originator Code/Name (TXA-9). 509 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 510 * it will return zero. 511 */ 512 public int getTxa9_OriginatorCodeNameReps() { 513 return this.getReps(9); 514 } 515 516 517 /** 518 * Inserts a repetition of 519 * TXA-9: "Originator Code/Name" at a specific index 520 * 521 * @param rep The repetition index (0-indexed) 522 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 523 */ 524 public XCN insertOriginatorCodeName(int rep) throws HL7Exception { 525 return (XCN) super.insertRepetition(9, rep); 526 } 527 528 529 /** 530 * Inserts a repetition of 531 * TXA-9: "Originator Code/Name" at a specific index 532 * 533 * @param rep The repetition index (0-indexed) 534 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 535 */ 536 public XCN insertTxa9_OriginatorCodeName(int rep) throws HL7Exception { 537 return (XCN) super.insertRepetition(9, rep); 538 } 539 540 541 /** 542 * Removes a repetition of 543 * TXA-9: "Originator Code/Name" at a specific index 544 * 545 * @param rep The repetition index (0-indexed) 546 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 547 */ 548 public XCN removeOriginatorCodeName(int rep) throws HL7Exception { 549 return (XCN) super.removeRepetition(9, rep); 550 } 551 552 553 /** 554 * Removes a repetition of 555 * TXA-9: "Originator Code/Name" at a specific index 556 * 557 * @param rep The repetition index (0-indexed) 558 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 559 */ 560 public XCN removeTxa9_OriginatorCodeName(int rep) throws HL7Exception { 561 return (XCN) super.removeRepetition(9, rep); 562 } 563 564 565 566 /** 567 * Returns all repetitions of Assigned Document Authenticator (TXA-10). 568 */ 569 public XCN[] getAssignedDocumentAuthenticator() { 570 XCN[] retVal = this.getTypedField(10, new XCN[0]); 571 return retVal; 572 } 573 574 575 /** 576 * Returns all repetitions of Assigned Document Authenticator (TXA-10). 577 */ 578 public XCN[] getTxa10_AssignedDocumentAuthenticator() { 579 XCN[] retVal = this.getTypedField(10, new XCN[0]); 580 return retVal; 581 } 582 583 584 /** 585 * Returns a count of the current number of repetitions of Assigned Document Authenticator (TXA-10). 586 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 587 * it will return zero. 588 */ 589 public int getAssignedDocumentAuthenticatorReps() { 590 return this.getReps(10); 591 } 592 593 594 /** 595 * Returns a specific repetition of 596 * TXA-10: "Assigned Document Authenticator" - creates it if necessary 597 * 598 * @param rep The repetition index (0-indexed) 599 */ 600 public XCN getAssignedDocumentAuthenticator(int rep) { 601 XCN retVal = this.getTypedField(10, rep); 602 return retVal; 603 } 604 605 /** 606 * Returns a specific repetition of 607 * TXA-10: "Assigned Document Authenticator" - creates it if necessary 608 * 609 * @param rep The repetition index (0-indexed) 610 */ 611 public XCN getTxa10_AssignedDocumentAuthenticator(int rep) { 612 XCN retVal = this.getTypedField(10, rep); 613 return retVal; 614 } 615 616 /** 617 * Returns a count of the current number of repetitions of Assigned Document Authenticator (TXA-10). 618 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 619 * it will return zero. 620 */ 621 public int getTxa10_AssignedDocumentAuthenticatorReps() { 622 return this.getReps(10); 623 } 624 625 626 /** 627 * Inserts a repetition of 628 * TXA-10: "Assigned Document Authenticator" at a specific index 629 * 630 * @param rep The repetition index (0-indexed) 631 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 632 */ 633 public XCN insertAssignedDocumentAuthenticator(int rep) throws HL7Exception { 634 return (XCN) super.insertRepetition(10, rep); 635 } 636 637 638 /** 639 * Inserts a repetition of 640 * TXA-10: "Assigned Document Authenticator" at a specific index 641 * 642 * @param rep The repetition index (0-indexed) 643 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 644 */ 645 public XCN insertTxa10_AssignedDocumentAuthenticator(int rep) throws HL7Exception { 646 return (XCN) super.insertRepetition(10, rep); 647 } 648 649 650 /** 651 * Removes a repetition of 652 * TXA-10: "Assigned Document Authenticator" at a specific index 653 * 654 * @param rep The repetition index (0-indexed) 655 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 656 */ 657 public XCN removeAssignedDocumentAuthenticator(int rep) throws HL7Exception { 658 return (XCN) super.removeRepetition(10, rep); 659 } 660 661 662 /** 663 * Removes a repetition of 664 * TXA-10: "Assigned Document Authenticator" at a specific index 665 * 666 * @param rep The repetition index (0-indexed) 667 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 668 */ 669 public XCN removeTxa10_AssignedDocumentAuthenticator(int rep) throws HL7Exception { 670 return (XCN) super.removeRepetition(10, rep); 671 } 672 673 674 675 /** 676 * Returns all repetitions of Transcriptionist Code/Name (TXA-11). 677 */ 678 public XCN[] getTranscriptionistCodeName() { 679 XCN[] retVal = this.getTypedField(11, new XCN[0]); 680 return retVal; 681 } 682 683 684 /** 685 * Returns all repetitions of Transcriptionist Code/Name (TXA-11). 686 */ 687 public XCN[] getTxa11_TranscriptionistCodeName() { 688 XCN[] retVal = this.getTypedField(11, new XCN[0]); 689 return retVal; 690 } 691 692 693 /** 694 * Returns a count of the current number of repetitions of Transcriptionist Code/Name (TXA-11). 695 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 696 * it will return zero. 697 */ 698 public int getTranscriptionistCodeNameReps() { 699 return this.getReps(11); 700 } 701 702 703 /** 704 * Returns a specific repetition of 705 * TXA-11: "Transcriptionist Code/Name" - creates it if necessary 706 * 707 * @param rep The repetition index (0-indexed) 708 */ 709 public XCN getTranscriptionistCodeName(int rep) { 710 XCN retVal = this.getTypedField(11, rep); 711 return retVal; 712 } 713 714 /** 715 * Returns a specific repetition of 716 * TXA-11: "Transcriptionist Code/Name" - creates it if necessary 717 * 718 * @param rep The repetition index (0-indexed) 719 */ 720 public XCN getTxa11_TranscriptionistCodeName(int rep) { 721 XCN retVal = this.getTypedField(11, rep); 722 return retVal; 723 } 724 725 /** 726 * Returns a count of the current number of repetitions of Transcriptionist Code/Name (TXA-11). 727 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 728 * it will return zero. 729 */ 730 public int getTxa11_TranscriptionistCodeNameReps() { 731 return this.getReps(11); 732 } 733 734 735 /** 736 * Inserts a repetition of 737 * TXA-11: "Transcriptionist Code/Name" at a specific index 738 * 739 * @param rep The repetition index (0-indexed) 740 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 741 */ 742 public XCN insertTranscriptionistCodeName(int rep) throws HL7Exception { 743 return (XCN) super.insertRepetition(11, rep); 744 } 745 746 747 /** 748 * Inserts a repetition of 749 * TXA-11: "Transcriptionist Code/Name" at a specific index 750 * 751 * @param rep The repetition index (0-indexed) 752 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 753 */ 754 public XCN insertTxa11_TranscriptionistCodeName(int rep) throws HL7Exception { 755 return (XCN) super.insertRepetition(11, rep); 756 } 757 758 759 /** 760 * Removes a repetition of 761 * TXA-11: "Transcriptionist Code/Name" at a specific index 762 * 763 * @param rep The repetition index (0-indexed) 764 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 765 */ 766 public XCN removeTranscriptionistCodeName(int rep) throws HL7Exception { 767 return (XCN) super.removeRepetition(11, rep); 768 } 769 770 771 /** 772 * Removes a repetition of 773 * TXA-11: "Transcriptionist Code/Name" at a specific index 774 * 775 * @param rep The repetition index (0-indexed) 776 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 777 */ 778 public XCN removeTxa11_TranscriptionistCodeName(int rep) throws HL7Exception { 779 return (XCN) super.removeRepetition(11, rep); 780 } 781 782 783 784 785 /** 786 * Returns 787 * TXA-12: "Unique Document Number" - creates it if necessary 788 */ 789 public EI getUniqueDocumentNumber() { 790 EI retVal = this.getTypedField(12, 0); 791 return retVal; 792 } 793 794 /** 795 * Returns 796 * TXA-12: "Unique Document Number" - creates it if necessary 797 */ 798 public EI getTxa12_UniqueDocumentNumber() { 799 EI retVal = this.getTypedField(12, 0); 800 return retVal; 801 } 802 803 804 805 /** 806 * Returns 807 * TXA-13: "Parent Document Number" - creates it if necessary 808 */ 809 public EI getParentDocumentNumber() { 810 EI retVal = this.getTypedField(13, 0); 811 return retVal; 812 } 813 814 /** 815 * Returns 816 * TXA-13: "Parent Document Number" - creates it if necessary 817 */ 818 public EI getTxa13_ParentDocumentNumber() { 819 EI retVal = this.getTypedField(13, 0); 820 return retVal; 821 } 822 823 824 /** 825 * Returns all repetitions of Placer Order Number (TXA-14). 826 */ 827 public EI[] getPlacerOrderNumber() { 828 EI[] retVal = this.getTypedField(14, new EI[0]); 829 return retVal; 830 } 831 832 833 /** 834 * Returns all repetitions of Placer Order Number (TXA-14). 835 */ 836 public EI[] getTxa14_PlacerOrderNumber() { 837 EI[] retVal = this.getTypedField(14, new EI[0]); 838 return retVal; 839 } 840 841 842 /** 843 * Returns a count of the current number of repetitions of Placer Order Number (TXA-14). 844 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 845 * it will return zero. 846 */ 847 public int getPlacerOrderNumberReps() { 848 return this.getReps(14); 849 } 850 851 852 /** 853 * Returns a specific repetition of 854 * TXA-14: "Placer Order Number" - creates it if necessary 855 * 856 * @param rep The repetition index (0-indexed) 857 */ 858 public EI getPlacerOrderNumber(int rep) { 859 EI retVal = this.getTypedField(14, rep); 860 return retVal; 861 } 862 863 /** 864 * Returns a specific repetition of 865 * TXA-14: "Placer Order Number" - creates it if necessary 866 * 867 * @param rep The repetition index (0-indexed) 868 */ 869 public EI getTxa14_PlacerOrderNumber(int rep) { 870 EI retVal = this.getTypedField(14, rep); 871 return retVal; 872 } 873 874 /** 875 * Returns a count of the current number of repetitions of Placer Order Number (TXA-14). 876 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 877 * it will return zero. 878 */ 879 public int getTxa14_PlacerOrderNumberReps() { 880 return this.getReps(14); 881 } 882 883 884 /** 885 * Inserts a repetition of 886 * TXA-14: "Placer Order Number" at a specific index 887 * 888 * @param rep The repetition index (0-indexed) 889 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 890 */ 891 public EI insertPlacerOrderNumber(int rep) throws HL7Exception { 892 return (EI) super.insertRepetition(14, rep); 893 } 894 895 896 /** 897 * Inserts a repetition of 898 * TXA-14: "Placer Order Number" at a specific index 899 * 900 * @param rep The repetition index (0-indexed) 901 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 902 */ 903 public EI insertTxa14_PlacerOrderNumber(int rep) throws HL7Exception { 904 return (EI) super.insertRepetition(14, rep); 905 } 906 907 908 /** 909 * Removes a repetition of 910 * TXA-14: "Placer Order Number" at a specific index 911 * 912 * @param rep The repetition index (0-indexed) 913 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 914 */ 915 public EI removePlacerOrderNumber(int rep) throws HL7Exception { 916 return (EI) super.removeRepetition(14, rep); 917 } 918 919 920 /** 921 * Removes a repetition of 922 * TXA-14: "Placer Order Number" at a specific index 923 * 924 * @param rep The repetition index (0-indexed) 925 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 926 */ 927 public EI removeTxa14_PlacerOrderNumber(int rep) throws HL7Exception { 928 return (EI) super.removeRepetition(14, rep); 929 } 930 931 932 933 934 /** 935 * Returns 936 * TXA-15: "Filler Order Number" - creates it if necessary 937 */ 938 public EI getFillerOrderNumber() { 939 EI retVal = this.getTypedField(15, 0); 940 return retVal; 941 } 942 943 /** 944 * Returns 945 * TXA-15: "Filler Order Number" - creates it if necessary 946 */ 947 public EI getTxa15_FillerOrderNumber() { 948 EI retVal = this.getTypedField(15, 0); 949 return retVal; 950 } 951 952 953 954 /** 955 * Returns 956 * TXA-16: "Unique Document File Name" - creates it if necessary 957 */ 958 public ST getUniqueDocumentFileName() { 959 ST retVal = this.getTypedField(16, 0); 960 return retVal; 961 } 962 963 /** 964 * Returns 965 * TXA-16: "Unique Document File Name" - creates it if necessary 966 */ 967 public ST getTxa16_UniqueDocumentFileName() { 968 ST retVal = this.getTypedField(16, 0); 969 return retVal; 970 } 971 972 973 974 /** 975 * Returns 976 * TXA-17: "Document Completion Status" - creates it if necessary 977 */ 978 public ID getDocumentCompletionStatus() { 979 ID retVal = this.getTypedField(17, 0); 980 return retVal; 981 } 982 983 /** 984 * Returns 985 * TXA-17: "Document Completion Status" - creates it if necessary 986 */ 987 public ID getTxa17_DocumentCompletionStatus() { 988 ID retVal = this.getTypedField(17, 0); 989 return retVal; 990 } 991 992 993 994 /** 995 * Returns 996 * TXA-18: "Document Confidentiality Status" - creates it if necessary 997 */ 998 public ID getDocumentConfidentialityStatus() { 999 ID retVal = this.getTypedField(18, 0); 1000 return retVal; 1001 } 1002 1003 /** 1004 * Returns 1005 * TXA-18: "Document Confidentiality Status" - creates it if necessary 1006 */ 1007 public ID getTxa18_DocumentConfidentialityStatus() { 1008 ID retVal = this.getTypedField(18, 0); 1009 return retVal; 1010 } 1011 1012 1013 1014 /** 1015 * Returns 1016 * TXA-19: "Document Availability Status" - creates it if necessary 1017 */ 1018 public ID getDocumentAvailabilityStatus() { 1019 ID retVal = this.getTypedField(19, 0); 1020 return retVal; 1021 } 1022 1023 /** 1024 * Returns 1025 * TXA-19: "Document Availability Status" - creates it if necessary 1026 */ 1027 public ID getTxa19_DocumentAvailabilityStatus() { 1028 ID retVal = this.getTypedField(19, 0); 1029 return retVal; 1030 } 1031 1032 1033 1034 /** 1035 * Returns 1036 * TXA-20: "Document Storage Status" - creates it if necessary 1037 */ 1038 public ID getDocumentStorageStatus() { 1039 ID retVal = this.getTypedField(20, 0); 1040 return retVal; 1041 } 1042 1043 /** 1044 * Returns 1045 * TXA-20: "Document Storage Status" - creates it if necessary 1046 */ 1047 public ID getTxa20_DocumentStorageStatus() { 1048 ID retVal = this.getTypedField(20, 0); 1049 return retVal; 1050 } 1051 1052 1053 1054 /** 1055 * Returns 1056 * TXA-21: "Document Change Reason" - creates it if necessary 1057 */ 1058 public ST getDocumentChangeReason() { 1059 ST retVal = this.getTypedField(21, 0); 1060 return retVal; 1061 } 1062 1063 /** 1064 * Returns 1065 * TXA-21: "Document Change Reason" - creates it if necessary 1066 */ 1067 public ST getTxa21_DocumentChangeReason() { 1068 ST retVal = this.getTypedField(21, 0); 1069 return retVal; 1070 } 1071 1072 1073 /** 1074 * Returns all repetitions of Authentication Person, Time Stamp (TXA-22). 1075 */ 1076 public PPN[] getAuthenticationPersonTimeStamp() { 1077 PPN[] retVal = this.getTypedField(22, new PPN[0]); 1078 return retVal; 1079 } 1080 1081 1082 /** 1083 * Returns all repetitions of Authentication Person, Time Stamp (TXA-22). 1084 */ 1085 public PPN[] getTxa22_AuthenticationPersonTimeStamp() { 1086 PPN[] retVal = this.getTypedField(22, new PPN[0]); 1087 return retVal; 1088 } 1089 1090 1091 /** 1092 * Returns a count of the current number of repetitions of Authentication Person, Time Stamp (TXA-22). 1093 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 1094 * it will return zero. 1095 */ 1096 public int getAuthenticationPersonTimeStampReps() { 1097 return this.getReps(22); 1098 } 1099 1100 1101 /** 1102 * Returns a specific repetition of 1103 * TXA-22: "Authentication Person, Time Stamp" - creates it if necessary 1104 * 1105 * @param rep The repetition index (0-indexed) 1106 */ 1107 public PPN getAuthenticationPersonTimeStamp(int rep) { 1108 PPN retVal = this.getTypedField(22, rep); 1109 return retVal; 1110 } 1111 1112 /** 1113 * Returns a specific repetition of 1114 * TXA-22: "Authentication Person, Time Stamp" - creates it if necessary 1115 * 1116 * @param rep The repetition index (0-indexed) 1117 */ 1118 public PPN getTxa22_AuthenticationPersonTimeStamp(int rep) { 1119 PPN retVal = this.getTypedField(22, rep); 1120 return retVal; 1121 } 1122 1123 /** 1124 * Returns a count of the current number of repetitions of Authentication Person, Time Stamp (TXA-22). 1125 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 1126 * it will return zero. 1127 */ 1128 public int getTxa22_AuthenticationPersonTimeStampReps() { 1129 return this.getReps(22); 1130 } 1131 1132 1133 /** 1134 * Inserts a repetition of 1135 * TXA-22: "Authentication Person, Time Stamp" at a specific index 1136 * 1137 * @param rep The repetition index (0-indexed) 1138 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1139 */ 1140 public PPN insertAuthenticationPersonTimeStamp(int rep) throws HL7Exception { 1141 return (PPN) super.insertRepetition(22, rep); 1142 } 1143 1144 1145 /** 1146 * Inserts a repetition of 1147 * TXA-22: "Authentication Person, Time Stamp" at a specific index 1148 * 1149 * @param rep The repetition index (0-indexed) 1150 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1151 */ 1152 public PPN insertTxa22_AuthenticationPersonTimeStamp(int rep) throws HL7Exception { 1153 return (PPN) super.insertRepetition(22, rep); 1154 } 1155 1156 1157 /** 1158 * Removes a repetition of 1159 * TXA-22: "Authentication Person, Time Stamp" at a specific index 1160 * 1161 * @param rep The repetition index (0-indexed) 1162 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1163 */ 1164 public PPN removeAuthenticationPersonTimeStamp(int rep) throws HL7Exception { 1165 return (PPN) super.removeRepetition(22, rep); 1166 } 1167 1168 1169 /** 1170 * Removes a repetition of 1171 * TXA-22: "Authentication Person, Time Stamp" at a specific index 1172 * 1173 * @param rep The repetition index (0-indexed) 1174 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1175 */ 1176 public PPN removeTxa22_AuthenticationPersonTimeStamp(int rep) throws HL7Exception { 1177 return (PPN) super.removeRepetition(22, rep); 1178 } 1179 1180 1181 1182 /** 1183 * Returns all repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23). 1184 */ 1185 public XCN[] getDistributedCopiesCodeandNameofRecipients() { 1186 XCN[] retVal = this.getTypedField(23, new XCN[0]); 1187 return retVal; 1188 } 1189 1190 1191 /** 1192 * Returns all repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23). 1193 */ 1194 public XCN[] getTxa23_DistributedCopiesCodeandNameofRecipients() { 1195 XCN[] retVal = this.getTypedField(23, new XCN[0]); 1196 return retVal; 1197 } 1198 1199 1200 /** 1201 * Returns a count of the current number of repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23). 1202 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 1203 * it will return zero. 1204 */ 1205 public int getDistributedCopiesCodeandNameofRecipientsReps() { 1206 return this.getReps(23); 1207 } 1208 1209 1210 /** 1211 * Returns a specific repetition of 1212 * TXA-23: "Distributed Copies (Code and Name of Recipients)" - creates it if necessary 1213 * 1214 * @param rep The repetition index (0-indexed) 1215 */ 1216 public XCN getDistributedCopiesCodeandNameofRecipients(int rep) { 1217 XCN retVal = this.getTypedField(23, rep); 1218 return retVal; 1219 } 1220 1221 /** 1222 * Returns a specific repetition of 1223 * TXA-23: "Distributed Copies (Code and Name of Recipients)" - creates it if necessary 1224 * 1225 * @param rep The repetition index (0-indexed) 1226 */ 1227 public XCN getTxa23_DistributedCopiesCodeandNameofRecipients(int rep) { 1228 XCN retVal = this.getTypedField(23, rep); 1229 return retVal; 1230 } 1231 1232 /** 1233 * Returns a count of the current number of repetitions of Distributed Copies (Code and Name of Recipients) (TXA-23). 1234 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 1235 * it will return zero. 1236 */ 1237 public int getTxa23_DistributedCopiesCodeandNameofRecipientsReps() { 1238 return this.getReps(23); 1239 } 1240 1241 1242 /** 1243 * Inserts a repetition of 1244 * TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index 1245 * 1246 * @param rep The repetition index (0-indexed) 1247 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1248 */ 1249 public XCN insertDistributedCopiesCodeandNameofRecipients(int rep) throws HL7Exception { 1250 return (XCN) super.insertRepetition(23, rep); 1251 } 1252 1253 1254 /** 1255 * Inserts a repetition of 1256 * TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index 1257 * 1258 * @param rep The repetition index (0-indexed) 1259 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1260 */ 1261 public XCN insertTxa23_DistributedCopiesCodeandNameofRecipients(int rep) throws HL7Exception { 1262 return (XCN) super.insertRepetition(23, rep); 1263 } 1264 1265 1266 /** 1267 * Removes a repetition of 1268 * TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index 1269 * 1270 * @param rep The repetition index (0-indexed) 1271 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1272 */ 1273 public XCN removeDistributedCopiesCodeandNameofRecipients(int rep) throws HL7Exception { 1274 return (XCN) super.removeRepetition(23, rep); 1275 } 1276 1277 1278 /** 1279 * Removes a repetition of 1280 * TXA-23: "Distributed Copies (Code and Name of Recipients)" at a specific index 1281 * 1282 * @param rep The repetition index (0-indexed) 1283 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 1284 */ 1285 public XCN removeTxa23_DistributedCopiesCodeandNameofRecipients(int rep) throws HL7Exception { 1286 return (XCN) super.removeRepetition(23, rep); 1287 } 1288 1289 1290 1291 1292 1293 1294 /** {@inheritDoc} */ 1295 protected Type createNewTypeWithoutReflection(int field) { 1296 switch (field) { 1297 case 0: return new SI(getMessage()); 1298 case 1: return new IS(getMessage(), new Integer( 270 )); 1299 case 2: return new ID(getMessage(), new Integer( 191 )); 1300 case 3: return new TS(getMessage()); 1301 case 4: return new XCN(getMessage()); 1302 case 5: return new TS(getMessage()); 1303 case 6: return new TS(getMessage()); 1304 case 7: return new TS(getMessage()); 1305 case 8: return new XCN(getMessage()); 1306 case 9: return new XCN(getMessage()); 1307 case 10: return new XCN(getMessage()); 1308 case 11: return new EI(getMessage()); 1309 case 12: return new EI(getMessage()); 1310 case 13: return new EI(getMessage()); 1311 case 14: return new EI(getMessage()); 1312 case 15: return new ST(getMessage()); 1313 case 16: return new ID(getMessage(), new Integer( 271 )); 1314 case 17: return new ID(getMessage(), new Integer( 272 )); 1315 case 18: return new ID(getMessage(), new Integer( 273 )); 1316 case 19: return new ID(getMessage(), new Integer( 275 )); 1317 case 20: return new ST(getMessage()); 1318 case 21: return new PPN(getMessage()); 1319 case 22: return new XCN(getMessage()); 1320 default: return null; 1321 } 1322 } 1323 1324 1325} 1326