/*
* This class is an auto-generated source file for a HAPI
* HL7 v2.x standard structure class.
*
* For more information, visit: http://hl7api.sourceforge.net/
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
* specific language governing rights and limitations under the License.
*
* The Original Code is "[file_name]". Description:
* "[one_line_description]"
*
* The Initial Developer of the Original Code is University Health Network. Copyright (C)
* 2002. All Rights Reserved.
*
* Contributor(s): ______________________________________.
*
* Alternatively, the contents of this file may be used under the terms of the
* GNU General Public License (the "GPL"), in which case the provisions of the GPL are
* applicable instead of those above. If you wish to allow use of your version of this
* file only under the terms of the GPL and not to allow others to use your version
* of this file under the MPL, indicate your decision by deleting the provisions above
* and replace them with the notice and other provisions required by the GPL License.
* If you do not delete the provisions above, a recipient may use your version of
* this file under either the MPL or the GPL.
*
*/
package ca.uhn.hl7v2.model.v231.message;
import ca.uhn.hl7v2.model.v231.group.*;
import ca.uhn.hl7v2.model.v231.segment.*;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.AbstractMessage;
/**
* <p>Represents a RCL_I06 message structure (see chapter ?). This structure contains the
* following elements: </p>
* <ul>
* <li>1: MSH (MSH - message header segment) <b> </b></li>
* <li>2: MSA (MSA - message acknowledgment segment) <b> </b></li>
* <li>3: QRD (QRD - original-style query definition segment) <b> </b></li>
* <li>4: QRF (QRF - original style query filter segment) <b>optional </b></li>
* <li>5: RCL_I06_PRDCTD (a Group object) <b> repeating</b></li>
* <li>6: PID (PID - patient identification segment) <b> </b></li>
* <li>7: DG1 (DG1 - diagnosis segment) <b>optional repeating</b></li>
* <li>8: DRG (DRG - diagnosis related group segment) <b>optional repeating</b></li>
* <li>9: AL1 (AL1 - patient allergy information segment) <b>optional repeating</b></li>
* <li>10: NTE (NTE - notes and comments segment) <b>optional repeating</b></li>
* <li>11: DSP (DSP - display data segment) <b>optional repeating</b></li>
* <li>12: DSC (DSC - Continuation pointer segment) <b>optional </b></li>
* </ul>
*/
public class RCL_I06 extends AbstractMessage {
/**
* Creates a new RCL_I06 message with DefaultModelClassFactory.
*/
public RCL_I06() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new RCL_I06 message with custom ModelClassFactory.
*/
public RCL_I06(ModelClassFactory factory) {
super(factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(MSH.class, true, false);
this.add(MSA.class, true, false);
this.add(QRD.class, true, false);
this.add(QRF.class, false, false);
this.add(RCL_I06_PRDCTD.class, true, true);
this.add(PID.class, true, false);
this.add(DG1.class, false, true);
this.add(DRG.class, false, true);
this.add(AL1.class, false, true);
this.add(NTE.class, false, true);
this.add(DSP.class, false, true);
this.add(DSC.class, false, false);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error creating RCL_I06 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.3.1"
*/
public String getVersion() {
return "2.3.1";
}
/**
* Returns
* MSH (MSH - message header segment) - creates it if necessary
*/
public MSH getMSH() {
MSH ret = null;
try {
ret = (MSH)this.get("MSH");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* MSA (MSA - message acknowledgment segment) - creates it if necessary
*/
public MSA getMSA() {
MSA ret = null;
try {
ret = (MSA)this.get("MSA");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* QRD (QRD - original-style query definition segment) - creates it if necessary
*/
public QRD getQRD() {
QRD ret = null;
try {
ret = (QRD)this.get("QRD");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* QRF (QRF - original style query filter segment) - creates it if necessary
*/
public QRF getQRF() {
QRF ret = null;
try {
ret = (QRF)this.get("QRF");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* the first repetition of
* PRDCTD (a Group object) - creates it if necessary
*/
public RCL_I06_PRDCTD getPRDCTD() {
RCL_I06_PRDCTD ret = null;
try {
ret = (RCL_I06_PRDCTD)this.get("PRDCTD");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* PRDCTD (a Group object) - creates it if necessary
*
* @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
* @throws HL7Exception if the repetition requested is more than one
* greater than the number of existing repetitions.
*/
public RCL_I06_PRDCTD getPRDCTD(int rep) {
RCL_I06_PRDCTD ret = null;
try {
ret = (RCL_I06_PRDCTD)this.get("PRDCTD", rep);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of PRDCTD
*/
public int getPRDCTDReps() {
int reps = -1;
try {
reps = this.getAll("PRDCTD").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* <p>
* Returns a non-modifiable List containing all current existing repetitions of PRDCTD.
* <p>
* <p>
* Note that unlike {@link #getPRDCTD()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
* </p>
*/
public List<RCL_I06_PRDCTD> getPRDCTDAll() throws HL7Exception {
return this.getAllAsList("PRDCTD", RCL_I06_PRDCTD.class);
}
/**
* Inserts a specific repetition of PRDCTD (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPRDCTD(RCL_I06_PRDCTD structure, int rep) throws HL7Exception {
super.insertRepetition( "PRDCTD", structure, rep);
}
/**
* Inserts a specific repetition of PRDCTD (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public RCL_I06_PRDCTD insertPRDCTD(int rep) throws HL7Exception {
return (RCL_I06_PRDCTD)super.insertRepetition("PRDCTD", rep);
}
/**
* Removes a specific repetition of PRDCTD (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public RCL_I06_PRDCTD removePRDCTD(int rep) throws HL7Exception {
return (RCL_I06_PRDCTD)super.removeRepetition("PRDCTD", rep);
}
/**
* Returns
* PID (PID - patient identification segment) - creates it if necessary
*/
public PID getPID() {
PID ret = null;
try {
ret = (PID)this.get("PID");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* the first repetition of
* DG1 (DG1 - diagnosis segment) - creates it if necessary
*/
public DG1 getDG1() {
DG1 ret = null;
try {
ret = (DG1)this.get("DG1");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* DG1 (DG1 - diagnosis segment) - creates it if necessary
*
* @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
* @throws HL7Exception if the repetition requested is more than one
* greater than the number of existing repetitions.
*/
public DG1 getDG1(int rep) {
DG1 ret = null;
try {
ret = (DG1)this.get("DG1", rep);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of DG1
*/
public int getDG1Reps() {
int reps = -1;
try {
reps = this.getAll("DG1").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* <p>
* Returns a non-modifiable List containing all current existing repetitions of DG1.
* <p>
* <p>
* Note that unlike {@link #getDG1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
* </p>
*/
public List<DG1> getDG1All() throws HL7Exception {
return this.getAllAsList("DG1", DG1.class);
}
/**
* Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertDG1(DG1 structure, int rep) throws HL7Exception {
super.insertRepetition( "DG1", structure, rep);
}
/**
* Inserts a specific repetition of DG1 (DG1 - diagnosis segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public DG1 insertDG1(int rep) throws HL7Exception {
return (DG1)super.insertRepetition("DG1", rep);
}
/**
* Removes a specific repetition of DG1 (DG1 - diagnosis segment)
* @see AbstractGroup#removeRepetition(String, int)
*/
public DG1 removeDG1(int rep) throws HL7Exception {
return (DG1)super.removeRepetition("DG1", rep);
}
/**
* Returns
* the first repetition of
* DRG (DRG - diagnosis related group segment) - creates it if necessary
*/
public DRG getDRG() {
DRG ret = null;
try {
ret = (DRG)this.get("DRG");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* DRG (DRG - diagnosis related group segment) - creates it if necessary
*
* @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
* @throws HL7Exception if the repetition requested is more than one
* greater than the number of existing repetitions.
*/
public DRG getDRG(int rep) {
DRG ret = null;
try {
ret = (DRG)this.get("DRG", rep);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of DRG
*/
public int getDRGReps() {
int reps = -1;
try {
reps = this.getAll("DRG").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* <p>
* Returns a non-modifiable List containing all current existing repetitions of DRG.
* <p>
* <p>
* Note that unlike {@link #getDRG()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
* </p>
*/
public List<DRG> getDRGAll() throws HL7Exception {
return this.getAllAsList("DRG", DRG.class);
}
/**
* Inserts a specific repetition of DRG (DRG - diagnosis related group segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertDRG(DRG structure, int rep) throws HL7Exception {
super.insertRepetition( "DRG", structure, rep);
}
/**
* Inserts a specific repetition of DRG (DRG - diagnosis related group segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public DRG insertDRG(int rep) throws HL7Exception {
return (DRG)super.insertRepetition("DRG", rep);
}
/**
* Removes a specific repetition of DRG (DRG - diagnosis related group segment)
* @see AbstractGroup#removeRepetition(String, int)
*/
public DRG removeDRG(int rep) throws HL7Exception {
return (DRG)super.removeRepetition("DRG", rep);
}
/**
* Returns
* the first repetition of
* AL1 (AL1 - patient allergy information segment) - creates it if necessary
*/
public AL1 getAL1() {
AL1 ret = null;
try {
ret = (AL1)this.get("AL1");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* AL1 (AL1 - patient allergy information segment) - creates it if necessary
*
* @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
* @throws HL7Exception if the repetition requested is more than one
* greater than the number of existing repetitions.
*/
public AL1 getAL1(int rep) {
AL1 ret = null;
try {
ret = (AL1)this.get("AL1", rep);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of AL1
*/
public int getAL1Reps() {
int reps = -1;
try {
reps = this.getAll("AL1").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* <p>
* Returns a non-modifiable List containing all current existing repetitions of AL1.
* <p>
* <p>
* Note that unlike {@link #getAL1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
* </p>
*/
public List<AL1> getAL1All() throws HL7Exception {
return this.getAllAsList("AL1", AL1.class);
}
/**
* Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertAL1(AL1 structure, int rep) throws HL7Exception {
super.insertRepetition( "AL1", structure, rep);
}
/**
* Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public AL1 insertAL1(int rep) throws HL7Exception {
return (AL1)super.insertRepetition("AL1", rep);
}
/**
* Removes a specific repetition of AL1 (AL1 - patient allergy information segment)
* @see AbstractGroup#removeRepetition(String, int)
*/
public AL1 removeAL1(int rep) throws HL7Exception {
return (AL1)super.removeRepetition("AL1", rep);
}
/**
* Returns
* the first repetition of
* NTE (NTE - notes and comments segment) - creates it if necessary
*/
public NTE getNTE() {
NTE ret = null;
try {
ret = (NTE)this.get("NTE");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* NTE (NTE - notes and comments segment) - creates it if necessary
*
* @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
* @throws HL7Exception if the repetition requested is more than one
* greater than the number of existing repetitions.
*/
public NTE getNTE(int rep) {
NTE ret = null;
try {
ret = (NTE)this.get("NTE", rep);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of NTE
*/
public int getNTEReps() {
int reps = -1;
try {
reps = this.getAll("NTE").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* <p>
* Returns a non-modifiable List containing all current existing repetitions of NTE.
* <p>
* <p>
* Note that unlike {@link #getNTE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
* </p>
*/
public List<NTE> getNTEAll() throws HL7Exception {
return this.getAllAsList("NTE", NTE.class);
}
/**
* Inserts a specific repetition of NTE (NTE - notes and comments segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertNTE(NTE structure, int rep) throws HL7Exception {
super.insertRepetition( "NTE", structure, rep);
}
/**
* Inserts a specific repetition of NTE (NTE - notes and comments segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public NTE insertNTE(int rep) throws HL7Exception {
return (NTE)super.insertRepetition("NTE", rep);
}
/**
* Removes a specific repetition of NTE (NTE - notes and comments segment)
* @see AbstractGroup#removeRepetition(String, int)
*/
public NTE removeNTE(int rep) throws HL7Exception {
return (NTE)super.removeRepetition("NTE", rep);
}
/**
* Returns
* the first repetition of
* DSP (DSP - display data segment) - creates it if necessary
*/
public DSP getDSP() {
DSP ret = null;
try {
ret = (DSP)this.get("DSP");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* DSP (DSP - display data segment) - creates it if necessary
*
* @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
* @throws HL7Exception if the repetition requested is more than one
* greater than the number of existing repetitions.
*/
public DSP getDSP(int rep) {
DSP ret = null;
try {
ret = (DSP)this.get("DSP", rep);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of DSP
*/
public int getDSPReps() {
int reps = -1;
try {
reps = this.getAll("DSP").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* <p>
* Returns a non-modifiable List containing all current existing repetitions of DSP.
* <p>
* <p>
* Note that unlike {@link #getDSP()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
* </p>
*/
public List<DSP> getDSPAll() throws HL7Exception {
return this.getAllAsList("DSP", DSP.class);
}
/**
* Inserts a specific repetition of DSP (DSP - display data segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertDSP(DSP structure, int rep) throws HL7Exception {
super.insertRepetition( "DSP", structure, rep);
}
/**
* Inserts a specific repetition of DSP (DSP - display data segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public DSP insertDSP(int rep) throws HL7Exception {
return (DSP)super.insertRepetition("DSP", rep);
}
/**
* Removes a specific repetition of DSP (DSP - display data segment)
* @see AbstractGroup#removeRepetition(String, int)
*/
public DSP removeDSP(int rep) throws HL7Exception {
return (DSP)super.removeRepetition("DSP", rep);
}
/**
* Returns
* DSC (DSC - Continuation pointer segment) - creates it if necessary
*/
public DSC getDSC() {
DSC ret = null;
try {
ret = (DSC)this.get("DSC");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
}