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.v23.message; 035 036import ca.uhn.hl7v2.model.v23.group.*; 037import ca.uhn.hl7v2.model.v23.segment.*; 038 039import ca.uhn.hl7v2.HL7Exception; 040import ca.uhn.hl7v2.parser.ModelClassFactory; 041import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 042import ca.uhn.hl7v2.model.*; 043 044 045/** 046 * <p>Represents a CRM_C04 message structure (see chapter ?). This structure contains the 047 * following elements: </p> 048 * <ul> 049 * <li>1: MSH (Message header segment) <b> </b> </li> 050 * <li>2: CRM_C04_PATIENT (a Group object) <b> repeating</b> </li> 051 * </ul> 052 */ 053//@SuppressWarnings("unused") 054public class CRM_C04 extends AbstractMessage { 055 056 /** 057 * Creates a new CRM_C04 message with DefaultModelClassFactory. 058 */ 059 public CRM_C04() { 060 this(new DefaultModelClassFactory()); 061 } 062 063 /** 064 * Creates a new CRM_C04 message with custom ModelClassFactory. 065 */ 066 public CRM_C04(ModelClassFactory factory) { 067 super(factory); 068 init(factory); 069 } 070 071 private void init(ModelClassFactory factory) { 072 try { 073 this.add(MSH.class, true, false); 074 this.add(CRM_C04_PATIENT.class, true, true); 075 } catch(HL7Exception e) { 076 log.error("Unexpected error creating CRM_C04 - this is probably a bug in the source code generator.", e); 077 } 078 } 079 080 081 /** 082 * Returns "2.3" 083 */ 084 public String getVersion() { 085 return "2.3"; 086 } 087 088 089 090 091 /** 092 * <p> 093 * Returns 094 * MSH (Message header segment) - creates it if necessary 095 * </p> 096 * 097 * 098 */ 099 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_C04_PATIENT getPATIENT() { 117 return getTyped("PATIENT", CRM_C04_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_C04_PATIENT getPATIENT(int rep) { 133 return getTyped("PATIENT", rep, CRM_C04_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_C04_PATIENT> getPATIENTAll() throws HL7Exception { 157 return getAllAsList("PATIENT", CRM_C04_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_C04_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_C04_PATIENT insertPATIENT(int rep) throws HL7Exception { 182 return (CRM_C04_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_C04_PATIENT removePATIENT(int rep) throws HL7Exception { 195 return (CRM_C04_PATIENT)super.removeRepetition("PATIENT", rep); 196 } 197 198 199 200} 201