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