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