001/*
002 * This class is an auto-generated source file for a HAPI
003 * HL7 v2.x standard structure class.
004 *
005 * For more information, visit: http://hl7api.sourceforge.net/
006 * 
007 * The contents of this file are subject to the Mozilla Public License Version 1.1 
008 * (the "License"); you may not use this file except in compliance with the License. 
009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
010 * Software distributed under the License is distributed on an "AS IS" basis, 
011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
012 * specific language governing rights and limitations under the License. 
013 * 
014 * The Original Code is "[file_name]".  Description: 
015 * "[one_line_description]" 
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2012.  All Rights Reserved. 
019 * 
020 * Contributor(s): ______________________________________. 
021 * 
022 * Alternatively, the contents of this file may be used under the terms of the 
023 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
024 * applicable instead of those above.  If you wish to allow use of your version of this 
025 * file only under the terms of the GPL and not to allow others to use your version 
026 * of this file under the MPL, indicate your decision by deleting  the provisions above 
027 * and replace  them with the notice and other provisions required by the GPL License.  
028 * If you do not delete the provisions above, a recipient may use your version of 
029 * this file under either the MPL or the GPL. 
030 * 
031 */
032
033
034package ca.uhn.hl7v2.model.v26.segment;
035
036// import ca.uhn.hl7v2.model.v26.group.*;
037import ca.uhn.hl7v2.model.v26.datatype.*;
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
041import ca.uhn.hl7v2.model.AbstractMessage;
042import ca.uhn.hl7v2.model.Group;
043import ca.uhn.hl7v2.model.Type;
044import ca.uhn.hl7v2.model.AbstractSegment;
045import ca.uhn.hl7v2.model.Varies;
046
047/**
048 *<p>Represents an HL7 IPR message segment (Invoice Processing Results). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>IPR-1: IPR Identifier (EI) <b> </b>
052     * <li>IPR-2: Provider Cross Reference Identifier (EI) <b> </b>
053     * <li>IPR-3: Payer Cross Reference Identifier (EI) <b> </b>
054     * <li>IPR-4: IPR Status (CWE) <b> </b>
055     * <li>IPR-5: IPR Date/Time (DTM) <b> </b>
056     * <li>IPR-6: Adjudicated/Paid Amount (CP) <b>optional </b>
057     * <li>IPR-7: Expected Payment Date/Time (DTM) <b>optional </b>
058     * <li>IPR-8: IPR Checksum (ST) <b> </b>
059 * </ul>
060 */
061@SuppressWarnings("unused")
062public class IPR extends AbstractSegment {
063
064    /** 
065     * Creates a new IPR segment
066     */
067    public IPR(Group parent, ModelClassFactory factory) {
068       super(parent, factory);
069       init(factory);
070    }
071
072    private void init(ModelClassFactory factory) {
073       try {
074                                  this.add(EI.class, true, 1, 73, new Object[]{ getMessage() }, "IPR Identifier");
075                                  this.add(EI.class, true, 1, 73, new Object[]{ getMessage() }, "Provider Cross Reference Identifier");
076                                  this.add(EI.class, true, 1, 73, new Object[]{ getMessage() }, "Payer Cross Reference Identifier");
077                                  this.add(CWE.class, true, 1, 177, new Object[]{ getMessage() }, "IPR Status");
078                                  this.add(DTM.class, true, 1, 26, new Object[]{ getMessage() }, "IPR Date/Time");
079                                  this.add(CP.class, false, 1, 254, new Object[]{ getMessage() }, "Adjudicated/Paid Amount");
080                                  this.add(DTM.class, false, 1, 26, new Object[]{ getMessage() }, "Expected Payment Date/Time");
081                                  this.add(ST.class, true, 1, 10, new Object[]{ getMessage() }, "IPR Checksum");
082       } catch(HL7Exception e) {
083          log.error("Unexpected error creating IPR - this is probably a bug in the source code generator.", e);
084       }
085    }
086
087
088
089    /**
090     * Returns
091     * IPR-1: "IPR Identifier" - creates it if necessary
092     */
093    public EI getIPRIdentifier() { 
094                EI retVal = this.getTypedField(1, 0);
095                return retVal;
096    }
097    
098    /**
099     * Returns
100     * IPR-1: "IPR Identifier" - creates it if necessary
101     */
102    public EI getIpr1_IPRIdentifier() { 
103                EI retVal = this.getTypedField(1, 0);
104                return retVal;
105    }
106
107
108
109    /**
110     * Returns
111     * IPR-2: "Provider Cross Reference Identifier" - creates it if necessary
112     */
113    public EI getProviderCrossReferenceIdentifier() { 
114                EI retVal = this.getTypedField(2, 0);
115                return retVal;
116    }
117    
118    /**
119     * Returns
120     * IPR-2: "Provider Cross Reference Identifier" - creates it if necessary
121     */
122    public EI getIpr2_ProviderCrossReferenceIdentifier() { 
123                EI retVal = this.getTypedField(2, 0);
124                return retVal;
125    }
126
127
128
129    /**
130     * Returns
131     * IPR-3: "Payer Cross Reference Identifier" - creates it if necessary
132     */
133    public EI getPayerCrossReferenceIdentifier() { 
134                EI retVal = this.getTypedField(3, 0);
135                return retVal;
136    }
137    
138    /**
139     * Returns
140     * IPR-3: "Payer Cross Reference Identifier" - creates it if necessary
141     */
142    public EI getIpr3_PayerCrossReferenceIdentifier() { 
143                EI retVal = this.getTypedField(3, 0);
144                return retVal;
145    }
146
147
148
149    /**
150     * Returns
151     * IPR-4: "IPR Status" - creates it if necessary
152     */
153    public CWE getIPRStatus() { 
154                CWE retVal = this.getTypedField(4, 0);
155                return retVal;
156    }
157    
158    /**
159     * Returns
160     * IPR-4: "IPR Status" - creates it if necessary
161     */
162    public CWE getIpr4_IPRStatus() { 
163                CWE retVal = this.getTypedField(4, 0);
164                return retVal;
165    }
166
167
168
169    /**
170     * Returns
171     * IPR-5: "IPR Date/Time" - creates it if necessary
172     */
173    public DTM getIPRDateTime() { 
174                DTM retVal = this.getTypedField(5, 0);
175                return retVal;
176    }
177    
178    /**
179     * Returns
180     * IPR-5: "IPR Date/Time" - creates it if necessary
181     */
182    public DTM getIpr5_IPRDateTime() { 
183                DTM retVal = this.getTypedField(5, 0);
184                return retVal;
185    }
186
187
188
189    /**
190     * Returns
191     * IPR-6: "Adjudicated/Paid Amount" - creates it if necessary
192     */
193    public CP getAdjudicatedPaidAmount() { 
194                CP retVal = this.getTypedField(6, 0);
195                return retVal;
196    }
197    
198    /**
199     * Returns
200     * IPR-6: "Adjudicated/Paid Amount" - creates it if necessary
201     */
202    public CP getIpr6_AdjudicatedPaidAmount() { 
203                CP retVal = this.getTypedField(6, 0);
204                return retVal;
205    }
206
207
208
209    /**
210     * Returns
211     * IPR-7: "Expected Payment Date/Time" - creates it if necessary
212     */
213    public DTM getExpectedPaymentDateTime() { 
214                DTM retVal = this.getTypedField(7, 0);
215                return retVal;
216    }
217    
218    /**
219     * Returns
220     * IPR-7: "Expected Payment Date/Time" - creates it if necessary
221     */
222    public DTM getIpr7_ExpectedPaymentDateTime() { 
223                DTM retVal = this.getTypedField(7, 0);
224                return retVal;
225    }
226
227
228
229    /**
230     * Returns
231     * IPR-8: "IPR Checksum" - creates it if necessary
232     */
233    public ST getIPRChecksum() { 
234                ST retVal = this.getTypedField(8, 0);
235                return retVal;
236    }
237    
238    /**
239     * Returns
240     * IPR-8: "IPR Checksum" - creates it if necessary
241     */
242    public ST getIpr8_IPRChecksum() { 
243                ST retVal = this.getTypedField(8, 0);
244                return retVal;
245    }
246
247
248
249
250
251    /** {@inheritDoc} */   
252    protected Type createNewTypeWithoutReflection(int field) {
253       switch (field) {
254          case 0: return new EI(getMessage());
255          case 1: return new EI(getMessage());
256          case 2: return new EI(getMessage());
257          case 3: return new CWE(getMessage());
258          case 4: return new DTM(getMessage());
259          case 5: return new CP(getMessage());
260          case 6: return new DTM(getMessage());
261          case 7: return new ST(getMessage());
262          default: return null;
263       }
264   }
265
266
267}
268