1 /*
2 * This class is an auto-generated source file for a HAPI
3 * HL7 v2.x standard structure class.
4 *
5 * For more information, visit: http://hl7api.sourceforge.net/
6 *
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * (the "License"); you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
12 * specific language governing rights and limitations under the License.
13 *
14 * The Original Code is "[file_name]". Description:
15 * "[one_line_description]"
16 *
17 * The Initial Developer of the Original Code is University Health Network. Copyright (C)
18 * 2012. All Rights Reserved.
19 *
20 * Contributor(s): ______________________________________.
21 *
22 * Alternatively, the contents of this file may be used under the terms of the
23 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are
24 * applicable instead of those above. If you wish to allow use of your version of this
25 * file only under the terms of the GPL and not to allow others to use your version
26 * of this file under the MPL, indicate your decision by deleting the provisions above
27 * and replace them with the notice and other provisions required by the GPL License.
28 * If you do not delete the provisions above, a recipient may use your version of
29 * this file under either the MPL or the GPL.
30 *
31 */
32
33
34 package ca.uhn.hl7v2.model.v25.group;
35
36 import ca.uhn.hl7v2.model.v25.segment.*;
37
38 import ca.uhn.hl7v2.HL7Exception;
39 import ca.uhn.hl7v2.parser.ModelClassFactory;
40 import ca.uhn.hl7v2.model.*;
41
42 /**
43 * <p>Represents a SRM_S01_PATIENT group structure (a Group object).
44 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
45 * This Group contains the following elements:
46 * </p>
47 * <ul>
48 * <li>1: PID (Patient Identification) <b> </b></li>
49 * <li>2: PV1 (Patient Visit) <b>optional </b></li>
50 * <li>3: PV2 (Patient Visit - Additional Information) <b>optional </b></li>
51 * <li>4: OBX (Observation/Result) <b>optional repeating </b></li>
52 * <li>5: DG1 (Diagnosis) <b>optional repeating </b></li>
53 * </ul>
54 */
55 //@SuppressWarnings("unused")
56 public class SRM_S01_PATIENT extends AbstractGroup {
57
58 /**
59 * Creates a new SRM_S01_PATIENT group
60 */
61 public SRM_S01_PATIENT(Group parent, ModelClassFactory factory) {
62 super(parent, factory);
63 init(factory);
64 }
65
66 private void init(ModelClassFactory factory) {
67 try {
68 this.add(PID.class, true, false, false);
69 this.add(PV1.class, false, false, false);
70 this.add(PV2.class, false, false, false);
71 this.add(OBX.class, false, true, false);
72 this.add(DG1.class, false, true, false);
73 } catch(HL7Exception e) {
74 log.error("Unexpected error creating SRM_S01_PATIENT - this is probably a bug in the source code generator.", e);
75 }
76 }
77
78 /**
79 * Returns "2.5"
80 */
81 public String getVersion() {
82 return "2.5";
83 }
84
85
86
87 /**
88 * Returns
89 * PID (Patient Identification) - creates it if necessary
90 */
91 public PID getPID() {
92 PID retVal = getTyped("PID", PID.class);
93 return retVal;
94 }
95
96
97
98
99 /**
100 * Returns
101 * PV1 (Patient Visit) - creates it if necessary
102 */
103 public PV1 getPV1() {
104 PV1 retVal = getTyped("PV1", PV1.class);
105 return retVal;
106 }
107
108
109
110
111 /**
112 * Returns
113 * PV2 (Patient Visit - Additional Information) - creates it if necessary
114 */
115 public PV2 getPV2() {
116 PV2 retVal = getTyped("PV2", PV2.class);
117 return retVal;
118 }
119
120
121
122
123 /**
124 * Returns
125 * the first repetition of
126 * OBX (Observation/Result) - creates it if necessary
127 */
128 public OBX getOBX() {
129 OBX retVal = getTyped("OBX", OBX.class);
130 return retVal;
131 }
132
133
134 /**
135 * Returns a specific repetition of
136 * OBX (Observation/Result) - creates it if necessary
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 OBX getOBX(int rep) {
143 OBX retVal = getTyped("OBX", rep, OBX.class);
144 return retVal;
145 }
146
147 /**
148 * Returns the number of existing repetitions of OBX
149 */
150 public int getOBXReps() {
151 return getReps("OBX");
152 }
153
154 /**
155 * <p>
156 * Returns a non-modifiable List containing all current existing repetitions of OBX.
157 * <p>
158 * <p>
159 * Note that unlike {@link #getOBX()}, this method will not create any reps
160 * if none are already present, so an empty list may be returned.
161 * </p>
162 */
163 public java.util.List<OBX> getOBXAll() throws HL7Exception {
164 return getAllAsList("OBX", OBX.class);
165 }
166
167 /**
168 * Inserts a specific repetition of OBX (Observation/Result)
169 * @see AbstractGroup#insertRepetition(Structure, int)
170 */
171 public void insertOBX(OBX structure, int rep) throws HL7Exception {
172 super.insertRepetition("OBX", structure, rep);
173 }
174
175
176 /**
177 * Inserts a specific repetition of OBX (Observation/Result)
178 * @see AbstractGroup#insertRepetition(Structure, int)
179 */
180 public OBX insertOBX(int rep) throws HL7Exception {
181 return (OBX)super.insertRepetition("OBX", rep);
182 }
183
184
185 /**
186 * Removes a specific repetition of OBX (Observation/Result)
187 * @see AbstractGroup#removeRepetition(String, int)
188 */
189 public OBX removeOBX(int rep) throws HL7Exception {
190 return (OBX)super.removeRepetition("OBX", rep);
191 }
192
193
194
195 /**
196 * Returns
197 * the first repetition of
198 * DG1 (Diagnosis) - creates it if necessary
199 */
200 public DG1 getDG1() {
201 DG1 retVal = getTyped("DG1", DG1.class);
202 return retVal;
203 }
204
205
206 /**
207 * Returns a specific repetition of
208 * DG1 (Diagnosis) - creates it if necessary
209 *
210 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
211 * @throws HL7Exception if the repetition requested is more than one
212 * greater than the number of existing repetitions.
213 */
214 public DG1 getDG1(int rep) {
215 DG1 retVal = getTyped("DG1", rep, DG1.class);
216 return retVal;
217 }
218
219 /**
220 * Returns the number of existing repetitions of DG1
221 */
222 public int getDG1Reps() {
223 return getReps("DG1");
224 }
225
226 /**
227 * <p>
228 * Returns a non-modifiable List containing all current existing repetitions of DG1.
229 * <p>
230 * <p>
231 * Note that unlike {@link #getDG1()}, this method will not create any reps
232 * if none are already present, so an empty list may be returned.
233 * </p>
234 */
235 public java.util.List<DG1> getDG1All() throws HL7Exception {
236 return getAllAsList("DG1", DG1.class);
237 }
238
239 /**
240 * Inserts a specific repetition of DG1 (Diagnosis)
241 * @see AbstractGroup#insertRepetition(Structure, int)
242 */
243 public void insertDG1(DG1 structure, int rep) throws HL7Exception {
244 super.insertRepetition("DG1", structure, rep);
245 }
246
247
248 /**
249 * Inserts a specific repetition of DG1 (Diagnosis)
250 * @see AbstractGroup#insertRepetition(Structure, int)
251 */
252 public DG1 insertDG1(int rep) throws HL7Exception {
253 return (DG1)super.insertRepetition("DG1", rep);
254 }
255
256
257 /**
258 * Removes a specific repetition of DG1 (Diagnosis)
259 * @see AbstractGroup#removeRepetition(String, int)
260 */
261 public DG1 removeDG1(int rep) throws HL7Exception {
262 return (DG1)super.removeRepetition("DG1", rep);
263 }
264
265
266
267 }
268