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.v26.group; 035 036import ca.uhn.hl7v2.model.v26.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a ORF_R04_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>optional </b></li> 049 * <li>2: OBR (Observation Request) <b> </b></li> 050 * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li> 051 * <li>4: ROL (Role) <b>optional repeating </b></li> 052 * <li>5: ORF_R04_TIMING_QTY (a Group object) <b>optional repeating </b></li> 053 * <li>6: CTD (Contact Data) <b>optional </b></li> 054 * <li>7: ORF_R04_OBSERVATION (a Group object) <b> repeating </b></li> 055 * <li>8: CTI (Clinical Trial Identification) <b>optional repeating </b></li> 056 * </ul> 057 */ 058//@SuppressWarnings("unused") 059public class ORF_R04_ORDER extends AbstractGroup { 060 061 /** 062 * Creates a new ORF_R04_ORDER group 063 */ 064 public ORF_R04_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, false, false, false); 072 this.add(OBR.class, true, false, false); 073 this.add(NTE.class, false, true, false); 074 this.add(ROL.class, false, true, false); 075 this.add(ORF_R04_TIMING_QTY.class, false, true, false); 076 this.add(CTD.class, false, false, false); 077 this.add(ORF_R04_OBSERVATION.class, true, true, false); 078 this.add(CTI.class, false, true, false); 079 } catch(HL7Exception e) { 080 log.error("Unexpected error creating ORF_R04_ORDER - this is probably a bug in the source code generator.", e); 081 } 082 } 083 084 /** 085 * Returns "2.6" 086 */ 087 public String getVersion() { 088 return "2.6"; 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 * OBR (Observation Request) - creates it if necessary 108 */ 109 public OBR getOBR() { 110 OBR retVal = getTyped("OBR", OBR.class); 111 return retVal; 112 } 113 114 115 116 117 /** 118 * Returns 119 * the first repetition of 120 * NTE (Notes and Comments) - creates it if necessary 121 */ 122 public NTE getNTE() { 123 NTE retVal = getTyped("NTE", NTE.class); 124 return retVal; 125 } 126 127 128 /** 129 * Returns a specific repetition of 130 * NTE (Notes and Comments) - creates it if necessary 131 * 132 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 133 * @throws HL7Exception if the repetition requested is more than one 134 * greater than the number of existing repetitions. 135 */ 136 public NTE getNTE(int rep) { 137 NTE retVal = getTyped("NTE", rep, NTE.class); 138 return retVal; 139 } 140 141 /** 142 * Returns the number of existing repetitions of NTE 143 */ 144 public int getNTEReps() { 145 return getReps("NTE"); 146 } 147 148 /** 149 * <p> 150 * Returns a non-modifiable List containing all current existing repetitions of NTE. 151 * <p> 152 * <p> 153 * Note that unlike {@link #getNTE()}, this method will not create any reps 154 * if none are already present, so an empty list may be returned. 155 * </p> 156 */ 157 public java.util.List<NTE> getNTEAll() throws HL7Exception { 158 return getAllAsList("NTE", NTE.class); 159 } 160 161 /** 162 * Inserts a specific repetition of NTE (Notes and Comments) 163 * @see AbstractGroup#insertRepetition(Structure, int) 164 */ 165 public void insertNTE(NTE structure, int rep) throws HL7Exception { 166 super.insertRepetition("NTE", structure, rep); 167 } 168 169 170 /** 171 * Inserts a specific repetition of NTE (Notes and Comments) 172 * @see AbstractGroup#insertRepetition(Structure, int) 173 */ 174 public NTE insertNTE(int rep) throws HL7Exception { 175 return (NTE)super.insertRepetition("NTE", rep); 176 } 177 178 179 /** 180 * Removes a specific repetition of NTE (Notes and Comments) 181 * @see AbstractGroup#removeRepetition(String, int) 182 */ 183 public NTE removeNTE(int rep) throws HL7Exception { 184 return (NTE)super.removeRepetition("NTE", rep); 185 } 186 187 188 189 /** 190 * Returns 191 * the first repetition of 192 * ROL (Role) - creates it if necessary 193 */ 194 public ROL getROL() { 195 ROL retVal = getTyped("ROL", ROL.class); 196 return retVal; 197 } 198 199 200 /** 201 * Returns a specific repetition of 202 * ROL (Role) - 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 ROL getROL(int rep) { 209 ROL retVal = getTyped("ROL", rep, ROL.class); 210 return retVal; 211 } 212 213 /** 214 * Returns the number of existing repetitions of ROL 215 */ 216 public int getROLReps() { 217 return getReps("ROL"); 218 } 219 220 /** 221 * <p> 222 * Returns a non-modifiable List containing all current existing repetitions of ROL. 223 * <p> 224 * <p> 225 * Note that unlike {@link #getROL()}, 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<ROL> getROLAll() throws HL7Exception { 230 return getAllAsList("ROL", ROL.class); 231 } 232 233 /** 234 * Inserts a specific repetition of ROL (Role) 235 * @see AbstractGroup#insertRepetition(Structure, int) 236 */ 237 public void insertROL(ROL structure, int rep) throws HL7Exception { 238 super.insertRepetition("ROL", structure, rep); 239 } 240 241 242 /** 243 * Inserts a specific repetition of ROL (Role) 244 * @see AbstractGroup#insertRepetition(Structure, int) 245 */ 246 public ROL insertROL(int rep) throws HL7Exception { 247 return (ROL)super.insertRepetition("ROL", rep); 248 } 249 250 251 /** 252 * Removes a specific repetition of ROL (Role) 253 * @see AbstractGroup#removeRepetition(String, int) 254 */ 255 public ROL removeROL(int rep) throws HL7Exception { 256 return (ROL)super.removeRepetition("ROL", rep); 257 } 258 259 260 261 /** 262 * Returns 263 * the first repetition of 264 * TIMING_QTY (a Group object) - creates it if necessary 265 */ 266 public ORF_R04_TIMING_QTY getTIMING_QTY() { 267 ORF_R04_TIMING_QTY retVal = getTyped("TIMING_QTY", ORF_R04_TIMING_QTY.class); 268 return retVal; 269 } 270 271 272 /** 273 * Returns a specific repetition of 274 * TIMING_QTY (a Group object) - creates it if necessary 275 * 276 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 277 * @throws HL7Exception if the repetition requested is more than one 278 * greater than the number of existing repetitions. 279 */ 280 public ORF_R04_TIMING_QTY getTIMING_QTY(int rep) { 281 ORF_R04_TIMING_QTY retVal = getTyped("TIMING_QTY", rep, ORF_R04_TIMING_QTY.class); 282 return retVal; 283 } 284 285 /** 286 * Returns the number of existing repetitions of TIMING_QTY 287 */ 288 public int getTIMING_QTYReps() { 289 return getReps("TIMING_QTY"); 290 } 291 292 /** 293 * <p> 294 * Returns a non-modifiable List containing all current existing repetitions of TIMING_QTY. 295 * <p> 296 * <p> 297 * Note that unlike {@link #getTIMING_QTY()}, this method will not create any reps 298 * if none are already present, so an empty list may be returned. 299 * </p> 300 */ 301 public java.util.List<ORF_R04_TIMING_QTY> getTIMING_QTYAll() throws HL7Exception { 302 return getAllAsList("TIMING_QTY", ORF_R04_TIMING_QTY.class); 303 } 304 305 /** 306 * Inserts a specific repetition of TIMING_QTY (a Group object) 307 * @see AbstractGroup#insertRepetition(Structure, int) 308 */ 309 public void insertTIMING_QTY(ORF_R04_TIMING_QTY structure, int rep) throws HL7Exception { 310 super.insertRepetition("TIMING_QTY", structure, rep); 311 } 312 313 314 /** 315 * Inserts a specific repetition of TIMING_QTY (a Group object) 316 * @see AbstractGroup#insertRepetition(Structure, int) 317 */ 318 public ORF_R04_TIMING_QTY insertTIMING_QTY(int rep) throws HL7Exception { 319 return (ORF_R04_TIMING_QTY)super.insertRepetition("TIMING_QTY", rep); 320 } 321 322 323 /** 324 * Removes a specific repetition of TIMING_QTY (a Group object) 325 * @see AbstractGroup#removeRepetition(String, int) 326 */ 327 public ORF_R04_TIMING_QTY removeTIMING_QTY(int rep) throws HL7Exception { 328 return (ORF_R04_TIMING_QTY)super.removeRepetition("TIMING_QTY", rep); 329 } 330 331 332 333 /** 334 * Returns 335 * CTD (Contact Data) - creates it if necessary 336 */ 337 public CTD getCTD() { 338 CTD retVal = getTyped("CTD", CTD.class); 339 return retVal; 340 } 341 342 343 344 345 /** 346 * Returns 347 * the first repetition of 348 * OBSERVATION (a Group object) - creates it if necessary 349 */ 350 public ORF_R04_OBSERVATION getOBSERVATION() { 351 ORF_R04_OBSERVATION retVal = getTyped("OBSERVATION", ORF_R04_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 ORF_R04_OBSERVATION getOBSERVATION(int rep) { 365 ORF_R04_OBSERVATION retVal = getTyped("OBSERVATION", rep, ORF_R04_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<ORF_R04_OBSERVATION> getOBSERVATIONAll() throws HL7Exception { 386 return getAllAsList("OBSERVATION", ORF_R04_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(ORF_R04_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 ORF_R04_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 403 return (ORF_R04_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 ORF_R04_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 412 return (ORF_R04_OBSERVATION)super.removeRepetition("OBSERVATION", rep); 413 } 414 415 416 417 /** 418 * Returns 419 * the first repetition of 420 * CTI (Clinical Trial Identification) - creates it if necessary 421 */ 422 public CTI getCTI() { 423 CTI retVal = getTyped("CTI", CTI.class); 424 return retVal; 425 } 426 427 428 /** 429 * Returns a specific repetition of 430 * CTI (Clinical Trial Identification) - 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 CTI getCTI(int rep) { 437 CTI retVal = getTyped("CTI", rep, CTI.class); 438 return retVal; 439 } 440 441 /** 442 * Returns the number of existing repetitions of CTI 443 */ 444 public int getCTIReps() { 445 return getReps("CTI"); 446 } 447 448 /** 449 * <p> 450 * Returns a non-modifiable List containing all current existing repetitions of CTI. 451 * <p> 452 * <p> 453 * Note that unlike {@link #getCTI()}, 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<CTI> getCTIAll() throws HL7Exception { 458 return getAllAsList("CTI", CTI.class); 459 } 460 461 /** 462 * Inserts a specific repetition of CTI (Clinical Trial Identification) 463 * @see AbstractGroup#insertRepetition(Structure, int) 464 */ 465 public void insertCTI(CTI structure, int rep) throws HL7Exception { 466 super.insertRepetition("CTI", structure, rep); 467 } 468 469 470 /** 471 * Inserts a specific repetition of CTI (Clinical Trial Identification) 472 * @see AbstractGroup#insertRepetition(Structure, int) 473 */ 474 public CTI insertCTI(int rep) throws HL7Exception { 475 return (CTI)super.insertRepetition("CTI", rep); 476 } 477 478 479 /** 480 * Removes a specific repetition of CTI (Clinical Trial Identification) 481 * @see AbstractGroup#removeRepetition(String, int) 482 */ 483 public CTI removeCTI(int rep) throws HL7Exception { 484 return (CTI)super.removeRepetition("CTI", rep); 485 } 486 487 488 489} 490