View Javadoc
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.v24.message;
35  
36  import ca.uhn.hl7v2.model.v24.group.*;
37  import ca.uhn.hl7v2.model.v24.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 CRM_C01 message structure (see chapter 7). This structure contains the 
47   * following elements: </p>
48   * <ul>
49  		                 * <li>1: MSH (Message Header) <b> </b> </li>
50  		                 * <li>2: CRM_C01_PATIENT (a Group object) <b> repeating</b> </li>
51   * </ul>
52   */
53  //@SuppressWarnings("unused")
54  public class CRM_C01 extends AbstractMessage  {
55  
56      /**
57       * Creates a new CRM_C01 message with DefaultModelClassFactory. 
58       */ 
59      public CRM_C01() { 
60         this(new DefaultModelClassFactory());
61      }
62  
63      /** 
64       * Creates a new CRM_C01 message with custom ModelClassFactory.
65       */
66      public CRM_C01(ModelClassFactory factory) {
67         super(factory);
68         init(factory);
69      }
70  
71      private void init(ModelClassFactory factory) {
72         try {
73                            this.add(MSH.class, true, false);
74  	                          this.add(CRM_C01_PATIENT.class, true, true);
75  	       } catch(HL7Exception e) {
76            log.error("Unexpected error creating CRM_C01 - this is probably a bug in the source code generator.", e);
77         }
78      }
79  
80  
81      /** 
82       * Returns "2.4"
83       */
84      public String getVersion() {
85         return "2.4";
86      }
87  
88  
89  
90  
91      /**
92       * <p>
93       * Returns
94       * MSH (Message Header) - creates it if necessary
95       * </p>
96       * 
97       *
98       */
99      public MSH getMSH() { 
100        return getTyped("MSH", MSH.class);
101     }
102 
103 
104 
105 
106 
107     /**
108      * <p>
109      * Returns
110      * the first repetition of 
111      * PATIENT (a Group object) - creates it if necessary
112      * </p>
113      * 
114      *
115      */
116     public CRM_C01_PATIENT getPATIENT() { 
117        return getTyped("PATIENT", CRM_C01_PATIENT.class);
118     }
119 
120 
121     /**
122      * <p>
123      * Returns a specific repetition of
124      * PATIENT (a Group object) - creates it if necessary
125      * </p>
126      * 
127      *
128      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
129      * @throws HL7Exception if the repetition requested is more than one 
130      *     greater than the number of existing repetitions.
131      */
132     public CRM_C01_PATIENT getPATIENT(int rep) { 
133        return getTyped("PATIENT", rep, CRM_C01_PATIENT.class);
134     }
135 
136     /** 
137      * <p>
138      * Returns the number of existing repetitions of PATIENT 
139      * </p>
140      * 
141      */ 
142     public int getPATIENTReps() { 
143     	return getReps("PATIENT");
144     } 
145 
146     /** 
147      * <p>
148      * Returns a non-modifiable List containing all current existing repetitions of PATIENT.
149      * <p>
150      * <p>
151      * Note that unlike {@link #getPATIENT()}, this method will not create any reps
152      * if none are already present, so an empty list may be returned.
153      * </p>
154      * 
155      */ 
156     public java.util.List<CRM_C01_PATIENT> getPATIENTAll() throws HL7Exception {
157     	return getAllAsList("PATIENT", CRM_C01_PATIENT.class);
158     } 
159 
160     /**
161      * <p>
162      * Inserts a specific repetition of PATIENT (a Group object)
163      * </p>
164      * 
165      *
166      * @see AbstractGroup#insertRepetition(Structure, int) 
167      */
168     public void insertPATIENT(CRM_C01_PATIENT structure, int rep) throws HL7Exception { 
169        super.insertRepetition( "PATIENT", structure, rep);
170     }
171 
172 
173     /**
174      * <p>
175      * Inserts a specific repetition of PATIENT (a Group object)
176      * </p>
177      * 
178      *
179      * @see AbstractGroup#insertRepetition(Structure, int) 
180      */
181     public CRM_C01_PATIENT insertPATIENT(int rep) throws HL7Exception { 
182        return (CRM_C01_PATIENT)super.insertRepetition("PATIENT", rep);
183     }
184 
185 
186     /**
187      * <p>
188      * Removes a specific repetition of PATIENT (a Group object)
189      * </p>
190      * 
191      *
192      * @see AbstractGroup#removeRepetition(String, int) 
193      */
194     public CRM_C01_PATIENT removePATIENT(int rep) throws HL7Exception { 
195        return (CRM_C01_PATIENT)super.removeRepetition("PATIENT", rep);
196     }
197 
198 
199 
200 }
201