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 java.util.List; 039 040import ca.uhn.hl7v2.HL7Exception; 041import ca.uhn.hl7v2.parser.ModelClassFactory; 042import ca.uhn.hl7v2.model.*; 043 044/** 045 * <p>Represents a OMN_O07_ORDER group structure (a Group object). 046 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. 047 * This Group contains the following elements: 048 * </p> 049 * <ul> 050 * <li>1: ORC (Common Order) <b> </b></li> 051 * <li>2: OMN_O07_TIMING (a Group object) <b>optional repeating</b></li> 052 * <li>3: RQD (Requisition Detail) <b> </b></li> 053 * <li>4: RQ1 (Requisition Detail-1) <b>optional </b></li> 054 * <li>5: NTE (Notes and Comments) <b>optional repeating</b></li> 055 * <li>6: OMN_O07_OBSERVATION (a Group object) <b>optional repeating</b></li> 056 * <li>7: BLG (Billing) <b>optional </b></li> 057 * </ul> 058 */ 059@SuppressWarnings("unused") 060public class OMN_O07_ORDER extends AbstractGroup { 061 062 /** 063 * Creates a new OMN_O07_ORDER group 064 */ 065 public OMN_O07_ORDER(Group parent, ModelClassFactory factory) { 066 super(parent, factory); 067 init(factory); 068 } 069 070 private void init(ModelClassFactory factory) { 071 try { 072 this.add(ORC.class, true, false); 073 this.add(OMN_O07_TIMING.class, false, true); 074 this.add(RQD.class, true, false); 075 this.add(RQ1.class, false, false); 076 this.add(NTE.class, false, true); 077 this.add(OMN_O07_OBSERVATION.class, false, true); 078 this.add(BLG.class, false, false); 079 } catch(HL7Exception e) { 080 log.error("Unexpected error creating OMN_O07_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 OMN_O07_TIMING getTIMING() { 111 OMN_O07_TIMING retVal = getTyped("TIMING", OMN_O07_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 OMN_O07_TIMING getTIMING(int rep) { 125 OMN_O07_TIMING retVal = getTyped("TIMING", rep, OMN_O07_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 List<OMN_O07_TIMING> getTIMINGAll() throws HL7Exception { 146 return getAllAsList("TIMING", OMN_O07_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(OMN_O07_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 OMN_O07_TIMING insertTIMING(int rep) throws HL7Exception { 163 return (OMN_O07_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 OMN_O07_TIMING removeTIMING(int rep) throws HL7Exception { 172 return (OMN_O07_TIMING)super.removeRepetition("TIMING", rep); 173 } 174 175 176 177 /** 178 * Returns 179 * RQD (Requisition Detail) - creates it if necessary 180 */ 181 public RQD getRQD() { 182 RQD retVal = getTyped("RQD", RQD.class); 183 return retVal; 184 } 185 186 187 188 189 /** 190 * Returns 191 * RQ1 (Requisition Detail-1) - creates it if necessary 192 */ 193 public RQ1 getRQ1() { 194 RQ1 retVal = getTyped("RQ1", RQ1.class); 195 return retVal; 196 } 197 198 199 200 201 /** 202 * Returns 203 * the first repetition of 204 * NTE (Notes and Comments) - creates it if necessary 205 */ 206 public NTE getNTE() { 207 NTE retVal = getTyped("NTE", NTE.class); 208 return retVal; 209 } 210 211 212 /** 213 * Returns a specific repetition of 214 * NTE (Notes and Comments) - creates it if necessary 215 * 216 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 217 * @throws HL7Exception if the repetition requested is more than one 218 * greater than the number of existing repetitions. 219 */ 220 public NTE getNTE(int rep) { 221 NTE retVal = getTyped("NTE", rep, NTE.class); 222 return retVal; 223 } 224 225 /** 226 * Returns the number of existing repetitions of NTE 227 */ 228 public int getNTEReps() { 229 return getReps("NTE"); 230 } 231 232 /** 233 * <p> 234 * Returns a non-modifiable List containing all current existing repetitions of NTE. 235 * <p> 236 * <p> 237 * Note that unlike {@link #getNTE()}, this method will not create any reps 238 * if none are already present, so an empty list may be returned. 239 * </p> 240 */ 241 public List<NTE> getNTEAll() throws HL7Exception { 242 return getAllAsList("NTE", NTE.class); 243 } 244 245 /** 246 * Inserts a specific repetition of NTE (Notes and Comments) 247 * @see AbstractGroup#insertRepetition(Structure, int) 248 */ 249 public void insertNTE(NTE structure, int rep) throws HL7Exception { 250 super.insertRepetition("NTE", structure, rep); 251 } 252 253 254 /** 255 * Inserts a specific repetition of NTE (Notes and Comments) 256 * @see AbstractGroup#insertRepetition(Structure, int) 257 */ 258 public NTE insertNTE(int rep) throws HL7Exception { 259 return (NTE)super.insertRepetition("NTE", rep); 260 } 261 262 263 /** 264 * Removes a specific repetition of NTE (Notes and Comments) 265 * @see AbstractGroup#removeRepetition(String, int) 266 */ 267 public NTE removeNTE(int rep) throws HL7Exception { 268 return (NTE)super.removeRepetition("NTE", rep); 269 } 270 271 272 273 /** 274 * Returns 275 * the first repetition of 276 * OBSERVATION (a Group object) - creates it if necessary 277 */ 278 public OMN_O07_OBSERVATION getOBSERVATION() { 279 OMN_O07_OBSERVATION retVal = getTyped("OBSERVATION", OMN_O07_OBSERVATION.class); 280 return retVal; 281 } 282 283 284 /** 285 * Returns a specific repetition of 286 * OBSERVATION (a Group object) - 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 OMN_O07_OBSERVATION getOBSERVATION(int rep) { 293 OMN_O07_OBSERVATION retVal = getTyped("OBSERVATION", rep, OMN_O07_OBSERVATION.class); 294 return retVal; 295 } 296 297 /** 298 * Returns the number of existing repetitions of OBSERVATION 299 */ 300 public int getOBSERVATIONReps() { 301 return getReps("OBSERVATION"); 302 } 303 304 /** 305 * <p> 306 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION. 307 * <p> 308 * <p> 309 * Note that unlike {@link #getOBSERVATION()}, 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 List<OMN_O07_OBSERVATION> getOBSERVATIONAll() throws HL7Exception { 314 return getAllAsList("OBSERVATION", OMN_O07_OBSERVATION.class); 315 } 316 317 /** 318 * Inserts a specific repetition of OBSERVATION (a Group object) 319 * @see AbstractGroup#insertRepetition(Structure, int) 320 */ 321 public void insertOBSERVATION(OMN_O07_OBSERVATION structure, int rep) throws HL7Exception { 322 super.insertRepetition("OBSERVATION", structure, rep); 323 } 324 325 326 /** 327 * Inserts a specific repetition of OBSERVATION (a Group object) 328 * @see AbstractGroup#insertRepetition(Structure, int) 329 */ 330 public OMN_O07_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 331 return (OMN_O07_OBSERVATION)super.insertRepetition("OBSERVATION", rep); 332 } 333 334 335 /** 336 * Removes a specific repetition of OBSERVATION (a Group object) 337 * @see AbstractGroup#removeRepetition(String, int) 338 */ 339 public OMN_O07_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 340 return (OMN_O07_OBSERVATION)super.removeRepetition("OBSERVATION", rep); 341 } 342 343 344 345 /** 346 * Returns 347 * BLG (Billing) - creates it if necessary 348 */ 349 public BLG getBLG() { 350 BLG retVal = getTyped("BLG", BLG.class); 351 return retVal; 352 } 353 354 355 356 357} 358