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 EHC_E01_PROCEDURE 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: PR1 (Procedures) <b> choice</b></li> 049 * <li>2: NTE (Notes and Comments) <b>optional repeating choice</b></li> 050 * <li>3: PRT (Participation Information) <b>optional repeating choice</b></li> 051 * <li>4: ROL (Role) <b>optional repeating choice</b></li> 052 * </ul> 053 * <p> 054 * Note that this structure has "choice" elements. This means that one of the 055 * structures above marked as "choice" must be present, but no more than one. 056 * </p> 057 */ 058//@SuppressWarnings("unused") 059public class EHC_E01_PROCEDURE extends AbstractGroup { 060 061 /** 062 * Creates a new EHC_E01_PROCEDURE group 063 */ 064 public EHC_E01_PROCEDURE(Group parent, ModelClassFactory factory) { 065 super(parent, factory); 066 init(factory); 067 } 068 069 private void init(ModelClassFactory factory) { 070 try { 071 this.add(PR1.class, true, false, true); 072 this.add(NTE.class, false, true, true); 073 this.add(PRT.class, false, true, true); 074 this.add(ROL.class, false, true, true); 075 } catch(HL7Exception e) { 076 log.error("Unexpected error creating EHC_E01_PROCEDURE - this is probably a bug in the source code generator.", e); 077 } 078 } 079 080 /** 081 * Returns "2.8" 082 */ 083 public String getVersion() { 084 return "2.8"; 085 } 086 087 088 089 /** 090 * Returns 091 * PR1 (Procedures) - creates it if necessary 092 */ 093 public PR1 getPR1() { 094 PR1 retVal = getTyped("PR1", PR1.class); 095 return retVal; 096 } 097 098 099 100 101 /** 102 * Returns 103 * the first repetition of 104 * NTE (Notes and Comments) - creates it if necessary 105 */ 106 public NTE getNTE() { 107 NTE retVal = getTyped("NTE", NTE.class); 108 return retVal; 109 } 110 111 112 /** 113 * Returns a specific repetition of 114 * NTE (Notes and Comments) - creates it if necessary 115 * 116 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 117 * @throws HL7Exception if the repetition requested is more than one 118 * greater than the number of existing repetitions. 119 */ 120 public NTE getNTE(int rep) { 121 NTE retVal = getTyped("NTE", rep, NTE.class); 122 return retVal; 123 } 124 125 /** 126 * Returns the number of existing repetitions of NTE 127 */ 128 public int getNTEReps() { 129 return getReps("NTE"); 130 } 131 132 /** 133 * <p> 134 * Returns a non-modifiable List containing all current existing repetitions of NTE. 135 * <p> 136 * <p> 137 * Note that unlike {@link #getNTE()}, this method will not create any reps 138 * if none are already present, so an empty list may be returned. 139 * </p> 140 */ 141 public java.util.List<NTE> getNTEAll() throws HL7Exception { 142 return getAllAsList("NTE", NTE.class); 143 } 144 145 /** 146 * Inserts a specific repetition of NTE (Notes and Comments) 147 * @see AbstractGroup#insertRepetition(Structure, int) 148 */ 149 public void insertNTE(NTE structure, int rep) throws HL7Exception { 150 super.insertRepetition("NTE", structure, rep); 151 } 152 153 154 /** 155 * Inserts a specific repetition of NTE (Notes and Comments) 156 * @see AbstractGroup#insertRepetition(Structure, int) 157 */ 158 public NTE insertNTE(int rep) throws HL7Exception { 159 return (NTE)super.insertRepetition("NTE", rep); 160 } 161 162 163 /** 164 * Removes a specific repetition of NTE (Notes and Comments) 165 * @see AbstractGroup#removeRepetition(String, int) 166 */ 167 public NTE removeNTE(int rep) throws HL7Exception { 168 return (NTE)super.removeRepetition("NTE", rep); 169 } 170 171 172 173 /** 174 * Returns 175 * the first repetition of 176 * PRT (Participation Information) - creates it if necessary 177 */ 178 public PRT getPRT() { 179 PRT retVal = getTyped("PRT", PRT.class); 180 return retVal; 181 } 182 183 184 /** 185 * Returns a specific repetition of 186 * PRT (Participation Information) - creates it if necessary 187 * 188 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 189 * @throws HL7Exception if the repetition requested is more than one 190 * greater than the number of existing repetitions. 191 */ 192 public PRT getPRT(int rep) { 193 PRT retVal = getTyped("PRT", rep, PRT.class); 194 return retVal; 195 } 196 197 /** 198 * Returns the number of existing repetitions of PRT 199 */ 200 public int getPRTReps() { 201 return getReps("PRT"); 202 } 203 204 /** 205 * <p> 206 * Returns a non-modifiable List containing all current existing repetitions of PRT. 207 * <p> 208 * <p> 209 * Note that unlike {@link #getPRT()}, this method will not create any reps 210 * if none are already present, so an empty list may be returned. 211 * </p> 212 */ 213 public java.util.List<PRT> getPRTAll() throws HL7Exception { 214 return getAllAsList("PRT", PRT.class); 215 } 216 217 /** 218 * Inserts a specific repetition of PRT (Participation Information) 219 * @see AbstractGroup#insertRepetition(Structure, int) 220 */ 221 public void insertPRT(PRT structure, int rep) throws HL7Exception { 222 super.insertRepetition("PRT", structure, rep); 223 } 224 225 226 /** 227 * Inserts a specific repetition of PRT (Participation Information) 228 * @see AbstractGroup#insertRepetition(Structure, int) 229 */ 230 public PRT insertPRT(int rep) throws HL7Exception { 231 return (PRT)super.insertRepetition("PRT", rep); 232 } 233 234 235 /** 236 * Removes a specific repetition of PRT (Participation Information) 237 * @see AbstractGroup#removeRepetition(String, int) 238 */ 239 public PRT removePRT(int rep) throws HL7Exception { 240 return (PRT)super.removeRepetition("PRT", rep); 241 } 242 243 244 245 /** 246 * Returns 247 * the first repetition of 248 * ROL (Role) - creates it if necessary 249 */ 250 public ROL getROL() { 251 ROL retVal = getTyped("ROL", ROL.class); 252 return retVal; 253 } 254 255 256 /** 257 * Returns a specific repetition of 258 * ROL (Role) - creates it if necessary 259 * 260 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 261 * @throws HL7Exception if the repetition requested is more than one 262 * greater than the number of existing repetitions. 263 */ 264 public ROL getROL(int rep) { 265 ROL retVal = getTyped("ROL", rep, ROL.class); 266 return retVal; 267 } 268 269 /** 270 * Returns the number of existing repetitions of ROL 271 */ 272 public int getROLReps() { 273 return getReps("ROL"); 274 } 275 276 /** 277 * <p> 278 * Returns a non-modifiable List containing all current existing repetitions of ROL. 279 * <p> 280 * <p> 281 * Note that unlike {@link #getROL()}, this method will not create any reps 282 * if none are already present, so an empty list may be returned. 283 * </p> 284 */ 285 public java.util.List<ROL> getROLAll() throws HL7Exception { 286 return getAllAsList("ROL", ROL.class); 287 } 288 289 /** 290 * Inserts a specific repetition of ROL (Role) 291 * @see AbstractGroup#insertRepetition(Structure, int) 292 */ 293 public void insertROL(ROL structure, int rep) throws HL7Exception { 294 super.insertRepetition("ROL", structure, rep); 295 } 296 297 298 /** 299 * Inserts a specific repetition of ROL (Role) 300 * @see AbstractGroup#insertRepetition(Structure, int) 301 */ 302 public ROL insertROL(int rep) throws HL7Exception { 303 return (ROL)super.insertRepetition("ROL", rep); 304 } 305 306 307 /** 308 * Removes a specific repetition of ROL (Role) 309 * @see AbstractGroup#removeRepetition(String, int) 310 */ 311 public ROL removeROL(int rep) throws HL7Exception { 312 return (ROL)super.removeRepetition("ROL", rep); 313 } 314 315 316 317} 318