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