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