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.v231.message; 35 36 import ca.uhn.hl7v2.model.v231.group.*; 37 import ca.uhn.hl7v2.model.v231.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 ADT_A10 message structure (see chapter ?). This structure contains the 47 * following elements: </p> 48 * <ul> 49 * <li>1: MSH (MSH - message header segment) <b> </b> </li> 50 * <li>2: EVN (EVN - event type segment) <b> </b> </li> 51 * <li>3: PID (PID - patient identification segment) <b> </b> </li> 52 * <li>4: PD1 (PD1 - patient additional demographic segment) <b>optional </b> </li> 53 * <li>5: PV1 (PV1 - patient visit segment-) <b> </b> </li> 54 * <li>6: PV2 (PV2 - patient visit - additional information segment) <b>optional </b> </li> 55 * <li>7: DB1 (DB1 - Disability segment) <b>optional repeating</b> </li> 56 * <li>8: OBX (OBX - observation/result segment) <b>optional repeating</b> </li> 57 * <li>9: DG1 (DG1 - diagnosis segment) <b>optional repeating</b> </li> 58 * </ul> 59 */ 60 //@SuppressWarnings("unused") 61 public class ADT_A10 extends AbstractMessage { 62 63 /** 64 * Creates a new ADT_A10 message with DefaultModelClassFactory. 65 */ 66 public ADT_A10() { 67 this(new DefaultModelClassFactory()); 68 } 69 70 /** 71 * Creates a new ADT_A10 message with custom ModelClassFactory. 72 */ 73 public ADT_A10(ModelClassFactory factory) { 74 super(factory); 75 init(factory); 76 } 77 78 private void init(ModelClassFactory factory) { 79 try { 80 this.add(MSH.class, true, false); 81 this.add(EVN.class, true, false); 82 this.add(PID.class, true, false); 83 this.add(PD1.class, false, false); 84 this.add(PV1.class, true, false); 85 this.add(PV2.class, false, false); 86 this.add(DB1.class, false, true); 87 this.add(OBX.class, false, true); 88 this.add(DG1.class, false, true); 89 } catch(HL7Exception e) { 90 log.error("Unexpected error creating ADT_A10 - this is probably a bug in the source code generator.", e); 91 } 92 } 93 94 95 /** 96 * Returns "2.3.1" 97 */ 98 public String getVersion() { 99 return "2.3.1"; 100 } 101 102 103 104 105 /** 106 * <p> 107 * Returns 108 * MSH (MSH - message header segment) - 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 * EVN (EVN - event type segment) - creates it if necessary 125 * </p> 126 * 127 * 128 */ 129 public EVN getEVN() { 130 return getTyped("EVN", EVN.class); 131 } 132 133 134 135 136 137 /** 138 * <p> 139 * Returns 140 * PID (PID - patient identification segment) - creates it if necessary 141 * </p> 142 * 143 * 144 */ 145 public PID getPID() { 146 return getTyped("PID", PID.class); 147 } 148 149 150 151 152 153 /** 154 * <p> 155 * Returns 156 * PD1 (PD1 - patient additional demographic segment) - creates it if necessary 157 * </p> 158 * 159 * 160 */ 161 public PD1 getPD1() { 162 return getTyped("PD1", PD1.class); 163 } 164 165 166 167 168 169 /** 170 * <p> 171 * Returns 172 * PV1 (PV1 - patient visit segment-) - creates it if necessary 173 * </p> 174 * 175 * 176 */ 177 public PV1 getPV1() { 178 return getTyped("PV1", PV1.class); 179 } 180 181 182 183 184 185 /** 186 * <p> 187 * Returns 188 * PV2 (PV2 - patient visit - additional information segment) - creates it if necessary 189 * </p> 190 * 191 * 192 */ 193 public PV2 getPV2() { 194 return getTyped("PV2", PV2.class); 195 } 196 197 198 199 200 201 /** 202 * <p> 203 * Returns 204 * the first repetition of 205 * DB1 (DB1 - Disability segment) - creates it if necessary 206 * </p> 207 * 208 * 209 */ 210 public DB1 getDB1() { 211 return getTyped("DB1", DB1.class); 212 } 213 214 215 /** 216 * <p> 217 * Returns a specific repetition of 218 * DB1 (DB1 - Disability segment) - creates it if necessary 219 * </p> 220 * 221 * 222 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 223 * @throws HL7Exception if the repetition requested is more than one 224 * greater than the number of existing repetitions. 225 */ 226 public DB1 getDB1(int rep) { 227 return getTyped("DB1", rep, DB1.class); 228 } 229 230 /** 231 * <p> 232 * Returns the number of existing repetitions of DB1 233 * </p> 234 * 235 */ 236 public int getDB1Reps() { 237 return getReps("DB1"); 238 } 239 240 /** 241 * <p> 242 * Returns a non-modifiable List containing all current existing repetitions of DB1. 243 * <p> 244 * <p> 245 * Note that unlike {@link #getDB1()}, this method will not create any reps 246 * if none are already present, so an empty list may be returned. 247 * </p> 248 * 249 */ 250 public java.util.List<DB1> getDB1All() throws HL7Exception { 251 return getAllAsList("DB1", DB1.class); 252 } 253 254 /** 255 * <p> 256 * Inserts a specific repetition of DB1 (DB1 - Disability segment) 257 * </p> 258 * 259 * 260 * @see AbstractGroup#insertRepetition(Structure, int) 261 */ 262 public void insertDB1(DB1 structure, int rep) throws HL7Exception { 263 super.insertRepetition( "DB1", structure, rep); 264 } 265 266 267 /** 268 * <p> 269 * Inserts a specific repetition of DB1 (DB1 - Disability segment) 270 * </p> 271 * 272 * 273 * @see AbstractGroup#insertRepetition(Structure, int) 274 */ 275 public DB1 insertDB1(int rep) throws HL7Exception { 276 return (DB1)super.insertRepetition("DB1", rep); 277 } 278 279 280 /** 281 * <p> 282 * Removes a specific repetition of DB1 (DB1 - Disability segment) 283 * </p> 284 * 285 * 286 * @see AbstractGroup#removeRepetition(String, int) 287 */ 288 public DB1 removeDB1(int rep) throws HL7Exception { 289 return (DB1)super.removeRepetition("DB1", rep); 290 } 291 292 293 294 295 /** 296 * <p> 297 * Returns 298 * the first repetition of 299 * OBX (OBX - observation/result segment) - creates it if necessary 300 * </p> 301 * 302 * 303 */ 304 public OBX getOBX() { 305 return getTyped("OBX", OBX.class); 306 } 307 308 309 /** 310 * <p> 311 * Returns a specific repetition of 312 * OBX (OBX - observation/result segment) - creates it if necessary 313 * </p> 314 * 315 * 316 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 317 * @throws HL7Exception if the repetition requested is more than one 318 * greater than the number of existing repetitions. 319 */ 320 public OBX getOBX(int rep) { 321 return getTyped("OBX", rep, OBX.class); 322 } 323 324 /** 325 * <p> 326 * Returns the number of existing repetitions of OBX 327 * </p> 328 * 329 */ 330 public int getOBXReps() { 331 return getReps("OBX"); 332 } 333 334 /** 335 * <p> 336 * Returns a non-modifiable List containing all current existing repetitions of OBX. 337 * <p> 338 * <p> 339 * Note that unlike {@link #getOBX()}, this method will not create any reps 340 * if none are already present, so an empty list may be returned. 341 * </p> 342 * 343 */ 344 public java.util.List<OBX> getOBXAll() throws HL7Exception { 345 return getAllAsList("OBX", OBX.class); 346 } 347 348 /** 349 * <p> 350 * Inserts a specific repetition of OBX (OBX - observation/result segment) 351 * </p> 352 * 353 * 354 * @see AbstractGroup#insertRepetition(Structure, int) 355 */ 356 public void insertOBX(OBX structure, int rep) throws HL7Exception { 357 super.insertRepetition( "OBX", structure, rep); 358 } 359 360 361 /** 362 * <p> 363 * Inserts a specific repetition of OBX (OBX - observation/result segment) 364 * </p> 365 * 366 * 367 * @see AbstractGroup#insertRepetition(Structure, int) 368 */ 369 public OBX insertOBX(int rep) throws HL7Exception { 370 return (OBX)super.insertRepetition("OBX", rep); 371 } 372 373 374 /** 375 * <p> 376 * Removes a specific repetition of OBX (OBX - observation/result segment) 377 * </p> 378 * 379 * 380 * @see AbstractGroup#removeRepetition(String, int) 381 */ 382 public OBX removeOBX(int rep) throws HL7Exception { 383 return (OBX)super.removeRepetition("OBX", rep); 384 } 385 386 387 388 389 /** 390 * <p> 391 * Returns 392 * the first repetition of 393 * DG1 (DG1 - diagnosis segment) - creates it if necessary 394 * </p> 395 * 396 * 397 */ 398 public DG1 getDG1() { 399 return getTyped("DG1", DG1.class); 400 } 401 402 403 /** 404 * <p> 405 * Returns a specific repetition of 406 * DG1 (DG1 - diagnosis segment) - 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 DG1 getDG1(int rep) { 415 return getTyped("DG1", rep, DG1.class); 416 } 417 418 /** 419 * <p> 420 * Returns the number of existing repetitions of DG1 421 * </p> 422 * 423 */ 424 public int getDG1Reps() { 425 return getReps("DG1"); 426 } 427 428 /** 429 * <p> 430 * Returns a non-modifiable List containing all current existing repetitions of DG1. 431 * <p> 432 * <p> 433 * Note that unlike {@link #getDG1()}, 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<DG1> getDG1All() throws HL7Exception { 439 return getAllAsList("DG1", DG1.class); 440 } 441 442 /** 443 * <p> 444 * Inserts a specific repetition of DG1 (DG1 - diagnosis segment) 445 * </p> 446 * 447 * 448 * @see AbstractGroup#insertRepetition(Structure, int) 449 */ 450 public void insertDG1(DG1 structure, int rep) throws HL7Exception { 451 super.insertRepetition( "DG1", structure, rep); 452 } 453 454 455 /** 456 * <p> 457 * Inserts a specific repetition of DG1 (DG1 - diagnosis segment) 458 * </p> 459 * 460 * 461 * @see AbstractGroup#insertRepetition(Structure, int) 462 */ 463 public DG1 insertDG1(int rep) throws HL7Exception { 464 return (DG1)super.insertRepetition("DG1", rep); 465 } 466 467 468 /** 469 * <p> 470 * Removes a specific repetition of DG1 (DG1 - diagnosis segment) 471 * </p> 472 * 473 * 474 * @see AbstractGroup#removeRepetition(String, int) 475 */ 476 public DG1 removeDG1(int rep) throws HL7Exception { 477 return (DG1)super.removeRepetition("DG1", rep); 478 } 479 480 481 482 } 483