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.v21.message;
35
36 import ca.uhn.hl7v2.model.v21.group.*;
37 import ca.uhn.hl7v2.model.v21.segment.*;
38
39 import ca.uhn.hl7v2.HL7Exception;
40 import ca.uhn.hl7v2.parser.ModelClassFactory;
41 import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
42 import ca.uhn.hl7v2.model.*;
43
44
45 /**
46 * <p>Represents a BAR_P01 message structure (see chapter ?). This structure contains the
47 * following elements: </p>
48 * <ul>
49 * <li>1: MSH (MESSAGE HEADER) <b> </b> </li>
50 * <li>2: EVN (EVENT TYPE) <b> </b> </li>
51 * <li>3: PID (PATIENT IDENTIFICATION) <b> </b> </li>
52 * <li>4: BAR_P01_VISIT (a Group object) <b> repeating</b> </li>
53 * </ul>
54 */
55 //@SuppressWarnings("unused")
56 public class BAR_P01 extends AbstractMessage {
57
58 /**
59 * Creates a new BAR_P01 message with DefaultModelClassFactory.
60 */
61 public BAR_P01() {
62 this(new DefaultModelClassFactory());
63 }
64
65 /**
66 * Creates a new BAR_P01 message with custom ModelClassFactory.
67 */
68 public BAR_P01(ModelClassFactory factory) {
69 super(factory);
70 init(factory);
71 }
72
73 private void init(ModelClassFactory factory) {
74 try {
75 this.add(MSH.class, true, false);
76 this.add(EVN.class, true, false);
77 this.add(PID.class, true, false);
78 this.add(BAR_P01_VISIT.class, true, true);
79 } catch(HL7Exception e) {
80 log.error("Unexpected error creating BAR_P01 - this is probably a bug in the source code generator.", e);
81 }
82 }
83
84
85 /**
86 * Returns "2.1"
87 */
88 public String getVersion() {
89 return "2.1";
90 }
91
92
93
94
95 /**
96 * <p>
97 * Returns
98 * MSH (MESSAGE HEADER) - creates it if necessary
99 * </p>
100 *
101 *
102 */
103 public MSH getMSH() {
104 return getTyped("MSH", MSH.class);
105 }
106
107
108
109
110
111 /**
112 * <p>
113 * Returns
114 * EVN (EVENT TYPE) - creates it if necessary
115 * </p>
116 *
117 *
118 */
119 public EVN getEVN() {
120 return getTyped("EVN", EVN.class);
121 }
122
123
124
125
126
127 /**
128 * <p>
129 * Returns
130 * PID (PATIENT IDENTIFICATION) - creates it if necessary
131 * </p>
132 *
133 *
134 */
135 public PID getPID() {
136 return getTyped("PID", PID.class);
137 }
138
139
140
141
142
143 /**
144 * <p>
145 * Returns
146 * the first repetition of
147 * VISIT (a Group object) - creates it if necessary
148 * </p>
149 *
150 *
151 */
152 public BAR_P01_VISIT getVISIT() {
153 return getTyped("VISIT", BAR_P01_VISIT.class);
154 }
155
156
157 /**
158 * <p>
159 * Returns a specific repetition of
160 * VISIT (a Group object) - creates it if necessary
161 * </p>
162 *
163 *
164 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
165 * @throws HL7Exception if the repetition requested is more than one
166 * greater than the number of existing repetitions.
167 */
168 public BAR_P01_VISIT getVISIT(int rep) {
169 return getTyped("VISIT", rep, BAR_P01_VISIT.class);
170 }
171
172 /**
173 * <p>
174 * Returns the number of existing repetitions of VISIT
175 * </p>
176 *
177 */
178 public int getVISITReps() {
179 return getReps("VISIT");
180 }
181
182 /**
183 * <p>
184 * Returns a non-modifiable List containing all current existing repetitions of VISIT.
185 * <p>
186 * <p>
187 * Note that unlike {@link #getVISIT()}, this method will not create any reps
188 * if none are already present, so an empty list may be returned.
189 * </p>
190 *
191 */
192 public java.util.List<BAR_P01_VISIT> getVISITAll() throws HL7Exception {
193 return getAllAsList("VISIT", BAR_P01_VISIT.class);
194 }
195
196 /**
197 * <p>
198 * Inserts a specific repetition of VISIT (a Group object)
199 * </p>
200 *
201 *
202 * @see AbstractGroup#insertRepetition(Structure, int)
203 */
204 public void insertVISIT(BAR_P01_VISIT structure, int rep) throws HL7Exception {
205 super.insertRepetition( "VISIT", structure, rep);
206 }
207
208
209 /**
210 * <p>
211 * Inserts a specific repetition of VISIT (a Group object)
212 * </p>
213 *
214 *
215 * @see AbstractGroup#insertRepetition(Structure, int)
216 */
217 public BAR_P01_VISIT insertVISIT(int rep) throws HL7Exception {
218 return (BAR_P01_VISIT)super.insertRepetition("VISIT", rep);
219 }
220
221
222 /**
223 * <p>
224 * Removes a specific repetition of VISIT (a Group object)
225 * </p>
226 *
227 *
228 * @see AbstractGroup#removeRepetition(String, int)
229 */
230 public BAR_P01_VISIT removeVISIT(int rep) throws HL7Exception {
231 return (BAR_P01_VISIT)super.removeRepetition("VISIT", rep);
232 }
233
234
235
236 }
237