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