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.v28.group;
35
36 import ca.uhn.hl7v2.model.v28.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 RSP_Z82_VISIT 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: AL1 (Patient Allergy Information) <b> repeating </b></li>
49 * <li>2: PV1 (Patient Visit) <b> </b></li>
50 * <li>3: PV2 (Patient Visit - Additional Information) <b>optional </b></li>
51 * </ul>
52 */
53 //@SuppressWarnings("unused")
54 public class RSP_Z82_VISIT extends AbstractGroup {
55
56 /**
57 * Creates a new RSP_Z82_VISIT group
58 */
59 public RSP_Z82_VISIT(Group parent, ModelClassFactory factory) {
60 super(parent, factory);
61 init(factory);
62 }
63
64 private void init(ModelClassFactory factory) {
65 try {
66 this.add(AL1.class, true, true, false);
67 this.add(PV1.class, true, false, false);
68 this.add(PV2.class, false, false, false);
69 } catch(HL7Exception e) {
70 log.error("Unexpected error creating RSP_Z82_VISIT - this is probably a bug in the source code generator.", e);
71 }
72 }
73
74 /**
75 * Returns "2.8"
76 */
77 public String getVersion() {
78 return "2.8";
79 }
80
81
82
83 /**
84 * Returns
85 * the first repetition of
86 * AL1 (Patient Allergy Information) - creates it if necessary
87 */
88 public AL1 getAL1() {
89 AL1 retVal = getTyped("AL1", AL1.class);
90 return retVal;
91 }
92
93
94 /**
95 * Returns a specific repetition of
96 * AL1 (Patient Allergy Information) - creates it if necessary
97 *
98 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
99 * @throws HL7Exception if the repetition requested is more than one
100 * greater than the number of existing repetitions.
101 */
102 public AL1 getAL1(int rep) {
103 AL1 retVal = getTyped("AL1", rep, AL1.class);
104 return retVal;
105 }
106
107 /**
108 * Returns the number of existing repetitions of AL1
109 */
110 public int getAL1Reps() {
111 return getReps("AL1");
112 }
113
114 /**
115 * <p>
116 * Returns a non-modifiable List containing all current existing repetitions of AL1.
117 * <p>
118 * <p>
119 * Note that unlike {@link #getAL1()}, this method will not create any reps
120 * if none are already present, so an empty list may be returned.
121 * </p>
122 */
123 public java.util.List<AL1> getAL1All() throws HL7Exception {
124 return getAllAsList("AL1", AL1.class);
125 }
126
127 /**
128 * Inserts a specific repetition of AL1 (Patient Allergy Information)
129 * @see AbstractGroup#insertRepetition(Structure, int)
130 */
131 public void insertAL1(AL1 structure, int rep) throws HL7Exception {
132 super.insertRepetition("AL1", structure, rep);
133 }
134
135
136 /**
137 * Inserts a specific repetition of AL1 (Patient Allergy Information)
138 * @see AbstractGroup#insertRepetition(Structure, int)
139 */
140 public AL1 insertAL1(int rep) throws HL7Exception {
141 return (AL1)super.insertRepetition("AL1", rep);
142 }
143
144
145 /**
146 * Removes a specific repetition of AL1 (Patient Allergy Information)
147 * @see AbstractGroup#removeRepetition(String, int)
148 */
149 public AL1 removeAL1(int rep) throws HL7Exception {
150 return (AL1)super.removeRepetition("AL1", rep);
151 }
152
153
154
155 /**
156 * Returns
157 * PV1 (Patient Visit) - creates it if necessary
158 */
159 public PV1 getPV1() {
160 PV1 retVal = getTyped("PV1", PV1.class);
161 return retVal;
162 }
163
164
165
166
167 /**
168 * Returns
169 * PV2 (Patient Visit - Additional Information) - creates it if necessary
170 */
171 public PV2 getPV2() {
172 PV2 retVal = getTyped("PV2", PV2.class);
173 return retVal;
174 }
175
176
177
178
179 }
180