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