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.v23.group; 035 036import ca.uhn.hl7v2.model.v23.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a RAS_O01_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 segment) <b> </b></li> 049 * <li>2: RAS_O01_ORDER_DETAIL (a Group object) <b>optional </b></li> 050 * <li>3: RAS_O01_ENCODING (a Group object) <b>optional </b></li> 051 * <li>4: RXA (Pharmacy administration segment) <b> repeating </b></li> 052 * <li>5: RXR (Pharmacy route segment) <b> </b></li> 053 * <li>6: RAS_O01_OBSERVATION (a Group object) <b>optional repeating </b></li> 054 * <li>7: CTI (Clinical Trial Identification) <b>optional repeating </b></li> 055 * </ul> 056 */ 057//@SuppressWarnings("unused") 058public class RAS_O01_ORDER extends AbstractGroup { 059 060 /** 061 * Creates a new RAS_O01_ORDER group 062 */ 063 public RAS_O01_ORDER(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, true, false, false); 071 this.add(RAS_O01_ORDER_DETAIL.class, false, false, false); 072 this.add(RAS_O01_ENCODING.class, false, false, false); 073 this.add(RXA.class, true, true, false); 074 this.add(RXR.class, true, false, false); 075 this.add(RAS_O01_OBSERVATION.class, false, true, false); 076 this.add(CTI.class, false, true, false); 077 } catch(HL7Exception e) { 078 log.error("Unexpected error creating RAS_O01_ORDER - this is probably a bug in the source code generator.", e); 079 } 080 } 081 082 /** 083 * Returns "2.3" 084 */ 085 public String getVersion() { 086 return "2.3"; 087 } 088 089 090 091 /** 092 * Returns 093 * ORC (Common order segment) - 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 * ORDER_DETAIL (a Group object) - creates it if necessary 106 */ 107 public RAS_O01_ORDER_DETAIL getORDER_DETAIL() { 108 RAS_O01_ORDER_DETAIL retVal = getTyped("ORDER_DETAIL", RAS_O01_ORDER_DETAIL.class); 109 return retVal; 110 } 111 112 113 114 115 /** 116 * Returns 117 * ENCODING (a Group object) - creates it if necessary 118 */ 119 public RAS_O01_ENCODING getENCODING() { 120 RAS_O01_ENCODING retVal = getTyped("ENCODING", RAS_O01_ENCODING.class); 121 return retVal; 122 } 123 124 125 126 127 /** 128 * Returns 129 * the first repetition of 130 * RXA (Pharmacy administration segment) - creates it if necessary 131 */ 132 public RXA getRXA() { 133 RXA retVal = getTyped("RXA", RXA.class); 134 return retVal; 135 } 136 137 138 /** 139 * Returns a specific repetition of 140 * RXA (Pharmacy administration segment) - creates it if necessary 141 * 142 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 143 * @throws HL7Exception if the repetition requested is more than one 144 * greater than the number of existing repetitions. 145 */ 146 public RXA getRXA(int rep) { 147 RXA retVal = getTyped("RXA", rep, RXA.class); 148 return retVal; 149 } 150 151 /** 152 * Returns the number of existing repetitions of RXA 153 */ 154 public int getRXAReps() { 155 return getReps("RXA"); 156 } 157 158 /** 159 * <p> 160 * Returns a non-modifiable List containing all current existing repetitions of RXA. 161 * <p> 162 * <p> 163 * Note that unlike {@link #getRXA()}, this method will not create any reps 164 * if none are already present, so an empty list may be returned. 165 * </p> 166 */ 167 public java.util.List<RXA> getRXAAll() throws HL7Exception { 168 return getAllAsList("RXA", RXA.class); 169 } 170 171 /** 172 * Inserts a specific repetition of RXA (Pharmacy administration segment) 173 * @see AbstractGroup#insertRepetition(Structure, int) 174 */ 175 public void insertRXA(RXA structure, int rep) throws HL7Exception { 176 super.insertRepetition("RXA", structure, rep); 177 } 178 179 180 /** 181 * Inserts a specific repetition of RXA (Pharmacy administration segment) 182 * @see AbstractGroup#insertRepetition(Structure, int) 183 */ 184 public RXA insertRXA(int rep) throws HL7Exception { 185 return (RXA)super.insertRepetition("RXA", rep); 186 } 187 188 189 /** 190 * Removes a specific repetition of RXA (Pharmacy administration segment) 191 * @see AbstractGroup#removeRepetition(String, int) 192 */ 193 public RXA removeRXA(int rep) throws HL7Exception { 194 return (RXA)super.removeRepetition("RXA", rep); 195 } 196 197 198 199 /** 200 * Returns 201 * RXR (Pharmacy route segment) - creates it if necessary 202 */ 203 public RXR getRXR() { 204 RXR retVal = getTyped("RXR", RXR.class); 205 return retVal; 206 } 207 208 209 210 211 /** 212 * Returns 213 * the first repetition of 214 * OBSERVATION (a Group object) - creates it if necessary 215 */ 216 public RAS_O01_OBSERVATION getOBSERVATION() { 217 RAS_O01_OBSERVATION retVal = getTyped("OBSERVATION", RAS_O01_OBSERVATION.class); 218 return retVal; 219 } 220 221 222 /** 223 * Returns a specific repetition of 224 * OBSERVATION (a Group object) - creates it if necessary 225 * 226 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 227 * @throws HL7Exception if the repetition requested is more than one 228 * greater than the number of existing repetitions. 229 */ 230 public RAS_O01_OBSERVATION getOBSERVATION(int rep) { 231 RAS_O01_OBSERVATION retVal = getTyped("OBSERVATION", rep, RAS_O01_OBSERVATION.class); 232 return retVal; 233 } 234 235 /** 236 * Returns the number of existing repetitions of OBSERVATION 237 */ 238 public int getOBSERVATIONReps() { 239 return getReps("OBSERVATION"); 240 } 241 242 /** 243 * <p> 244 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION. 245 * <p> 246 * <p> 247 * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps 248 * if none are already present, so an empty list may be returned. 249 * </p> 250 */ 251 public java.util.List<RAS_O01_OBSERVATION> getOBSERVATIONAll() throws HL7Exception { 252 return getAllAsList("OBSERVATION", RAS_O01_OBSERVATION.class); 253 } 254 255 /** 256 * Inserts a specific repetition of OBSERVATION (a Group object) 257 * @see AbstractGroup#insertRepetition(Structure, int) 258 */ 259 public void insertOBSERVATION(RAS_O01_OBSERVATION structure, int rep) throws HL7Exception { 260 super.insertRepetition("OBSERVATION", structure, rep); 261 } 262 263 264 /** 265 * Inserts a specific repetition of OBSERVATION (a Group object) 266 * @see AbstractGroup#insertRepetition(Structure, int) 267 */ 268 public RAS_O01_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 269 return (RAS_O01_OBSERVATION)super.insertRepetition("OBSERVATION", rep); 270 } 271 272 273 /** 274 * Removes a specific repetition of OBSERVATION (a Group object) 275 * @see AbstractGroup#removeRepetition(String, int) 276 */ 277 public RAS_O01_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 278 return (RAS_O01_OBSERVATION)super.removeRepetition("OBSERVATION", rep); 279 } 280 281 282 283 /** 284 * Returns 285 * the first repetition of 286 * CTI (Clinical Trial Identification) - creates it if necessary 287 */ 288 public CTI getCTI() { 289 CTI retVal = getTyped("CTI", CTI.class); 290 return retVal; 291 } 292 293 294 /** 295 * Returns a specific repetition of 296 * CTI (Clinical Trial Identification) - creates it if necessary 297 * 298 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 299 * @throws HL7Exception if the repetition requested is more than one 300 * greater than the number of existing repetitions. 301 */ 302 public CTI getCTI(int rep) { 303 CTI retVal = getTyped("CTI", rep, CTI.class); 304 return retVal; 305 } 306 307 /** 308 * Returns the number of existing repetitions of CTI 309 */ 310 public int getCTIReps() { 311 return getReps("CTI"); 312 } 313 314 /** 315 * <p> 316 * Returns a non-modifiable List containing all current existing repetitions of CTI. 317 * <p> 318 * <p> 319 * Note that unlike {@link #getCTI()}, this method will not create any reps 320 * if none are already present, so an empty list may be returned. 321 * </p> 322 */ 323 public java.util.List<CTI> getCTIAll() throws HL7Exception { 324 return getAllAsList("CTI", CTI.class); 325 } 326 327 /** 328 * Inserts a specific repetition of CTI (Clinical Trial Identification) 329 * @see AbstractGroup#insertRepetition(Structure, int) 330 */ 331 public void insertCTI(CTI structure, int rep) throws HL7Exception { 332 super.insertRepetition("CTI", structure, rep); 333 } 334 335 336 /** 337 * Inserts a specific repetition of CTI (Clinical Trial Identification) 338 * @see AbstractGroup#insertRepetition(Structure, int) 339 */ 340 public CTI insertCTI(int rep) throws HL7Exception { 341 return (CTI)super.insertRepetition("CTI", rep); 342 } 343 344 345 /** 346 * Removes a specific repetition of CTI (Clinical Trial Identification) 347 * @see AbstractGroup#removeRepetition(String, int) 348 */ 349 public CTI removeCTI(int rep) throws HL7Exception { 350 return (CTI)super.removeRepetition("CTI", rep); 351 } 352 353 354 355} 356