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