1 /* 2 * This class is an auto-generated source file for a HAPI 3 * HL7 v2.x standard structure class. 4 * 5 * For more information, visit: http://hl7api.sourceforge.net/ 6 * 7 * The contents of this file are subject to the Mozilla Public License Version 1.1 8 * (the "License"); you may not use this file except in compliance with the License. 9 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 10 * Software distributed under the License is distributed on an "AS IS" basis, 11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 12 * specific language governing rights and limitations under the License. 13 * 14 * The Original Code is "[file_name]". Description: 15 * "[one_line_description]" 16 * 17 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 18 * 2012. All Rights Reserved. 19 * 20 * Contributor(s): ______________________________________. 21 * 22 * Alternatively, the contents of this file may be used under the terms of the 23 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are 24 * applicable instead of those above. If you wish to allow use of your version of this 25 * file only under the terms of the GPL and not to allow others to use your version 26 * of this file under the MPL, indicate your decision by deleting the provisions above 27 * and replace them with the notice and other provisions required by the GPL License. 28 * If you do not delete the provisions above, a recipient may use your version of 29 * this file under either the MPL or the GPL. 30 * 31 */ 32 33 34 package ca.uhn.hl7v2.model.v28.message; 35 36 import ca.uhn.hl7v2.model.v28.group.*; 37 import ca.uhn.hl7v2.model.v28.segment.*; 38 39 import ca.uhn.hl7v2.HL7Exception; 40 import ca.uhn.hl7v2.parser.ModelClassFactory; 41 import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 42 import ca.uhn.hl7v2.model.*; 43 44 45 /** 46 * <p>Represents a RPR_I03 message structure (see chapter 11.3.3). This structure contains the 47 * following elements: </p> 48 * <ul> 49 * <li>1: MSH (Message Header) <b> </b> </li> 50 * <li>2: SFT (Software Segment) <b>optional repeating</b> </li> 51 * <li>3: UAC (User Authentication Credential Segment) <b>optional </b> </li> 52 * <li>4: MSA (Message Acknowledgment) <b> </b> </li> 53 * <li>5: RPR_I03_PROVIDER (a Group object) <b> repeating</b> </li> 54 * <li>6: PID (Patient Identification) <b>optional repeating</b> </li> 55 * <li>7: NTE (Notes and Comments) <b>optional repeating</b> </li> 56 * </ul> 57 */ 58 //@SuppressWarnings("unused") 59 public class RPR_I03 extends AbstractMessage { 60 61 /** 62 * Creates a new RPR_I03 message with DefaultModelClassFactory. 63 */ 64 public RPR_I03() { 65 this(new DefaultModelClassFactory()); 66 } 67 68 /** 69 * Creates a new RPR_I03 message with custom ModelClassFactory. 70 */ 71 public RPR_I03(ModelClassFactory factory) { 72 super(factory); 73 init(factory); 74 } 75 76 private void init(ModelClassFactory factory) { 77 try { 78 this.add(MSH.class, true, false); 79 this.add(SFT.class, false, true); 80 this.add(UAC.class, false, false); 81 this.add(MSA.class, true, false); 82 this.add(RPR_I03_PROVIDER.class, true, true); 83 this.add(PID.class, false, true); 84 this.add(NTE.class, false, true); 85 } catch(HL7Exception e) { 86 log.error("Unexpected error creating RPR_I03 - this is probably a bug in the source code generator.", e); 87 } 88 } 89 90 91 /** 92 * Returns "2.8" 93 */ 94 public String getVersion() { 95 return "2.8"; 96 } 97 98 99 100 101 /** 102 * <p> 103 * Returns 104 * MSH (Message Header) - creates it if necessary 105 * </p> 106 * 107 * 108 */ 109 public MSH getMSH() { 110 return getTyped("MSH", MSH.class); 111 } 112 113 114 115 116 117 /** 118 * <p> 119 * Returns 120 * the first repetition of 121 * SFT (Software Segment) - creates it if necessary 122 * </p> 123 * 124 * 125 */ 126 public SFT getSFT() { 127 return getTyped("SFT", SFT.class); 128 } 129 130 131 /** 132 * <p> 133 * Returns a specific repetition of 134 * SFT (Software Segment) - creates it if necessary 135 * </p> 136 * 137 * 138 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 139 * @throws HL7Exception if the repetition requested is more than one 140 * greater than the number of existing repetitions. 141 */ 142 public SFT getSFT(int rep) { 143 return getTyped("SFT", rep, SFT.class); 144 } 145 146 /** 147 * <p> 148 * Returns the number of existing repetitions of SFT 149 * </p> 150 * 151 */ 152 public int getSFTReps() { 153 return getReps("SFT"); 154 } 155 156 /** 157 * <p> 158 * Returns a non-modifiable List containing all current existing repetitions of SFT. 159 * <p> 160 * <p> 161 * Note that unlike {@link #getSFT()}, this method will not create any reps 162 * if none are already present, so an empty list may be returned. 163 * </p> 164 * 165 */ 166 public java.util.List<SFT> getSFTAll() throws HL7Exception { 167 return getAllAsList("SFT", SFT.class); 168 } 169 170 /** 171 * <p> 172 * Inserts a specific repetition of SFT (Software Segment) 173 * </p> 174 * 175 * 176 * @see AbstractGroup#insertRepetition(Structure, int) 177 */ 178 public void insertSFT(SFT structure, int rep) throws HL7Exception { 179 super.insertRepetition( "SFT", structure, rep); 180 } 181 182 183 /** 184 * <p> 185 * Inserts a specific repetition of SFT (Software Segment) 186 * </p> 187 * 188 * 189 * @see AbstractGroup#insertRepetition(Structure, int) 190 */ 191 public SFT insertSFT(int rep) throws HL7Exception { 192 return (SFT)super.insertRepetition("SFT", rep); 193 } 194 195 196 /** 197 * <p> 198 * Removes a specific repetition of SFT (Software Segment) 199 * </p> 200 * 201 * 202 * @see AbstractGroup#removeRepetition(String, int) 203 */ 204 public SFT removeSFT(int rep) throws HL7Exception { 205 return (SFT)super.removeRepetition("SFT", rep); 206 } 207 208 209 210 211 /** 212 * <p> 213 * Returns 214 * UAC (User Authentication Credential Segment) - creates it if necessary 215 * </p> 216 * 217 * 218 */ 219 public UAC getUAC() { 220 return getTyped("UAC", UAC.class); 221 } 222 223 224 225 226 227 /** 228 * <p> 229 * Returns 230 * MSA (Message Acknowledgment) - creates it if necessary 231 * </p> 232 * 233 * 234 */ 235 public MSA getMSA() { 236 return getTyped("MSA", MSA.class); 237 } 238 239 240 241 242 243 /** 244 * <p> 245 * Returns 246 * the first repetition of 247 * PROVIDER (a Group object) - creates it if necessary 248 * </p> 249 * 250 * 251 */ 252 public RPR_I03_PROVIDER getPROVIDER() { 253 return getTyped("PROVIDER", RPR_I03_PROVIDER.class); 254 } 255 256 257 /** 258 * <p> 259 * Returns a specific repetition of 260 * PROVIDER (a Group object) - creates it if necessary 261 * </p> 262 * 263 * 264 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 265 * @throws HL7Exception if the repetition requested is more than one 266 * greater than the number of existing repetitions. 267 */ 268 public RPR_I03_PROVIDER getPROVIDER(int rep) { 269 return getTyped("PROVIDER", rep, RPR_I03_PROVIDER.class); 270 } 271 272 /** 273 * <p> 274 * Returns the number of existing repetitions of PROVIDER 275 * </p> 276 * 277 */ 278 public int getPROVIDERReps() { 279 return getReps("PROVIDER"); 280 } 281 282 /** 283 * <p> 284 * Returns a non-modifiable List containing all current existing repetitions of PROVIDER. 285 * <p> 286 * <p> 287 * Note that unlike {@link #getPROVIDER()}, this method will not create any reps 288 * if none are already present, so an empty list may be returned. 289 * </p> 290 * 291 */ 292 public java.util.List<RPR_I03_PROVIDER> getPROVIDERAll() throws HL7Exception { 293 return getAllAsList("PROVIDER", RPR_I03_PROVIDER.class); 294 } 295 296 /** 297 * <p> 298 * Inserts a specific repetition of PROVIDER (a Group object) 299 * </p> 300 * 301 * 302 * @see AbstractGroup#insertRepetition(Structure, int) 303 */ 304 public void insertPROVIDER(RPR_I03_PROVIDER structure, int rep) throws HL7Exception { 305 super.insertRepetition( "PROVIDER", structure, rep); 306 } 307 308 309 /** 310 * <p> 311 * Inserts a specific repetition of PROVIDER (a Group object) 312 * </p> 313 * 314 * 315 * @see AbstractGroup#insertRepetition(Structure, int) 316 */ 317 public RPR_I03_PROVIDER insertPROVIDER(int rep) throws HL7Exception { 318 return (RPR_I03_PROVIDER)super.insertRepetition("PROVIDER", rep); 319 } 320 321 322 /** 323 * <p> 324 * Removes a specific repetition of PROVIDER (a Group object) 325 * </p> 326 * 327 * 328 * @see AbstractGroup#removeRepetition(String, int) 329 */ 330 public RPR_I03_PROVIDER removePROVIDER(int rep) throws HL7Exception { 331 return (RPR_I03_PROVIDER)super.removeRepetition("PROVIDER", rep); 332 } 333 334 335 336 337 /** 338 * <p> 339 * Returns 340 * the first repetition of 341 * PID (Patient Identification) - creates it if necessary 342 * </p> 343 * 344 * 345 */ 346 public PID getPID() { 347 return getTyped("PID", PID.class); 348 } 349 350 351 /** 352 * <p> 353 * Returns a specific repetition of 354 * PID (Patient Identification) - creates it if necessary 355 * </p> 356 * 357 * 358 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 359 * @throws HL7Exception if the repetition requested is more than one 360 * greater than the number of existing repetitions. 361 */ 362 public PID getPID(int rep) { 363 return getTyped("PID", rep, PID.class); 364 } 365 366 /** 367 * <p> 368 * Returns the number of existing repetitions of PID 369 * </p> 370 * 371 */ 372 public int getPIDReps() { 373 return getReps("PID"); 374 } 375 376 /** 377 * <p> 378 * Returns a non-modifiable List containing all current existing repetitions of PID. 379 * <p> 380 * <p> 381 * Note that unlike {@link #getPID()}, this method will not create any reps 382 * if none are already present, so an empty list may be returned. 383 * </p> 384 * 385 */ 386 public java.util.List<PID> getPIDAll() throws HL7Exception { 387 return getAllAsList("PID", PID.class); 388 } 389 390 /** 391 * <p> 392 * Inserts a specific repetition of PID (Patient Identification) 393 * </p> 394 * 395 * 396 * @see AbstractGroup#insertRepetition(Structure, int) 397 */ 398 public void insertPID(PID structure, int rep) throws HL7Exception { 399 super.insertRepetition( "PID", structure, rep); 400 } 401 402 403 /** 404 * <p> 405 * Inserts a specific repetition of PID (Patient Identification) 406 * </p> 407 * 408 * 409 * @see AbstractGroup#insertRepetition(Structure, int) 410 */ 411 public PID insertPID(int rep) throws HL7Exception { 412 return (PID)super.insertRepetition("PID", rep); 413 } 414 415 416 /** 417 * <p> 418 * Removes a specific repetition of PID (Patient Identification) 419 * </p> 420 * 421 * 422 * @see AbstractGroup#removeRepetition(String, int) 423 */ 424 public PID removePID(int rep) throws HL7Exception { 425 return (PID)super.removeRepetition("PID", rep); 426 } 427 428 429 430 431 /** 432 * <p> 433 * Returns 434 * the first repetition of 435 * NTE (Notes and Comments) - creates it if necessary 436 * </p> 437 * 438 * 439 */ 440 public NTE getNTE() { 441 return getTyped("NTE", NTE.class); 442 } 443 444 445 /** 446 * <p> 447 * Returns a specific repetition of 448 * NTE (Notes and Comments) - creates it if necessary 449 * </p> 450 * 451 * 452 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 453 * @throws HL7Exception if the repetition requested is more than one 454 * greater than the number of existing repetitions. 455 */ 456 public NTE getNTE(int rep) { 457 return getTyped("NTE", rep, NTE.class); 458 } 459 460 /** 461 * <p> 462 * Returns the number of existing repetitions of NTE 463 * </p> 464 * 465 */ 466 public int getNTEReps() { 467 return getReps("NTE"); 468 } 469 470 /** 471 * <p> 472 * Returns a non-modifiable List containing all current existing repetitions of NTE. 473 * <p> 474 * <p> 475 * Note that unlike {@link #getNTE()}, this method will not create any reps 476 * if none are already present, so an empty list may be returned. 477 * </p> 478 * 479 */ 480 public java.util.List<NTE> getNTEAll() throws HL7Exception { 481 return getAllAsList("NTE", NTE.class); 482 } 483 484 /** 485 * <p> 486 * Inserts a specific repetition of NTE (Notes and Comments) 487 * </p> 488 * 489 * 490 * @see AbstractGroup#insertRepetition(Structure, int) 491 */ 492 public void insertNTE(NTE structure, int rep) throws HL7Exception { 493 super.insertRepetition( "NTE", structure, rep); 494 } 495 496 497 /** 498 * <p> 499 * Inserts a specific repetition of NTE (Notes and Comments) 500 * </p> 501 * 502 * 503 * @see AbstractGroup#insertRepetition(Structure, int) 504 */ 505 public NTE insertNTE(int rep) throws HL7Exception { 506 return (NTE)super.insertRepetition("NTE", rep); 507 } 508 509 510 /** 511 * <p> 512 * Removes a specific repetition of NTE (Notes and Comments) 513 * </p> 514 * 515 * 516 * @see AbstractGroup#removeRepetition(String, int) 517 */ 518 public NTE removeNTE(int rep) throws HL7Exception { 519 return (NTE)super.removeRepetition("NTE", rep); 520 } 521 522 523 524 } 525