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