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.v25.message;
035
036import ca.uhn.hl7v2.model.v25.group.*;
037import ca.uhn.hl7v2.model.v25.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_A52 message structure (see chapter 3.3.52). This structure contains the 
047 * following elements: </p>
048 * <ul>
049                                 * <li>1: MSH (Message Header) <b> </b> </li>
050                                 * <li>2: SFT (Software Segment) <b>optional repeating</b> </li>
051                                 * <li>3: EVN (Event Type) <b> </b> </li>
052                                 * <li>4: PID (Patient Identification) <b> </b> </li>
053                                 * <li>5: PD1 (Patient Additional Demographic) <b>optional </b> </li>
054                                 * <li>6: PV1 (Patient Visit) <b> </b> </li>
055                                 * <li>7: PV2 (Patient Visit - Additional Information) <b>optional </b> </li>
056 * </ul>
057 */
058//@SuppressWarnings("unused")
059public class ADT_A52 extends AbstractMessage  {
060
061    /**
062     * Creates a new ADT_A52 message with DefaultModelClassFactory. 
063     */ 
064    public ADT_A52() { 
065       this(new DefaultModelClassFactory());
066    }
067
068    /** 
069     * Creates a new ADT_A52 message with custom ModelClassFactory.
070     */
071    public ADT_A52(ModelClassFactory factory) {
072       super(factory);
073       init(factory);
074    }
075
076    private void init(ModelClassFactory factory) {
077       try {
078                          this.add(MSH.class, true, false);
079                                  this.add(SFT.class, false, true);
080                                  this.add(EVN.class, true, false);
081                                  this.add(PID.class, true, false);
082                                  this.add(PD1.class, false, false);
083                                  this.add(PV1.class, true, false);
084                                  this.add(PV2.class, false, false);
085               } catch(HL7Exception e) {
086          log.error("Unexpected error creating ADT_A52 - this is probably a bug in the source code generator.", e);
087       }
088    }
089
090
091    /** 
092     * Returns "2.5"
093     */
094    public String getVersion() {
095       return "2.5";
096    }
097
098
099
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     * the first repetition of 
121     * SFT (Software Segment) - creates it if necessary
122     * </p>
123     * 
124     *
125     */
126    public SFT getSFT() { 
127       return getTyped("SFT", SFT.class);
128    }
129
130
131    /**
132     * <p>
133     * Returns a specific repetition of
134     * SFT (Software Segment) - creates it if necessary
135     * </p>
136     * 
137     *
138     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
139     * @throws HL7Exception if the repetition requested is more than one 
140     *     greater than the number of existing repetitions.
141     */
142    public SFT getSFT(int rep) { 
143       return getTyped("SFT", rep, SFT.class);
144    }
145
146    /** 
147     * <p>
148     * Returns the number of existing repetitions of SFT 
149     * </p>
150     * 
151     */ 
152    public int getSFTReps() { 
153        return getReps("SFT");
154    } 
155
156    /** 
157     * <p>
158     * Returns a non-modifiable List containing all current existing repetitions of SFT.
159     * <p>
160     * <p>
161     * Note that unlike {@link #getSFT()}, this method will not create any reps
162     * if none are already present, so an empty list may be returned.
163     * </p>
164     * 
165     */ 
166    public java.util.List<SFT> getSFTAll() throws HL7Exception {
167        return getAllAsList("SFT", SFT.class);
168    } 
169
170    /**
171     * <p>
172     * Inserts a specific repetition of SFT (Software Segment)
173     * </p>
174     * 
175     *
176     * @see AbstractGroup#insertRepetition(Structure, int) 
177     */
178    public void insertSFT(SFT structure, int rep) throws HL7Exception { 
179       super.insertRepetition( "SFT", structure, rep);
180    }
181
182
183    /**
184     * <p>
185     * Inserts a specific repetition of SFT (Software Segment)
186     * </p>
187     * 
188     *
189     * @see AbstractGroup#insertRepetition(Structure, int) 
190     */
191    public SFT insertSFT(int rep) throws HL7Exception { 
192       return (SFT)super.insertRepetition("SFT", rep);
193    }
194
195
196    /**
197     * <p>
198     * Removes a specific repetition of SFT (Software Segment)
199     * </p>
200     * 
201     *
202     * @see AbstractGroup#removeRepetition(String, int) 
203     */
204    public SFT removeSFT(int rep) throws HL7Exception { 
205       return (SFT)super.removeRepetition("SFT", rep);
206    }
207
208
209
210
211    /**
212     * <p>
213     * Returns
214     * EVN (Event Type) - creates it if necessary
215     * </p>
216     * 
217     *
218     */
219    public EVN getEVN() { 
220       return getTyped("EVN", EVN.class);
221    }
222
223
224
225
226
227    /**
228     * <p>
229     * Returns
230     * PID (Patient Identification) - creates it if necessary
231     * </p>
232     * 
233     *
234     */
235    public PID getPID() { 
236       return getTyped("PID", PID.class);
237    }
238
239
240
241
242
243    /**
244     * <p>
245     * Returns
246     * PD1 (Patient Additional Demographic) - creates it if necessary
247     * </p>
248     * 
249     *
250     */
251    public PD1 getPD1() { 
252       return getTyped("PD1", PD1.class);
253    }
254
255
256
257
258
259    /**
260     * <p>
261     * Returns
262     * PV1 (Patient Visit) - creates it if necessary
263     * </p>
264     * 
265     *
266     */
267    public PV1 getPV1() { 
268       return getTyped("PV1", PV1.class);
269    }
270
271
272
273
274
275    /**
276     * <p>
277     * Returns
278     * PV2 (Patient Visit - Additional Information) - creates it if necessary
279     * </p>
280     * 
281     *
282     */
283    public PV2 getPV2() { 
284       return getTyped("PV2", PV2.class);
285    }
286
287
288
289
290}
291