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