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 "XCN.java". Description: 15 * "Composite class XCN" 16 * 17 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 18 * 2013. 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 package ca.uhn.hl7v2.model.v23.datatype; 34 35 import ca.uhn.hl7v2.model.DataTypeException; 36 import ca.uhn.hl7v2.model.Message; 37 import ca.uhn.hl7v2.model.Type; 38 import ca.uhn.hl7v2.model.AbstractComposite; 39 40 41 /** 42 * <p>Represents an HL7 XCN (Extended Composite ID number and name (2.8.46)) data type. 43 * This type consists of the following components:</p> 44 * <ul> 45 * <li>ID number (ST) (ST) 46 * <li>family name (ST) 47 * <li>given name (ST) 48 * <li>middle initial or name (ST) 49 * <li>suffix (e.g., JR or III) (ST) 50 * <li>prefix (e.g., DR) (ST) 51 * <li>degree (e.g., MD) (ST) 52 * <li>source table (ID) 53 * <li>assigning authority (HD) 54 * <li>name type (ID) 55 * <li>identifier check digit (ST) 56 * <li>code identifying the check digit scheme employed (ID) 57 * <li>identifier type code (IS) 58 * <li>assigning facility ID (HD) 59 * </ul> 60 */ 61 @SuppressWarnings("unused") 62 public class XCN extends AbstractComposite { 63 64 private Type[] data; 65 66 /** 67 * Creates a new XCN type 68 */ 69 public XCN(Message message) { 70 super(message); 71 init(); 72 } 73 74 private void init() { 75 data = new Type[14]; 76 data[0] = new ST(getMessage()); 77 data[1] = new ST(getMessage()); 78 data[2] = new ST(getMessage()); 79 data[3] = new ST(getMessage()); 80 data[4] = new ST(getMessage()); 81 data[5] = new ST(getMessage()); 82 data[6] = new ST(getMessage()); 83 data[7] = new ID(getMessage(), 0); 84 data[8] = new HD(getMessage()); 85 data[9] = new ID(getMessage(), 0); 86 data[10] = new ST(getMessage()); 87 data[11] = new ID(getMessage(), 0); 88 data[12] = new IS(getMessage(), 0); 89 data[13] = new HD(getMessage()); 90 } 91 92 93 /** 94 * Returns an array containing the data elements. 95 */ 96 public Type[] getComponents() { 97 return this.data; 98 } 99 100 /** 101 * Returns an individual data component. 102 * 103 * @param number The component number (0-indexed) 104 * @throws DataTypeException if the given element number is out of range. 105 */ 106 public Type getComponent(int number) throws DataTypeException { 107 108 try { 109 return this.data[number]; 110 } catch (ArrayIndexOutOfBoundsException e) { 111 throw new DataTypeException("Element " + number + " doesn't exist (Type " + getClass().getName() + " has only " + this.data.length + " components)"); 112 } 113 } 114 115 116 /** 117 * Returns ID number (ST) (component 1). This is a convenience method that saves you from 118 * casting and handling an exception. 119 */ 120 public ST getIDNumber() { 121 return getTyped(0, ST.class); 122 } 123 124 125 /** 126 * Returns ID number (ST) (component 1). This is a convenience method that saves you from 127 * casting and handling an exception. 128 */ 129 public ST getXcn1_IDNumber() { 130 return getTyped(0, ST.class); 131 } 132 133 134 /** 135 * Returns family name (component 2). This is a convenience method that saves you from 136 * casting and handling an exception. 137 */ 138 public ST getFamilyName() { 139 return getTyped(1, ST.class); 140 } 141 142 143 /** 144 * Returns family name (component 2). This is a convenience method that saves you from 145 * casting and handling an exception. 146 */ 147 public ST getXcn2_FamilyName() { 148 return getTyped(1, ST.class); 149 } 150 151 152 /** 153 * Returns given name (component 3). This is a convenience method that saves you from 154 * casting and handling an exception. 155 */ 156 public ST getGivenName() { 157 return getTyped(2, ST.class); 158 } 159 160 161 /** 162 * Returns given name (component 3). This is a convenience method that saves you from 163 * casting and handling an exception. 164 */ 165 public ST getXcn3_GivenName() { 166 return getTyped(2, ST.class); 167 } 168 169 170 /** 171 * Returns middle initial or name (component 4). This is a convenience method that saves you from 172 * casting and handling an exception. 173 */ 174 public ST getMiddleInitialOrName() { 175 return getTyped(3, ST.class); 176 } 177 178 179 /** 180 * Returns middle initial or name (component 4). This is a convenience method that saves you from 181 * casting and handling an exception. 182 */ 183 public ST getXcn4_MiddleInitialOrName() { 184 return getTyped(3, ST.class); 185 } 186 187 188 /** 189 * Returns suffix (e.g., JR or III) (component 5). This is a convenience method that saves you from 190 * casting and handling an exception. 191 */ 192 public ST getSuffixEgJRorIII() { 193 return getTyped(4, ST.class); 194 } 195 196 197 /** 198 * Returns suffix (e.g., JR or III) (component 5). This is a convenience method that saves you from 199 * casting and handling an exception. 200 */ 201 public ST getXcn5_SuffixEgJRorIII() { 202 return getTyped(4, ST.class); 203 } 204 205 206 /** 207 * Returns prefix (e.g., DR) (component 6). This is a convenience method that saves you from 208 * casting and handling an exception. 209 */ 210 public ST getPrefixEgDR() { 211 return getTyped(5, ST.class); 212 } 213 214 215 /** 216 * Returns prefix (e.g., DR) (component 6). This is a convenience method that saves you from 217 * casting and handling an exception. 218 */ 219 public ST getXcn6_PrefixEgDR() { 220 return getTyped(5, ST.class); 221 } 222 223 224 /** 225 * Returns degree (e.g., MD) (component 7). This is a convenience method that saves you from 226 * casting and handling an exception. 227 */ 228 public ST getDegreeEgMD() { 229 return getTyped(6, ST.class); 230 } 231 232 233 /** 234 * Returns degree (e.g., MD) (component 7). This is a convenience method that saves you from 235 * casting and handling an exception. 236 */ 237 public ST getXcn7_DegreeEgMD() { 238 return getTyped(6, ST.class); 239 } 240 241 242 /** 243 * Returns source table (component 8). This is a convenience method that saves you from 244 * casting and handling an exception. 245 */ 246 public ID getSourceTable() { 247 return getTyped(7, ID.class); 248 } 249 250 251 /** 252 * Returns source table (component 8). This is a convenience method that saves you from 253 * casting and handling an exception. 254 */ 255 public ID getXcn8_SourceTable() { 256 return getTyped(7, ID.class); 257 } 258 259 260 /** 261 * Returns assigning authority (component 9). This is a convenience method that saves you from 262 * casting and handling an exception. 263 */ 264 public HD getAssigningAuthority() { 265 return getTyped(8, HD.class); 266 } 267 268 269 /** 270 * Returns assigning authority (component 9). This is a convenience method that saves you from 271 * casting and handling an exception. 272 */ 273 public HD getXcn9_AssigningAuthority() { 274 return getTyped(8, HD.class); 275 } 276 277 278 /** 279 * Returns name type (component 10). This is a convenience method that saves you from 280 * casting and handling an exception. 281 */ 282 public ID getNameType() { 283 return getTyped(9, ID.class); 284 } 285 286 287 /** 288 * Returns name type (component 10). This is a convenience method that saves you from 289 * casting and handling an exception. 290 */ 291 public ID getXcn10_NameType() { 292 return getTyped(9, ID.class); 293 } 294 295 296 /** 297 * Returns identifier check digit (component 11). This is a convenience method that saves you from 298 * casting and handling an exception. 299 */ 300 public ST getIdentifierCheckDigit() { 301 return getTyped(10, ST.class); 302 } 303 304 305 /** 306 * Returns identifier check digit (component 11). This is a convenience method that saves you from 307 * casting and handling an exception. 308 */ 309 public ST getXcn11_IdentifierCheckDigit() { 310 return getTyped(10, ST.class); 311 } 312 313 314 /** 315 * Returns code identifying the check digit scheme employed (component 12). This is a convenience method that saves you from 316 * casting and handling an exception. 317 */ 318 public ID getCodeIdentifyingTheCheckDigitSchemeEmployed() { 319 return getTyped(11, ID.class); 320 } 321 322 323 /** 324 * Returns code identifying the check digit scheme employed (component 12). This is a convenience method that saves you from 325 * casting and handling an exception. 326 */ 327 public ID getXcn12_CodeIdentifyingTheCheckDigitSchemeEmployed() { 328 return getTyped(11, ID.class); 329 } 330 331 332 /** 333 * Returns identifier type code (component 13). This is a convenience method that saves you from 334 * casting and handling an exception. 335 */ 336 public IS getIdentifierTypeCode() { 337 return getTyped(12, IS.class); 338 } 339 340 341 /** 342 * Returns identifier type code (component 13). This is a convenience method that saves you from 343 * casting and handling an exception. 344 */ 345 public IS getXcn13_IdentifierTypeCode() { 346 return getTyped(12, IS.class); 347 } 348 349 350 /** 351 * Returns assigning facility ID (component 14). This is a convenience method that saves you from 352 * casting and handling an exception. 353 */ 354 public HD getAssigningFacilityID() { 355 return getTyped(13, HD.class); 356 } 357 358 359 /** 360 * Returns assigning facility ID (component 14). This is a convenience method that saves you from 361 * casting and handling an exception. 362 */ 363 public HD getXcn14_AssigningFacilityID() { 364 return getTyped(13, HD.class); 365 } 366 367 368 369 } 370