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.message; 035 036import ca.uhn.hl7v2.model.v23.group.*; 037import ca.uhn.hl7v2.model.v23.segment.*; 038 039import ca.uhn.hl7v2.HL7Exception; 040import ca.uhn.hl7v2.parser.ModelClassFactory; 041import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 042import ca.uhn.hl7v2.model.*; 043 044 045/** 046 * <p>Represents a VXR_V03 message structure (see chapter ?). This structure contains the 047 * following elements: </p> 048 * <ul> 049 * <li>1: MSH (Message header segment) <b> </b> </li> 050 * <li>2: MSA (Message acknowledgement segment) <b> </b> </li> 051 * <li>3: QRD (Query definition segment) <b> </b> </li> 052 * <li>4: QRF (Query filter segment) <b>optional </b> </li> 053 * <li>5: PID (Patient Identification) <b> </b> </li> 054 * <li>6: PD1 (Patient Demographic) <b>optional </b> </li> 055 * <li>7: NK1 (Next of kin) <b>optional repeating</b> </li> 056 * <li>8: VXR_V03_PATIENT_VISIT (a Group object) <b>optional </b> </li> 057 * <li>9: VXR_V03_INSURANCE (a Group object) <b>optional repeating</b> </li> 058 * <li>10: VXR_V03_ORDER (a Group object) <b>optional repeating</b> </li> 059 * </ul> 060 */ 061//@SuppressWarnings("unused") 062public class VXR_V03 extends AbstractMessage { 063 064 /** 065 * Creates a new VXR_V03 message with DefaultModelClassFactory. 066 */ 067 public VXR_V03() { 068 this(new DefaultModelClassFactory()); 069 } 070 071 /** 072 * Creates a new VXR_V03 message with custom ModelClassFactory. 073 */ 074 public VXR_V03(ModelClassFactory factory) { 075 super(factory); 076 init(factory); 077 } 078 079 private void init(ModelClassFactory factory) { 080 try { 081 this.add(MSH.class, true, false); 082 this.add(MSA.class, true, false); 083 this.add(QRD.class, true, false); 084 this.add(QRF.class, false, false); 085 this.add(PID.class, true, false); 086 this.add(PD1.class, false, false); 087 this.add(NK1.class, false, true); 088 this.add(VXR_V03_PATIENT_VISIT.class, false, false); 089 this.add(VXR_V03_INSURANCE.class, false, true); 090 this.add(VXR_V03_ORDER.class, false, true); 091 } catch(HL7Exception e) { 092 log.error("Unexpected error creating VXR_V03 - this is probably a bug in the source code generator.", e); 093 } 094 } 095 096 097 /** 098 * Returns "2.3" 099 */ 100 public String getVersion() { 101 return "2.3"; 102 } 103 104 105 106 107 /** 108 * <p> 109 * Returns 110 * MSH (Message header segment) - creates it if necessary 111 * </p> 112 * 113 * 114 */ 115 public MSH getMSH() { 116 return getTyped("MSH", MSH.class); 117 } 118 119 120 121 122 123 /** 124 * <p> 125 * Returns 126 * MSA (Message acknowledgement segment) - creates it if necessary 127 * </p> 128 * 129 * 130 */ 131 public MSA getMSA() { 132 return getTyped("MSA", MSA.class); 133 } 134 135 136 137 138 139 /** 140 * <p> 141 * Returns 142 * QRD (Query definition segment) - creates it if necessary 143 * </p> 144 * 145 * 146 */ 147 public QRD getQRD() { 148 return getTyped("QRD", QRD.class); 149 } 150 151 152 153 154 155 /** 156 * <p> 157 * Returns 158 * QRF (Query filter segment) - creates it if necessary 159 * </p> 160 * 161 * 162 */ 163 public QRF getQRF() { 164 return getTyped("QRF", QRF.class); 165 } 166 167 168 169 170 171 /** 172 * <p> 173 * Returns 174 * PID (Patient Identification) - creates it if necessary 175 * </p> 176 * 177 * 178 */ 179 public PID getPID() { 180 return getTyped("PID", PID.class); 181 } 182 183 184 185 186 187 /** 188 * <p> 189 * Returns 190 * PD1 (Patient Demographic) - creates it if necessary 191 * </p> 192 * 193 * 194 */ 195 public PD1 getPD1() { 196 return getTyped("PD1", PD1.class); 197 } 198 199 200 201 202 203 /** 204 * <p> 205 * Returns 206 * the first repetition of 207 * NK1 (Next of kin) - creates it if necessary 208 * </p> 209 * 210 * 211 */ 212 public NK1 getNK1() { 213 return getTyped("NK1", NK1.class); 214 } 215 216 217 /** 218 * <p> 219 * Returns a specific repetition of 220 * NK1 (Next of kin) - creates it if necessary 221 * </p> 222 * 223 * 224 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 225 * @throws HL7Exception if the repetition requested is more than one 226 * greater than the number of existing repetitions. 227 */ 228 public NK1 getNK1(int rep) { 229 return getTyped("NK1", rep, NK1.class); 230 } 231 232 /** 233 * <p> 234 * Returns the number of existing repetitions of NK1 235 * </p> 236 * 237 */ 238 public int getNK1Reps() { 239 return getReps("NK1"); 240 } 241 242 /** 243 * <p> 244 * Returns a non-modifiable List containing all current existing repetitions of NK1. 245 * <p> 246 * <p> 247 * Note that unlike {@link #getNK1()}, this method will not create any reps 248 * if none are already present, so an empty list may be returned. 249 * </p> 250 * 251 */ 252 public java.util.List<NK1> getNK1All() throws HL7Exception { 253 return getAllAsList("NK1", NK1.class); 254 } 255 256 /** 257 * <p> 258 * Inserts a specific repetition of NK1 (Next of kin) 259 * </p> 260 * 261 * 262 * @see AbstractGroup#insertRepetition(Structure, int) 263 */ 264 public void insertNK1(NK1 structure, int rep) throws HL7Exception { 265 super.insertRepetition( "NK1", structure, rep); 266 } 267 268 269 /** 270 * <p> 271 * Inserts a specific repetition of NK1 (Next of kin) 272 * </p> 273 * 274 * 275 * @see AbstractGroup#insertRepetition(Structure, int) 276 */ 277 public NK1 insertNK1(int rep) throws HL7Exception { 278 return (NK1)super.insertRepetition("NK1", rep); 279 } 280 281 282 /** 283 * <p> 284 * Removes a specific repetition of NK1 (Next of kin) 285 * </p> 286 * 287 * 288 * @see AbstractGroup#removeRepetition(String, int) 289 */ 290 public NK1 removeNK1(int rep) throws HL7Exception { 291 return (NK1)super.removeRepetition("NK1", rep); 292 } 293 294 295 296 297 /** 298 * <p> 299 * Returns 300 * PATIENT_VISIT (a Group object) - creates it if necessary 301 * </p> 302 * 303 * 304 */ 305 public VXR_V03_PATIENT_VISIT getPATIENT_VISIT() { 306 return getTyped("PATIENT_VISIT", VXR_V03_PATIENT_VISIT.class); 307 } 308 309 310 311 312 313 /** 314 * <p> 315 * Returns 316 * the first repetition of 317 * INSURANCE (a Group object) - creates it if necessary 318 * </p> 319 * 320 * 321 */ 322 public VXR_V03_INSURANCE getINSURANCE() { 323 return getTyped("INSURANCE", VXR_V03_INSURANCE.class); 324 } 325 326 327 /** 328 * <p> 329 * Returns a specific repetition of 330 * INSURANCE (a Group object) - creates it if necessary 331 * </p> 332 * 333 * 334 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 335 * @throws HL7Exception if the repetition requested is more than one 336 * greater than the number of existing repetitions. 337 */ 338 public VXR_V03_INSURANCE getINSURANCE(int rep) { 339 return getTyped("INSURANCE", rep, VXR_V03_INSURANCE.class); 340 } 341 342 /** 343 * <p> 344 * Returns the number of existing repetitions of INSURANCE 345 * </p> 346 * 347 */ 348 public int getINSURANCEReps() { 349 return getReps("INSURANCE"); 350 } 351 352 /** 353 * <p> 354 * Returns a non-modifiable List containing all current existing repetitions of INSURANCE. 355 * <p> 356 * <p> 357 * Note that unlike {@link #getINSURANCE()}, this method will not create any reps 358 * if none are already present, so an empty list may be returned. 359 * </p> 360 * 361 */ 362 public java.util.List<VXR_V03_INSURANCE> getINSURANCEAll() throws HL7Exception { 363 return getAllAsList("INSURANCE", VXR_V03_INSURANCE.class); 364 } 365 366 /** 367 * <p> 368 * Inserts a specific repetition of INSURANCE (a Group object) 369 * </p> 370 * 371 * 372 * @see AbstractGroup#insertRepetition(Structure, int) 373 */ 374 public void insertINSURANCE(VXR_V03_INSURANCE structure, int rep) throws HL7Exception { 375 super.insertRepetition( "INSURANCE", structure, rep); 376 } 377 378 379 /** 380 * <p> 381 * Inserts a specific repetition of INSURANCE (a Group object) 382 * </p> 383 * 384 * 385 * @see AbstractGroup#insertRepetition(Structure, int) 386 */ 387 public VXR_V03_INSURANCE insertINSURANCE(int rep) throws HL7Exception { 388 return (VXR_V03_INSURANCE)super.insertRepetition("INSURANCE", rep); 389 } 390 391 392 /** 393 * <p> 394 * Removes a specific repetition of INSURANCE (a Group object) 395 * </p> 396 * 397 * 398 * @see AbstractGroup#removeRepetition(String, int) 399 */ 400 public VXR_V03_INSURANCE removeINSURANCE(int rep) throws HL7Exception { 401 return (VXR_V03_INSURANCE)super.removeRepetition("INSURANCE", rep); 402 } 403 404 405 406 407 /** 408 * <p> 409 * Returns 410 * the first repetition of 411 * ORDER (a Group object) - creates it if necessary 412 * </p> 413 * 414 * 415 */ 416 public VXR_V03_ORDER getORDER() { 417 return getTyped("ORDER", VXR_V03_ORDER.class); 418 } 419 420 421 /** 422 * <p> 423 * Returns a specific repetition of 424 * ORDER (a Group object) - creates it if necessary 425 * </p> 426 * 427 * 428 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 429 * @throws HL7Exception if the repetition requested is more than one 430 * greater than the number of existing repetitions. 431 */ 432 public VXR_V03_ORDER getORDER(int rep) { 433 return getTyped("ORDER", rep, VXR_V03_ORDER.class); 434 } 435 436 /** 437 * <p> 438 * Returns the number of existing repetitions of ORDER 439 * </p> 440 * 441 */ 442 public int getORDERReps() { 443 return getReps("ORDER"); 444 } 445 446 /** 447 * <p> 448 * Returns a non-modifiable List containing all current existing repetitions of ORDER. 449 * <p> 450 * <p> 451 * Note that unlike {@link #getORDER()}, this method will not create any reps 452 * if none are already present, so an empty list may be returned. 453 * </p> 454 * 455 */ 456 public java.util.List<VXR_V03_ORDER> getORDERAll() throws HL7Exception { 457 return getAllAsList("ORDER", VXR_V03_ORDER.class); 458 } 459 460 /** 461 * <p> 462 * Inserts a specific repetition of ORDER (a Group object) 463 * </p> 464 * 465 * 466 * @see AbstractGroup#insertRepetition(Structure, int) 467 */ 468 public void insertORDER(VXR_V03_ORDER structure, int rep) throws HL7Exception { 469 super.insertRepetition( "ORDER", structure, rep); 470 } 471 472 473 /** 474 * <p> 475 * Inserts a specific repetition of ORDER (a Group object) 476 * </p> 477 * 478 * 479 * @see AbstractGroup#insertRepetition(Structure, int) 480 */ 481 public VXR_V03_ORDER insertORDER(int rep) throws HL7Exception { 482 return (VXR_V03_ORDER)super.insertRepetition("ORDER", rep); 483 } 484 485 486 /** 487 * <p> 488 * Removes a specific repetition of ORDER (a Group object) 489 * </p> 490 * 491 * 492 * @see AbstractGroup#removeRepetition(String, int) 493 */ 494 public VXR_V03_ORDER removeORDER(int rep) throws HL7Exception { 495 return (VXR_V03_ORDER)super.removeRepetition("ORDER", rep); 496 } 497 498 499 500} 501