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.v23.message;
035
036import ca.uhn.hl7v2.model.v23.group.*;
037import ca.uhn.hl7v2.model.v23.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 ?). This structure contains the 
048 * following elements: </p>
049 * <ul>
050                 * <li>1: MSH (Message header segment) <b> </b></li>
051                 * <li>2: EVN (Event type) <b> </b></li>
052                 * <li>3: PID (Patient Identification) <b> </b></li>
053                 * <li>4: PD1 (Patient Demographic) <b>optional </b></li>
054                 * <li>5: ADT_A45_MERGE_INFO (a Group object) <b> repeating</b></li>
055 * </ul>
056 */
057@SuppressWarnings("unused")
058public class ADT_A45 extends AbstractMessage  {
059
060    /**
061     * Creates a new ADT_A45 message with DefaultModelClassFactory. 
062     */ 
063    public ADT_A45() { 
064       this(new DefaultModelClassFactory());
065    }
066
067    /** 
068     * Creates a new ADT_A45 message with custom ModelClassFactory.
069     */
070    public ADT_A45(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(PD1.class, false, false);
081                          this.add(ADT_A45_MERGE_INFO.class, true, true);
082       } catch(HL7Exception e) {
083          log.error("Unexpected error creating ADT_A45 - this is probably a bug in the source code generator.", e);
084       }
085    }
086
087    /** 
088     * Returns "2.3"
089     */
090    public String getVersion() {
091       return "2.3";
092    }
093
094
095
096    /**
097     * Returns
098     * MSH (Message header segment) - creates it if necessary
099     */
100    public MSH getMSH() { 
101       return getTyped("MSH", MSH.class);
102    }
103
104
105
106
107    /**
108     * Returns
109     * EVN (Event type) - creates it if necessary
110     */
111    public EVN getEVN() { 
112       return getTyped("EVN", EVN.class);
113    }
114
115
116
117
118    /**
119     * Returns
120     * PID (Patient Identification) - creates it if necessary
121     */
122    public PID getPID() { 
123       return getTyped("PID", PID.class);
124    }
125
126
127
128
129    /**
130     * Returns
131     * PD1 (Patient Demographic) - creates it if necessary
132     */
133    public PD1 getPD1() { 
134       return getTyped("PD1", PD1.class);
135    }
136
137
138
139
140    /**
141     * Returns
142     * the first repetition of 
143     * MERGE_INFO (a Group object) - creates it if necessary
144     */
145    public ADT_A45_MERGE_INFO getMERGE_INFO() { 
146       return getTyped("MERGE_INFO", ADT_A45_MERGE_INFO.class);
147    }
148
149
150    /**
151     * Returns a specific repetition of
152     * MERGE_INFO (a Group object) - creates it if necessary
153     *
154     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
155     * @throws HL7Exception if the repetition requested is more than one 
156     *     greater than the number of existing repetitions.
157     */
158    public ADT_A45_MERGE_INFO getMERGE_INFO(int rep) { 
159       return getTyped("MERGE_INFO", rep, ADT_A45_MERGE_INFO.class);
160    }
161
162    /** 
163     * Returns the number of existing repetitions of MERGE_INFO 
164     */ 
165    public int getMERGE_INFOReps() { 
166        return getReps("MERGE_INFO");
167    } 
168
169    /** 
170     * <p>
171     * Returns a non-modifiable List containing all current existing repetitions of MERGE_INFO.
172     * <p>
173     * <p>
174     * Note that unlike {@link #getMERGE_INFO()}, this method will not create any reps
175     * if none are already present, so an empty list may be returned.
176     * </p>
177     */ 
178    public List<ADT_A45_MERGE_INFO> getMERGE_INFOAll() throws HL7Exception {
179        return getAllAsList("MERGE_INFO", ADT_A45_MERGE_INFO.class);
180    } 
181
182    /**
183     * Inserts a specific repetition of MERGE_INFO (a Group object)
184     * @see AbstractGroup#insertRepetition(Structure, int) 
185     */
186    public void insertMERGE_INFO(ADT_A45_MERGE_INFO structure, int rep) throws HL7Exception { 
187       super.insertRepetition( "MERGE_INFO", structure, rep);
188    }
189
190
191    /**
192     * Inserts a specific repetition of MERGE_INFO (a Group object)
193     * @see AbstractGroup#insertRepetition(Structure, int) 
194     */
195    public ADT_A45_MERGE_INFO insertMERGE_INFO(int rep) throws HL7Exception { 
196       return (ADT_A45_MERGE_INFO)super.insertRepetition("MERGE_INFO", rep);
197    }
198
199
200    /**
201     * Removes a specific repetition of MERGE_INFO (a Group object)
202     * @see AbstractGroup#removeRepetition(String, int) 
203     */
204    public ADT_A45_MERGE_INFO removeMERGE_INFO(int rep) throws HL7Exception { 
205       return (ADT_A45_MERGE_INFO)super.removeRepetition("MERGE_INFO", rep);
206    }
207
208
209
210}
211