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.v231.message; 035 036import ca.uhn.hl7v2.model.v231.group.*; 037import ca.uhn.hl7v2.model.v231.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 VXU_V04 message structure (see chapter ?). This structure contains the 047 * following elements: </p> 048 * <ul> 049 * <li>1: MSH (MSH - message header segment) <b> </b> </li> 050 * <li>2: PID (PID - patient identification segment) <b> </b> </li> 051 * <li>3: PD1 (PD1 - patient additional demographic segment) <b>optional </b> </li> 052 * <li>4: NK1 (NK1 - next of kin / associated parties segment-) <b>optional repeating</b> </li> 053 * <li>5: VXU_V04_PV1PV2 (a Group object) <b>optional </b> </li> 054 * <li>6: VXU_V04_IN1IN2IN3 (a Group object) <b>optional repeating</b> </li> 055 * <li>7: VXU_V04_ORCRXARXROBXNTE (a Group object) <b>optional repeating</b> </li> 056 * </ul> 057 */ 058//@SuppressWarnings("unused") 059public class VXU_V04 extends AbstractMessage { 060 061 /** 062 * Creates a new VXU_V04 message with DefaultModelClassFactory. 063 */ 064 public VXU_V04() { 065 this(new DefaultModelClassFactory()); 066 } 067 068 /** 069 * Creates a new VXU_V04 message with custom ModelClassFactory. 070 */ 071 public VXU_V04(ModelClassFactory factory) { 072 super(factory); 073 init(factory); 074 } 075 076 private void init(ModelClassFactory factory) { 077 try { 078 this.add(MSH.class, true, false); 079 this.add(PID.class, true, false); 080 this.add(PD1.class, false, false); 081 this.add(NK1.class, false, true); 082 this.add(VXU_V04_PV1PV2.class, false, false); 083 this.add(VXU_V04_IN1IN2IN3.class, false, true); 084 this.add(VXU_V04_ORCRXARXROBXNTE.class, false, true); 085 } catch(HL7Exception e) { 086 log.error("Unexpected error creating VXU_V04 - this is probably a bug in the source code generator.", e); 087 } 088 } 089 090 091 /** 092 * Returns "2.3.1" 093 */ 094 public String getVersion() { 095 return "2.3.1"; 096 } 097 098 099 100 101 /** 102 * <p> 103 * Returns 104 * MSH (MSH - message header segment) - 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 * PID (PID - patient identification segment) - creates it if necessary 121 * </p> 122 * 123 * 124 */ 125 public PID getPID() { 126 return getTyped("PID", PID.class); 127 } 128 129 130 131 132 133 /** 134 * <p> 135 * Returns 136 * PD1 (PD1 - patient additional demographic segment) - creates it if necessary 137 * </p> 138 * 139 * 140 */ 141 public PD1 getPD1() { 142 return getTyped("PD1", PD1.class); 143 } 144 145 146 147 148 149 /** 150 * <p> 151 * Returns 152 * the first repetition of 153 * NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary 154 * </p> 155 * 156 * 157 */ 158 public NK1 getNK1() { 159 return getTyped("NK1", NK1.class); 160 } 161 162 163 /** 164 * <p> 165 * Returns a specific repetition of 166 * NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary 167 * </p> 168 * 169 * 170 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 171 * @throws HL7Exception if the repetition requested is more than one 172 * greater than the number of existing repetitions. 173 */ 174 public NK1 getNK1(int rep) { 175 return getTyped("NK1", rep, NK1.class); 176 } 177 178 /** 179 * <p> 180 * Returns the number of existing repetitions of NK1 181 * </p> 182 * 183 */ 184 public int getNK1Reps() { 185 return getReps("NK1"); 186 } 187 188 /** 189 * <p> 190 * Returns a non-modifiable List containing all current existing repetitions of NK1. 191 * <p> 192 * <p> 193 * Note that unlike {@link #getNK1()}, this method will not create any reps 194 * if none are already present, so an empty list may be returned. 195 * </p> 196 * 197 */ 198 public java.util.List<NK1> getNK1All() throws HL7Exception { 199 return getAllAsList("NK1", NK1.class); 200 } 201 202 /** 203 * <p> 204 * Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-) 205 * </p> 206 * 207 * 208 * @see AbstractGroup#insertRepetition(Structure, int) 209 */ 210 public void insertNK1(NK1 structure, int rep) throws HL7Exception { 211 super.insertRepetition( "NK1", structure, rep); 212 } 213 214 215 /** 216 * <p> 217 * Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-) 218 * </p> 219 * 220 * 221 * @see AbstractGroup#insertRepetition(Structure, int) 222 */ 223 public NK1 insertNK1(int rep) throws HL7Exception { 224 return (NK1)super.insertRepetition("NK1", rep); 225 } 226 227 228 /** 229 * <p> 230 * Removes a specific repetition of NK1 (NK1 - next of kin / associated parties segment-) 231 * </p> 232 * 233 * 234 * @see AbstractGroup#removeRepetition(String, int) 235 */ 236 public NK1 removeNK1(int rep) throws HL7Exception { 237 return (NK1)super.removeRepetition("NK1", rep); 238 } 239 240 241 242 243 /** 244 * <p> 245 * Returns 246 * PV1PV2 (a Group object) - creates it if necessary 247 * </p> 248 * 249 * 250 */ 251 public VXU_V04_PV1PV2 getPV1PV2() { 252 return getTyped("PV1PV2", VXU_V04_PV1PV2.class); 253 } 254 255 256 257 258 259 /** 260 * <p> 261 * Returns 262 * the first repetition of 263 * IN1IN2IN3 (a Group object) - creates it if necessary 264 * </p> 265 * 266 * 267 */ 268 public VXU_V04_IN1IN2IN3 getIN1IN2IN3() { 269 return getTyped("IN1IN2IN3", VXU_V04_IN1IN2IN3.class); 270 } 271 272 273 /** 274 * <p> 275 * Returns a specific repetition of 276 * IN1IN2IN3 (a Group object) - creates it if necessary 277 * </p> 278 * 279 * 280 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 281 * @throws HL7Exception if the repetition requested is more than one 282 * greater than the number of existing repetitions. 283 */ 284 public VXU_V04_IN1IN2IN3 getIN1IN2IN3(int rep) { 285 return getTyped("IN1IN2IN3", rep, VXU_V04_IN1IN2IN3.class); 286 } 287 288 /** 289 * <p> 290 * Returns the number of existing repetitions of IN1IN2IN3 291 * </p> 292 * 293 */ 294 public int getIN1IN2IN3Reps() { 295 return getReps("IN1IN2IN3"); 296 } 297 298 /** 299 * <p> 300 * Returns a non-modifiable List containing all current existing repetitions of IN1IN2IN3. 301 * <p> 302 * <p> 303 * Note that unlike {@link #getIN1IN2IN3()}, this method will not create any reps 304 * if none are already present, so an empty list may be returned. 305 * </p> 306 * 307 */ 308 public java.util.List<VXU_V04_IN1IN2IN3> getIN1IN2IN3All() throws HL7Exception { 309 return getAllAsList("IN1IN2IN3", VXU_V04_IN1IN2IN3.class); 310 } 311 312 /** 313 * <p> 314 * Inserts a specific repetition of IN1IN2IN3 (a Group object) 315 * </p> 316 * 317 * 318 * @see AbstractGroup#insertRepetition(Structure, int) 319 */ 320 public void insertIN1IN2IN3(VXU_V04_IN1IN2IN3 structure, int rep) throws HL7Exception { 321 super.insertRepetition( "IN1IN2IN3", structure, rep); 322 } 323 324 325 /** 326 * <p> 327 * Inserts a specific repetition of IN1IN2IN3 (a Group object) 328 * </p> 329 * 330 * 331 * @see AbstractGroup#insertRepetition(Structure, int) 332 */ 333 public VXU_V04_IN1IN2IN3 insertIN1IN2IN3(int rep) throws HL7Exception { 334 return (VXU_V04_IN1IN2IN3)super.insertRepetition("IN1IN2IN3", rep); 335 } 336 337 338 /** 339 * <p> 340 * Removes a specific repetition of IN1IN2IN3 (a Group object) 341 * </p> 342 * 343 * 344 * @see AbstractGroup#removeRepetition(String, int) 345 */ 346 public VXU_V04_IN1IN2IN3 removeIN1IN2IN3(int rep) throws HL7Exception { 347 return (VXU_V04_IN1IN2IN3)super.removeRepetition("IN1IN2IN3", rep); 348 } 349 350 351 352 353 /** 354 * <p> 355 * Returns 356 * the first repetition of 357 * ORCRXARXROBXNTE (a Group object) - creates it if necessary 358 * </p> 359 * 360 * 361 */ 362 public VXU_V04_ORCRXARXROBXNTE getORCRXARXROBXNTE() { 363 return getTyped("ORCRXARXROBXNTE", VXU_V04_ORCRXARXROBXNTE.class); 364 } 365 366 367 /** 368 * <p> 369 * Returns a specific repetition of 370 * ORCRXARXROBXNTE (a Group object) - creates it if necessary 371 * </p> 372 * 373 * 374 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 375 * @throws HL7Exception if the repetition requested is more than one 376 * greater than the number of existing repetitions. 377 */ 378 public VXU_V04_ORCRXARXROBXNTE getORCRXARXROBXNTE(int rep) { 379 return getTyped("ORCRXARXROBXNTE", rep, VXU_V04_ORCRXARXROBXNTE.class); 380 } 381 382 /** 383 * <p> 384 * Returns the number of existing repetitions of ORCRXARXROBXNTE 385 * </p> 386 * 387 */ 388 public int getORCRXARXROBXNTEReps() { 389 return getReps("ORCRXARXROBXNTE"); 390 } 391 392 /** 393 * <p> 394 * Returns a non-modifiable List containing all current existing repetitions of ORCRXARXROBXNTE. 395 * <p> 396 * <p> 397 * Note that unlike {@link #getORCRXARXROBXNTE()}, this method will not create any reps 398 * if none are already present, so an empty list may be returned. 399 * </p> 400 * 401 */ 402 public java.util.List<VXU_V04_ORCRXARXROBXNTE> getORCRXARXROBXNTEAll() throws HL7Exception { 403 return getAllAsList("ORCRXARXROBXNTE", VXU_V04_ORCRXARXROBXNTE.class); 404 } 405 406 /** 407 * <p> 408 * Inserts a specific repetition of ORCRXARXROBXNTE (a Group object) 409 * </p> 410 * 411 * 412 * @see AbstractGroup#insertRepetition(Structure, int) 413 */ 414 public void insertORCRXARXROBXNTE(VXU_V04_ORCRXARXROBXNTE structure, int rep) throws HL7Exception { 415 super.insertRepetition( "ORCRXARXROBXNTE", structure, rep); 416 } 417 418 419 /** 420 * <p> 421 * Inserts a specific repetition of ORCRXARXROBXNTE (a Group object) 422 * </p> 423 * 424 * 425 * @see AbstractGroup#insertRepetition(Structure, int) 426 */ 427 public VXU_V04_ORCRXARXROBXNTE insertORCRXARXROBXNTE(int rep) throws HL7Exception { 428 return (VXU_V04_ORCRXARXROBXNTE)super.insertRepetition("ORCRXARXROBXNTE", rep); 429 } 430 431 432 /** 433 * <p> 434 * Removes a specific repetition of ORCRXARXROBXNTE (a Group object) 435 * </p> 436 * 437 * 438 * @see AbstractGroup#removeRepetition(String, int) 439 */ 440 public VXU_V04_ORCRXARXROBXNTE removeORCRXARXROBXNTE(int rep) throws HL7Exception { 441 return (VXU_V04_ORCRXARXROBXNTE)super.removeRepetition("ORCRXARXROBXNTE", rep); 442 } 443 444 445 446} 447