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.v22.message; 035 036import ca.uhn.hl7v2.model.v22.group.*; 037import ca.uhn.hl7v2.model.v22.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 BAR_P01 message structure (see chapter ?). This structure contains the 047 * following elements: </p> 048 * <ul> 049 * <li>1: MSH (MESSAGE HEADER) <b> </b> </li> 050 * <li>2: EVN (EVENT TYPE) <b> </b> </li> 051 * <li>3: PID (PATIENT IDENTIFICATION) <b> </b> </li> 052 * <li>4: BAR_P01_VISIT (a Group object) <b> repeating</b> </li> 053 * </ul> 054 */ 055//@SuppressWarnings("unused") 056public class BAR_P01 extends AbstractMessage { 057 058 /** 059 * Creates a new BAR_P01 message with DefaultModelClassFactory. 060 */ 061 public BAR_P01() { 062 this(new DefaultModelClassFactory()); 063 } 064 065 /** 066 * Creates a new BAR_P01 message with custom ModelClassFactory. 067 */ 068 public BAR_P01(ModelClassFactory factory) { 069 super(factory); 070 init(factory); 071 } 072 073 private void init(ModelClassFactory factory) { 074 try { 075 this.add(MSH.class, true, false); 076 this.add(EVN.class, true, false); 077 this.add(PID.class, true, false); 078 this.add(BAR_P01_VISIT.class, true, true); 079 } catch(HL7Exception e) { 080 log.error("Unexpected error creating BAR_P01 - this is probably a bug in the source code generator.", e); 081 } 082 } 083 084 085 /** 086 * Returns "2.2" 087 */ 088 public String getVersion() { 089 return "2.2"; 090 } 091 092 093 094 095 /** 096 * <p> 097 * Returns 098 * MSH (MESSAGE HEADER) - creates it if necessary 099 * </p> 100 * 101 * 102 */ 103 public MSH getMSH() { 104 return getTyped("MSH", MSH.class); 105 } 106 107 108 109 110 111 /** 112 * <p> 113 * Returns 114 * EVN (EVENT TYPE) - creates it if necessary 115 * </p> 116 * 117 * 118 */ 119 public EVN getEVN() { 120 return getTyped("EVN", EVN.class); 121 } 122 123 124 125 126 127 /** 128 * <p> 129 * Returns 130 * PID (PATIENT IDENTIFICATION) - creates it if necessary 131 * </p> 132 * 133 * 134 */ 135 public PID getPID() { 136 return getTyped("PID", PID.class); 137 } 138 139 140 141 142 143 /** 144 * <p> 145 * Returns 146 * the first repetition of 147 * VISIT (a Group object) - creates it if necessary 148 * </p> 149 * 150 * 151 */ 152 public BAR_P01_VISIT getVISIT() { 153 return getTyped("VISIT", BAR_P01_VISIT.class); 154 } 155 156 157 /** 158 * <p> 159 * Returns a specific repetition of 160 * VISIT (a Group object) - creates it if necessary 161 * </p> 162 * 163 * 164 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 165 * @throws HL7Exception if the repetition requested is more than one 166 * greater than the number of existing repetitions. 167 */ 168 public BAR_P01_VISIT getVISIT(int rep) { 169 return getTyped("VISIT", rep, BAR_P01_VISIT.class); 170 } 171 172 /** 173 * <p> 174 * Returns the number of existing repetitions of VISIT 175 * </p> 176 * 177 */ 178 public int getVISITReps() { 179 return getReps("VISIT"); 180 } 181 182 /** 183 * <p> 184 * Returns a non-modifiable List containing all current existing repetitions of VISIT. 185 * <p> 186 * <p> 187 * Note that unlike {@link #getVISIT()}, this method will not create any reps 188 * if none are already present, so an empty list may be returned. 189 * </p> 190 * 191 */ 192 public java.util.List<BAR_P01_VISIT> getVISITAll() throws HL7Exception { 193 return getAllAsList("VISIT", BAR_P01_VISIT.class); 194 } 195 196 /** 197 * <p> 198 * Inserts a specific repetition of VISIT (a Group object) 199 * </p> 200 * 201 * 202 * @see AbstractGroup#insertRepetition(Structure, int) 203 */ 204 public void insertVISIT(BAR_P01_VISIT structure, int rep) throws HL7Exception { 205 super.insertRepetition( "VISIT", structure, rep); 206 } 207 208 209 /** 210 * <p> 211 * Inserts a specific repetition of VISIT (a Group object) 212 * </p> 213 * 214 * 215 * @see AbstractGroup#insertRepetition(Structure, int) 216 */ 217 public BAR_P01_VISIT insertVISIT(int rep) throws HL7Exception { 218 return (BAR_P01_VISIT)super.insertRepetition("VISIT", rep); 219 } 220 221 222 /** 223 * <p> 224 * Removes a specific repetition of VISIT (a Group object) 225 * </p> 226 * 227 * 228 * @see AbstractGroup#removeRepetition(String, int) 229 */ 230 public BAR_P01_VISIT removeVISIT(int rep) throws HL7Exception { 231 return (BAR_P01_VISIT)super.removeRepetition("VISIT", rep); 232 } 233 234 235 236} 237