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 ADT_A33 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: PV1 (PATIENT VISIT) <b> </b> </li> 053 * <li>5: PV2 (PATIENT VISIT - additional information) <b>optional </b> </li> 054 * <li>6: OBX (OBSERVATION RESULT) <b>optional repeating</b> </li> 055 * </ul> 056 */ 057//@SuppressWarnings("unused") 058public class ADT_A33 extends AbstractMessage { 059 060 /** 061 * Creates a new ADT_A33 message with DefaultModelClassFactory. 062 */ 063 public ADT_A33() { 064 this(new DefaultModelClassFactory()); 065 } 066 067 /** 068 * Creates a new ADT_A33 message with custom ModelClassFactory. 069 */ 070 public ADT_A33(ModelClassFactory factory) { 071 super(factory); 072 init(factory); 073 } 074 075 private void init(ModelClassFactory factory) { 076 try { 077 this.add(MSH.class, true, false); 078 this.add(EVN.class, true, false); 079 this.add(PID.class, true, false); 080 this.add(PV1.class, true, false); 081 this.add(PV2.class, false, false); 082 this.add(OBX.class, false, true); 083 } catch(HL7Exception e) { 084 log.error("Unexpected error creating ADT_A33 - this is probably a bug in the source code generator.", e); 085 } 086 } 087 088 089 /** 090 * Returns "2.2" 091 */ 092 public String getVersion() { 093 return "2.2"; 094 } 095 096 097 098 099 /** 100 * <p> 101 * Returns 102 * MSH (MESSAGE HEADER) - creates it if necessary 103 * </p> 104 * 105 * 106 */ 107 public MSH getMSH() { 108 return getTyped("MSH", MSH.class); 109 } 110 111 112 113 114 115 /** 116 * <p> 117 * Returns 118 * EVN (EVENT TYPE) - creates it if necessary 119 * </p> 120 * 121 * 122 */ 123 public EVN getEVN() { 124 return getTyped("EVN", EVN.class); 125 } 126 127 128 129 130 131 /** 132 * <p> 133 * Returns 134 * PID (PATIENT IDENTIFICATION) - creates it if necessary 135 * </p> 136 * 137 * 138 */ 139 public PID getPID() { 140 return getTyped("PID", PID.class); 141 } 142 143 144 145 146 147 /** 148 * <p> 149 * Returns 150 * PV1 (PATIENT VISIT) - creates it if necessary 151 * </p> 152 * 153 * 154 */ 155 public PV1 getPV1() { 156 return getTyped("PV1", PV1.class); 157 } 158 159 160 161 162 163 /** 164 * <p> 165 * Returns 166 * PV2 (PATIENT VISIT - additional information) - creates it if necessary 167 * </p> 168 * 169 * 170 */ 171 public PV2 getPV2() { 172 return getTyped("PV2", PV2.class); 173 } 174 175 176 177 178 179 /** 180 * <p> 181 * Returns 182 * the first repetition of 183 * OBX (OBSERVATION RESULT) - creates it if necessary 184 * </p> 185 * 186 * 187 */ 188 public OBX getOBX() { 189 return getTyped("OBX", OBX.class); 190 } 191 192 193 /** 194 * <p> 195 * Returns a specific repetition of 196 * OBX (OBSERVATION RESULT) - creates it if necessary 197 * </p> 198 * 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 OBX getOBX(int rep) { 205 return getTyped("OBX", rep, OBX.class); 206 } 207 208 /** 209 * <p> 210 * Returns the number of existing repetitions of OBX 211 * </p> 212 * 213 */ 214 public int getOBXReps() { 215 return getReps("OBX"); 216 } 217 218 /** 219 * <p> 220 * Returns a non-modifiable List containing all current existing repetitions of OBX. 221 * <p> 222 * <p> 223 * Note that unlike {@link #getOBX()}, this method will not create any reps 224 * if none are already present, so an empty list may be returned. 225 * </p> 226 * 227 */ 228 public java.util.List<OBX> getOBXAll() throws HL7Exception { 229 return getAllAsList("OBX", OBX.class); 230 } 231 232 /** 233 * <p> 234 * Inserts a specific repetition of OBX (OBSERVATION RESULT) 235 * </p> 236 * 237 * 238 * @see AbstractGroup#insertRepetition(Structure, int) 239 */ 240 public void insertOBX(OBX structure, int rep) throws HL7Exception { 241 super.insertRepetition( "OBX", structure, rep); 242 } 243 244 245 /** 246 * <p> 247 * Inserts a specific repetition of OBX (OBSERVATION RESULT) 248 * </p> 249 * 250 * 251 * @see AbstractGroup#insertRepetition(Structure, int) 252 */ 253 public OBX insertOBX(int rep) throws HL7Exception { 254 return (OBX)super.insertRepetition("OBX", rep); 255 } 256 257 258 /** 259 * <p> 260 * Removes a specific repetition of OBX (OBSERVATION RESULT) 261 * </p> 262 * 263 * 264 * @see AbstractGroup#removeRepetition(String, int) 265 */ 266 public OBX removeOBX(int rep) throws HL7Exception { 267 return (OBX)super.removeRepetition("OBX", rep); 268 } 269 270 271 272} 273