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