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 OUL_R23_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: OBR (Observation Request) <b> </b></li> 049 * <li>2: ORC (Common Order) <b>optional </b></li> 050 * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li> 051 * <li>4: OUL_R23_TIMING_QTY (a Group object) <b>optional repeating </b></li> 052 * <li>5: OUL_R23_RESULT (a Group object) <b>optional repeating </b></li> 053 * <li>6: CTI (Clinical Trial Identification) <b>optional repeating </b></li> 054 * </ul> 055 */ 056//@SuppressWarnings("unused") 057public class OUL_R23_ORDER extends AbstractGroup { 058 059 /** 060 * Creates a new OUL_R23_ORDER group 061 */ 062 public OUL_R23_ORDER(Group parent, ModelClassFactory factory) { 063 super(parent, factory); 064 init(factory); 065 } 066 067 private void init(ModelClassFactory factory) { 068 try { 069 this.add(OBR.class, true, false, false); 070 this.add(ORC.class, false, false, false); 071 this.add(NTE.class, false, true, false); 072 this.add(OUL_R23_TIMING_QTY.class, false, true, false); 073 this.add(OUL_R23_RESULT.class, false, true, false); 074 this.add(CTI.class, false, true, false); 075 } catch(HL7Exception e) { 076 log.error("Unexpected error creating OUL_R23_ORDER - this is probably a bug in the source code generator.", e); 077 } 078 } 079 080 /** 081 * Returns "2.5.1" 082 */ 083 public String getVersion() { 084 return "2.5.1"; 085 } 086 087 088 089 /** 090 * Returns 091 * OBR (Observation Request) - creates it if necessary 092 */ 093 public OBR getOBR() { 094 OBR retVal = getTyped("OBR", OBR.class); 095 return retVal; 096 } 097 098 099 100 101 /** 102 * Returns 103 * ORC (Common Order) - creates it if necessary 104 */ 105 public ORC getORC() { 106 ORC retVal = getTyped("ORC", ORC.class); 107 return retVal; 108 } 109 110 111 112 113 /** 114 * Returns 115 * the first repetition of 116 * NTE (Notes and Comments) - creates it if necessary 117 */ 118 public NTE getNTE() { 119 NTE retVal = getTyped("NTE", NTE.class); 120 return retVal; 121 } 122 123 124 /** 125 * Returns a specific repetition of 126 * NTE (Notes and Comments) - creates it if necessary 127 * 128 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 129 * @throws HL7Exception if the repetition requested is more than one 130 * greater than the number of existing repetitions. 131 */ 132 public NTE getNTE(int rep) { 133 NTE retVal = getTyped("NTE", rep, NTE.class); 134 return retVal; 135 } 136 137 /** 138 * Returns the number of existing repetitions of NTE 139 */ 140 public int getNTEReps() { 141 return getReps("NTE"); 142 } 143 144 /** 145 * <p> 146 * Returns a non-modifiable List containing all current existing repetitions of NTE. 147 * <p> 148 * <p> 149 * Note that unlike {@link #getNTE()}, this method will not create any reps 150 * if none are already present, so an empty list may be returned. 151 * </p> 152 */ 153 public java.util.List<NTE> getNTEAll() throws HL7Exception { 154 return getAllAsList("NTE", NTE.class); 155 } 156 157 /** 158 * Inserts a specific repetition of NTE (Notes and Comments) 159 * @see AbstractGroup#insertRepetition(Structure, int) 160 */ 161 public void insertNTE(NTE structure, int rep) throws HL7Exception { 162 super.insertRepetition("NTE", structure, rep); 163 } 164 165 166 /** 167 * Inserts a specific repetition of NTE (Notes and Comments) 168 * @see AbstractGroup#insertRepetition(Structure, int) 169 */ 170 public NTE insertNTE(int rep) throws HL7Exception { 171 return (NTE)super.insertRepetition("NTE", rep); 172 } 173 174 175 /** 176 * Removes a specific repetition of NTE (Notes and Comments) 177 * @see AbstractGroup#removeRepetition(String, int) 178 */ 179 public NTE removeNTE(int rep) throws HL7Exception { 180 return (NTE)super.removeRepetition("NTE", rep); 181 } 182 183 184 185 /** 186 * Returns 187 * the first repetition of 188 * TIMING_QTY (a Group object) - creates it if necessary 189 */ 190 public OUL_R23_TIMING_QTY getTIMING_QTY() { 191 OUL_R23_TIMING_QTY retVal = getTyped("TIMING_QTY", OUL_R23_TIMING_QTY.class); 192 return retVal; 193 } 194 195 196 /** 197 * Returns a specific repetition of 198 * TIMING_QTY (a Group object) - creates it if necessary 199 * 200 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 201 * @throws HL7Exception if the repetition requested is more than one 202 * greater than the number of existing repetitions. 203 */ 204 public OUL_R23_TIMING_QTY getTIMING_QTY(int rep) { 205 OUL_R23_TIMING_QTY retVal = getTyped("TIMING_QTY", rep, OUL_R23_TIMING_QTY.class); 206 return retVal; 207 } 208 209 /** 210 * Returns the number of existing repetitions of TIMING_QTY 211 */ 212 public int getTIMING_QTYReps() { 213 return getReps("TIMING_QTY"); 214 } 215 216 /** 217 * <p> 218 * Returns a non-modifiable List containing all current existing repetitions of TIMING_QTY. 219 * <p> 220 * <p> 221 * Note that unlike {@link #getTIMING_QTY()}, this method will not create any reps 222 * if none are already present, so an empty list may be returned. 223 * </p> 224 */ 225 public java.util.List<OUL_R23_TIMING_QTY> getTIMING_QTYAll() throws HL7Exception { 226 return getAllAsList("TIMING_QTY", OUL_R23_TIMING_QTY.class); 227 } 228 229 /** 230 * Inserts a specific repetition of TIMING_QTY (a Group object) 231 * @see AbstractGroup#insertRepetition(Structure, int) 232 */ 233 public void insertTIMING_QTY(OUL_R23_TIMING_QTY structure, int rep) throws HL7Exception { 234 super.insertRepetition("TIMING_QTY", structure, rep); 235 } 236 237 238 /** 239 * Inserts a specific repetition of TIMING_QTY (a Group object) 240 * @see AbstractGroup#insertRepetition(Structure, int) 241 */ 242 public OUL_R23_TIMING_QTY insertTIMING_QTY(int rep) throws HL7Exception { 243 return (OUL_R23_TIMING_QTY)super.insertRepetition("TIMING_QTY", rep); 244 } 245 246 247 /** 248 * Removes a specific repetition of TIMING_QTY (a Group object) 249 * @see AbstractGroup#removeRepetition(String, int) 250 */ 251 public OUL_R23_TIMING_QTY removeTIMING_QTY(int rep) throws HL7Exception { 252 return (OUL_R23_TIMING_QTY)super.removeRepetition("TIMING_QTY", rep); 253 } 254 255 256 257 /** 258 * Returns 259 * the first repetition of 260 * RESULT (a Group object) - creates it if necessary 261 */ 262 public OUL_R23_RESULT getRESULT() { 263 OUL_R23_RESULT retVal = getTyped("RESULT", OUL_R23_RESULT.class); 264 return retVal; 265 } 266 267 268 /** 269 * Returns a specific repetition of 270 * RESULT (a Group object) - creates it if necessary 271 * 272 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 273 * @throws HL7Exception if the repetition requested is more than one 274 * greater than the number of existing repetitions. 275 */ 276 public OUL_R23_RESULT getRESULT(int rep) { 277 OUL_R23_RESULT retVal = getTyped("RESULT", rep, OUL_R23_RESULT.class); 278 return retVal; 279 } 280 281 /** 282 * Returns the number of existing repetitions of RESULT 283 */ 284 public int getRESULTReps() { 285 return getReps("RESULT"); 286 } 287 288 /** 289 * <p> 290 * Returns a non-modifiable List containing all current existing repetitions of RESULT. 291 * <p> 292 * <p> 293 * Note that unlike {@link #getRESULT()}, this method will not create any reps 294 * if none are already present, so an empty list may be returned. 295 * </p> 296 */ 297 public java.util.List<OUL_R23_RESULT> getRESULTAll() throws HL7Exception { 298 return getAllAsList("RESULT", OUL_R23_RESULT.class); 299 } 300 301 /** 302 * Inserts a specific repetition of RESULT (a Group object) 303 * @see AbstractGroup#insertRepetition(Structure, int) 304 */ 305 public void insertRESULT(OUL_R23_RESULT structure, int rep) throws HL7Exception { 306 super.insertRepetition("RESULT", structure, rep); 307 } 308 309 310 /** 311 * Inserts a specific repetition of RESULT (a Group object) 312 * @see AbstractGroup#insertRepetition(Structure, int) 313 */ 314 public OUL_R23_RESULT insertRESULT(int rep) throws HL7Exception { 315 return (OUL_R23_RESULT)super.insertRepetition("RESULT", rep); 316 } 317 318 319 /** 320 * Removes a specific repetition of RESULT (a Group object) 321 * @see AbstractGroup#removeRepetition(String, int) 322 */ 323 public OUL_R23_RESULT removeRESULT(int rep) throws HL7Exception { 324 return (OUL_R23_RESULT)super.removeRepetition("RESULT", rep); 325 } 326 327 328 329 /** 330 * Returns 331 * the first repetition of 332 * CTI (Clinical Trial Identification) - creates it if necessary 333 */ 334 public CTI getCTI() { 335 CTI retVal = getTyped("CTI", CTI.class); 336 return retVal; 337 } 338 339 340 /** 341 * Returns a specific repetition of 342 * CTI (Clinical Trial Identification) - creates it if necessary 343 * 344 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 345 * @throws HL7Exception if the repetition requested is more than one 346 * greater than the number of existing repetitions. 347 */ 348 public CTI getCTI(int rep) { 349 CTI retVal = getTyped("CTI", rep, CTI.class); 350 return retVal; 351 } 352 353 /** 354 * Returns the number of existing repetitions of CTI 355 */ 356 public int getCTIReps() { 357 return getReps("CTI"); 358 } 359 360 /** 361 * <p> 362 * Returns a non-modifiable List containing all current existing repetitions of CTI. 363 * <p> 364 * <p> 365 * Note that unlike {@link #getCTI()}, this method will not create any reps 366 * if none are already present, so an empty list may be returned. 367 * </p> 368 */ 369 public java.util.List<CTI> getCTIAll() throws HL7Exception { 370 return getAllAsList("CTI", CTI.class); 371 } 372 373 /** 374 * Inserts a specific repetition of CTI (Clinical Trial Identification) 375 * @see AbstractGroup#insertRepetition(Structure, int) 376 */ 377 public void insertCTI(CTI structure, int rep) throws HL7Exception { 378 super.insertRepetition("CTI", structure, rep); 379 } 380 381 382 /** 383 * Inserts a specific repetition of CTI (Clinical Trial Identification) 384 * @see AbstractGroup#insertRepetition(Structure, int) 385 */ 386 public CTI insertCTI(int rep) throws HL7Exception { 387 return (CTI)super.insertRepetition("CTI", rep); 388 } 389 390 391 /** 392 * Removes a specific repetition of CTI (Clinical Trial Identification) 393 * @see AbstractGroup#removeRepetition(String, int) 394 */ 395 public CTI removeCTI(int rep) throws HL7Exception { 396 return (CTI)super.removeRepetition("CTI", rep); 397 } 398 399 400 401} 402