1 /* 2 * This class is an auto-generated source file for a HAPI 3 * HL7 v2.x standard structure class. 4 * 5 * For more information, visit: http://hl7api.sourceforge.net/ 6 * 7 * The contents of this file are subject to the Mozilla Public License Version 1.1 8 * (the "License"); you may not use this file except in compliance with the License. 9 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 10 * Software distributed under the License is distributed on an "AS IS" basis, 11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 12 * specific language governing rights and limitations under the License. 13 * 14 * The Original Code is "[file_name]". Description: 15 * "[one_line_description]" 16 * 17 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 18 * 2012. All Rights Reserved. 19 * 20 * Contributor(s): ______________________________________. 21 * 22 * Alternatively, the contents of this file may be used under the terms of the 23 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are 24 * applicable instead of those above. If you wish to allow use of your version of this 25 * file only under the terms of the GPL and not to allow others to use your version 26 * of this file under the MPL, indicate your decision by deleting the provisions above 27 * and replace them with the notice and other provisions required by the GPL License. 28 * If you do not delete the provisions above, a recipient may use your version of 29 * this file under either the MPL or the GPL. 30 * 31 */ 32 33 34 package ca.uhn.hl7v2.model.v24.message; 35 36 import ca.uhn.hl7v2.model.v24.group.*; 37 import ca.uhn.hl7v2.model.v24.segment.*; 38 39 import ca.uhn.hl7v2.HL7Exception; 40 import ca.uhn.hl7v2.parser.ModelClassFactory; 41 import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 42 import ca.uhn.hl7v2.model.*; 43 44 45 /** 46 * <p>Represents a BAR_P10 message structure (see chapter 6). This structure contains the 47 * following elements: </p> 48 * <ul> 49 * <li>1: MSH (Message Header) <b> </b> </li> 50 * <li>2: EVN (Event Type) <b> </b> </li> 51 * <li>3: PID (Patient identification) <b> </b> </li> 52 * <li>4: PV1 (Patient visit) <b> </b> </li> 53 * <li>5: DG1 (Diagnosis) <b>optional repeating</b> </li> 54 * <li>6: GP1 (Grouping/Reimbursement - Visit) <b> </b> </li> 55 * <li>7: BAR_P10_PROCEDURE (a Group object) <b>optional repeating</b> </li> 56 * </ul> 57 */ 58 //@SuppressWarnings("unused") 59 public class BAR_P10 extends AbstractMessage { 60 61 /** 62 * Creates a new BAR_P10 message with DefaultModelClassFactory. 63 */ 64 public BAR_P10() { 65 this(new DefaultModelClassFactory()); 66 } 67 68 /** 69 * Creates a new BAR_P10 message with custom ModelClassFactory. 70 */ 71 public BAR_P10(ModelClassFactory factory) { 72 super(factory); 73 init(factory); 74 } 75 76 private void init(ModelClassFactory factory) { 77 try { 78 this.add(MSH.class, true, false); 79 this.add(EVN.class, true, false); 80 this.add(PID.class, true, false); 81 this.add(PV1.class, true, false); 82 this.add(DG1.class, false, true); 83 this.add(GP1.class, true, false); 84 this.add(BAR_P10_PROCEDURE.class, false, true); 85 } catch(HL7Exception e) { 86 log.error("Unexpected error creating BAR_P10 - this is probably a bug in the source code generator.", e); 87 } 88 } 89 90 91 /** 92 * Returns "2.4" 93 */ 94 public String getVersion() { 95 return "2.4"; 96 } 97 98 99 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 * EVN (Event Type) - creates it if necessary 121 * </p> 122 * 123 * 124 */ 125 public EVN getEVN() { 126 return getTyped("EVN", EVN.class); 127 } 128 129 130 131 132 133 /** 134 * <p> 135 * Returns 136 * PID (Patient identification) - creates it if necessary 137 * </p> 138 * 139 * 140 */ 141 public PID getPID() { 142 return getTyped("PID", PID.class); 143 } 144 145 146 147 148 149 /** 150 * <p> 151 * Returns 152 * PV1 (Patient visit) - creates it if necessary 153 * </p> 154 * 155 * 156 */ 157 public PV1 getPV1() { 158 return getTyped("PV1", PV1.class); 159 } 160 161 162 163 164 165 /** 166 * <p> 167 * Returns 168 * the first repetition of 169 * DG1 (Diagnosis) - creates it if necessary 170 * </p> 171 * 172 * 173 */ 174 public DG1 getDG1() { 175 return getTyped("DG1", DG1.class); 176 } 177 178 179 /** 180 * <p> 181 * Returns a specific repetition of 182 * DG1 (Diagnosis) - creates it if necessary 183 * </p> 184 * 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 DG1 getDG1(int rep) { 191 return getTyped("DG1", rep, DG1.class); 192 } 193 194 /** 195 * <p> 196 * Returns the number of existing repetitions of DG1 197 * </p> 198 * 199 */ 200 public int getDG1Reps() { 201 return getReps("DG1"); 202 } 203 204 /** 205 * <p> 206 * Returns a non-modifiable List containing all current existing repetitions of DG1. 207 * <p> 208 * <p> 209 * Note that unlike {@link #getDG1()}, this method will not create any reps 210 * if none are already present, so an empty list may be returned. 211 * </p> 212 * 213 */ 214 public java.util.List<DG1> getDG1All() throws HL7Exception { 215 return getAllAsList("DG1", DG1.class); 216 } 217 218 /** 219 * <p> 220 * Inserts a specific repetition of DG1 (Diagnosis) 221 * </p> 222 * 223 * 224 * @see AbstractGroup#insertRepetition(Structure, int) 225 */ 226 public void insertDG1(DG1 structure, int rep) throws HL7Exception { 227 super.insertRepetition( "DG1", structure, rep); 228 } 229 230 231 /** 232 * <p> 233 * Inserts a specific repetition of DG1 (Diagnosis) 234 * </p> 235 * 236 * 237 * @see AbstractGroup#insertRepetition(Structure, int) 238 */ 239 public DG1 insertDG1(int rep) throws HL7Exception { 240 return (DG1)super.insertRepetition("DG1", rep); 241 } 242 243 244 /** 245 * <p> 246 * Removes a specific repetition of DG1 (Diagnosis) 247 * </p> 248 * 249 * 250 * @see AbstractGroup#removeRepetition(String, int) 251 */ 252 public DG1 removeDG1(int rep) throws HL7Exception { 253 return (DG1)super.removeRepetition("DG1", rep); 254 } 255 256 257 258 259 /** 260 * <p> 261 * Returns 262 * GP1 (Grouping/Reimbursement - Visit) - creates it if necessary 263 * </p> 264 * 265 * 266 */ 267 public GP1 getGP1() { 268 return getTyped("GP1", GP1.class); 269 } 270 271 272 273 274 275 /** 276 * <p> 277 * Returns 278 * the first repetition of 279 * PROCEDURE (a Group object) - creates it if necessary 280 * </p> 281 * 282 * 283 */ 284 public BAR_P10_PROCEDURE getPROCEDURE() { 285 return getTyped("PROCEDURE", BAR_P10_PROCEDURE.class); 286 } 287 288 289 /** 290 * <p> 291 * Returns a specific repetition of 292 * PROCEDURE (a Group object) - creates it if necessary 293 * </p> 294 * 295 * 296 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 297 * @throws HL7Exception if the repetition requested is more than one 298 * greater than the number of existing repetitions. 299 */ 300 public BAR_P10_PROCEDURE getPROCEDURE(int rep) { 301 return getTyped("PROCEDURE", rep, BAR_P10_PROCEDURE.class); 302 } 303 304 /** 305 * <p> 306 * Returns the number of existing repetitions of PROCEDURE 307 * </p> 308 * 309 */ 310 public int getPROCEDUREReps() { 311 return getReps("PROCEDURE"); 312 } 313 314 /** 315 * <p> 316 * Returns a non-modifiable List containing all current existing repetitions of PROCEDURE. 317 * <p> 318 * <p> 319 * Note that unlike {@link #getPROCEDURE()}, this method will not create any reps 320 * if none are already present, so an empty list may be returned. 321 * </p> 322 * 323 */ 324 public java.util.List<BAR_P10_PROCEDURE> getPROCEDUREAll() throws HL7Exception { 325 return getAllAsList("PROCEDURE", BAR_P10_PROCEDURE.class); 326 } 327 328 /** 329 * <p> 330 * Inserts a specific repetition of PROCEDURE (a Group object) 331 * </p> 332 * 333 * 334 * @see AbstractGroup#insertRepetition(Structure, int) 335 */ 336 public void insertPROCEDURE(BAR_P10_PROCEDURE structure, int rep) throws HL7Exception { 337 super.insertRepetition( "PROCEDURE", structure, rep); 338 } 339 340 341 /** 342 * <p> 343 * Inserts a specific repetition of PROCEDURE (a Group object) 344 * </p> 345 * 346 * 347 * @see AbstractGroup#insertRepetition(Structure, int) 348 */ 349 public BAR_P10_PROCEDURE insertPROCEDURE(int rep) throws HL7Exception { 350 return (BAR_P10_PROCEDURE)super.insertRepetition("PROCEDURE", rep); 351 } 352 353 354 /** 355 * <p> 356 * Removes a specific repetition of PROCEDURE (a Group object) 357 * </p> 358 * 359 * 360 * @see AbstractGroup#removeRepetition(String, int) 361 */ 362 public BAR_P10_PROCEDURE removePROCEDURE(int rep) throws HL7Exception { 363 return (BAR_P10_PROCEDURE)super.removeRepetition("PROCEDURE", rep); 364 } 365 366 367 368 } 369