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