Source code

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