ca.uhn.hl7v2.model.v24.message.RCI_I05 Maven / Gradle / Ivy
/*
* 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.v24.message;
import ca.uhn.hl7v2.model.v24.group.*;
import ca.uhn.hl7v2.model.v24.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;
/**
* Represents a RCI_I05 message structure (see chapter 11). This structure contains the
* following elements:
*
* - 1: MSH (Message Header)
* - 2: MSA (Message Acknowledgment)
* - 3: QRD (Original-Style Query Definition)
* - 4: QRF (Original Style Query Filter) optional
* - 5: RCI_I05_PROVIDER (a Group object) repeating
* - 6: PID (Patient identification)
* - 7: DG1 (Diagnosis) optional repeating
* - 8: DRG (Diagnosis Related Group) optional repeating
* - 9: AL1 (Patient allergy information) optional repeating
* - 10: RCI_I05_OBSERVATION (a Group object) optional repeating
* - 11: NTE (Notes and Comments) optional repeating
*
*/
public class RCI_I05 extends AbstractMessage {
/**
* Creates a new RCI_I05 message with DefaultModelClassFactory.
*/
public RCI_I05() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new RCI_I05 message with custom ModelClassFactory.
*/
public RCI_I05(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(RCI_I05_PROVIDER.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(RCI_I05_OBSERVATION.class, false, true);
this.add(NTE.class, false, true);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error creating RCI_I05 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.4"
*/
public String getVersion() {
return "2.4";
}
/**
* Returns
* MSH (Message Header) - 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 (Message Acknowledgment) - 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 (Original-Style Query Definition) - 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 (Original Style Query Filter) - 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
* PROVIDER (a Group object) - creates it if necessary
*/
public RCI_I05_PROVIDER getPROVIDER() {
RCI_I05_PROVIDER ret = null;
try {
ret = (RCI_I05_PROVIDER)this.get("PROVIDER");
} 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
* PROVIDER (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 RCI_I05_PROVIDER getPROVIDER(int rep) {
RCI_I05_PROVIDER ret = null;
try {
ret = (RCI_I05_PROVIDER)this.get("PROVIDER", 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 PROVIDER
*/
public int getPROVIDERReps() {
int reps = -1;
try {
reps = this.getAll("PROVIDER").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;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of PROVIDER.
*
*
* Note that unlike {@link #getPROVIDER()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getPROVIDERAll() throws HL7Exception {
return this.getAllAsList("PROVIDER", RCI_I05_PROVIDER.class);
}
/**
* Inserts a specific repetition of PROVIDER (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPROVIDER(RCI_I05_PROVIDER structure, int rep) throws HL7Exception {
super.insertRepetition( "PROVIDER", structure, rep);
}
/**
* Inserts a specific repetition of PROVIDER (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public RCI_I05_PROVIDER insertPROVIDER(int rep) throws HL7Exception {
return (RCI_I05_PROVIDER)super.insertRepetition("PROVIDER", rep);
}
/**
* Removes a specific repetition of PROVIDER (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public RCI_I05_PROVIDER removePROVIDER(int rep) throws HL7Exception {
return (RCI_I05_PROVIDER)super.removeRepetition("PROVIDER", rep);
}
/**
* Returns
* PID (Patient identification) - 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 (Diagnosis) - 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 (Diagnosis) - 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;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of DG1.
*
*
* Note that unlike {@link #getDG1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getDG1All() throws HL7Exception {
return this.getAllAsList("DG1", DG1.class);
}
/**
* Inserts a specific repetition of DG1 (Diagnosis)
* @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 (Diagnosis)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public DG1 insertDG1(int rep) throws HL7Exception {
return (DG1)super.insertRepetition("DG1", rep);
}
/**
* Removes a specific repetition of DG1 (Diagnosis)
* @see AbstractGroup#removeRepetition(String, int)
*/
public DG1 removeDG1(int rep) throws HL7Exception {
return (DG1)super.removeRepetition("DG1", rep);
}
/**
* Returns
* the first repetition of
* DRG (Diagnosis Related Group) - 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 (Diagnosis Related Group) - 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;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of DRG.
*
*
* Note that unlike {@link #getDRG()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getDRGAll() throws HL7Exception {
return this.getAllAsList("DRG", DRG.class);
}
/**
* Inserts a specific repetition of DRG (Diagnosis Related Group)
* @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 (Diagnosis Related Group)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public DRG insertDRG(int rep) throws HL7Exception {
return (DRG)super.insertRepetition("DRG", rep);
}
/**
* Removes a specific repetition of DRG (Diagnosis Related Group)
* @see AbstractGroup#removeRepetition(String, int)
*/
public DRG removeDRG(int rep) throws HL7Exception {
return (DRG)super.removeRepetition("DRG", rep);
}
/**
* Returns
* the first repetition of
* AL1 (Patient allergy information) - 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 (Patient allergy information) - 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;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of AL1.
*
*
* Note that unlike {@link #getAL1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getAL1All() throws HL7Exception {
return this.getAllAsList("AL1", AL1.class);
}
/**
* Inserts a specific repetition of AL1 (Patient allergy information)
* @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 (Patient allergy information)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public AL1 insertAL1(int rep) throws HL7Exception {
return (AL1)super.insertRepetition("AL1", rep);
}
/**
* Removes a specific repetition of AL1 (Patient allergy information)
* @see AbstractGroup#removeRepetition(String, int)
*/
public AL1 removeAL1(int rep) throws HL7Exception {
return (AL1)super.removeRepetition("AL1", rep);
}
/**
* Returns
* the first repetition of
* OBSERVATION (a Group object) - creates it if necessary
*/
public RCI_I05_OBSERVATION getOBSERVATION() {
RCI_I05_OBSERVATION ret = null;
try {
ret = (RCI_I05_OBSERVATION)this.get("OBSERVATION");
} 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
* OBSERVATION (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 RCI_I05_OBSERVATION getOBSERVATION(int rep) {
RCI_I05_OBSERVATION ret = null;
try {
ret = (RCI_I05_OBSERVATION)this.get("OBSERVATION", 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 OBSERVATION
*/
public int getOBSERVATIONReps() {
int reps = -1;
try {
reps = this.getAll("OBSERVATION").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;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
*
*
* Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getOBSERVATIONAll() throws HL7Exception {
return this.getAllAsList("OBSERVATION", RCI_I05_OBSERVATION.class);
}
/**
* Inserts a specific repetition of OBSERVATION (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertOBSERVATION(RCI_I05_OBSERVATION structure, int rep) throws HL7Exception {
super.insertRepetition( "OBSERVATION", structure, rep);
}
/**
* Inserts a specific repetition of OBSERVATION (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public RCI_I05_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
return (RCI_I05_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
}
/**
* Removes a specific repetition of OBSERVATION (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public RCI_I05_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
return (RCI_I05_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
}
/**
* Returns
* the first repetition of
* NTE (Notes and Comments) - 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 (Notes and Comments) - 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;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of NTE.
*
*
* Note that unlike {@link #getNTE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getNTEAll() throws HL7Exception {
return this.getAllAsList("NTE", NTE.class);
}
/**
* Inserts a specific repetition of NTE (Notes and Comments)
* @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 (Notes and Comments)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public NTE insertNTE(int rep) throws HL7Exception {
return (NTE)super.insertRepetition("NTE", rep);
}
/**
* Removes a specific repetition of NTE (Notes and Comments)
* @see AbstractGroup#removeRepetition(String, int)
*/
public NTE removeNTE(int rep) throws HL7Exception {
return (NTE)super.removeRepetition("NTE", rep);
}
}