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