ca.uhn.hl7v2.model.v24.message.VXR_V03 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 VXR_V03 message structure (see chapter ?). 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: PID (Patient identification)
* - 6: PD1 (patient additional demographic) optional
* - 7: NK1 (Next of kin / associated parties) optional repeating
* - 8: VXR_V03_PATIENT_VISIT (a Group object) optional
* - 9: GT1 (Guarantor) optional repeating
* - 10: VXR_V03_INSURANCE (a Group object) optional repeating
* - 11: VXR_V03_ORDER (a Group object) optional repeating
*
*/
public class VXR_V03 extends AbstractMessage {
/**
* Creates a new VXR_V03 message with DefaultModelClassFactory.
*/
public VXR_V03() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new VXR_V03 message with custom ModelClassFactory.
*/
public VXR_V03(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(PID.class, true, false);
this.add(PD1.class, false, false);
this.add(NK1.class, false, true);
this.add(VXR_V03_PATIENT_VISIT.class, false, false);
this.add(GT1.class, false, true);
this.add(VXR_V03_INSURANCE.class, false, true);
this.add(VXR_V03_ORDER.class, false, true);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error creating VXR_V03 - 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
* 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
* PD1 (patient additional demographic) - creates it if necessary
*/
public PD1 getPD1() {
PD1 ret = null;
try {
ret = (PD1)this.get("PD1");
} 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
* NK1 (Next of kin / associated parties) - creates it if necessary
*/
public NK1 getNK1() {
NK1 ret = null;
try {
ret = (NK1)this.get("NK1");
} 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
* NK1 (Next of kin / associated parties) - 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 NK1 getNK1(int rep) {
NK1 ret = null;
try {
ret = (NK1)this.get("NK1", 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 NK1
*/
public int getNK1Reps() {
int reps = -1;
try {
reps = this.getAll("NK1").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 NK1.
*
*
* Note that unlike {@link #getNK1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getNK1All() throws HL7Exception {
return this.getAllAsList("NK1", NK1.class);
}
/**
* Inserts a specific repetition of NK1 (Next of kin / associated parties)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertNK1(NK1 structure, int rep) throws HL7Exception {
super.insertRepetition( "NK1", structure, rep);
}
/**
* Inserts a specific repetition of NK1 (Next of kin / associated parties)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public NK1 insertNK1(int rep) throws HL7Exception {
return (NK1)super.insertRepetition("NK1", rep);
}
/**
* Removes a specific repetition of NK1 (Next of kin / associated parties)
* @see AbstractGroup#removeRepetition(String, int)
*/
public NK1 removeNK1(int rep) throws HL7Exception {
return (NK1)super.removeRepetition("NK1", rep);
}
/**
* Returns
* PATIENT_VISIT (a Group object) - creates it if necessary
*/
public VXR_V03_PATIENT_VISIT getPATIENT_VISIT() {
VXR_V03_PATIENT_VISIT ret = null;
try {
ret = (VXR_V03_PATIENT_VISIT)this.get("PATIENT_VISIT");
} 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
* GT1 (Guarantor) - creates it if necessary
*/
public GT1 getGT1() {
GT1 ret = null;
try {
ret = (GT1)this.get("GT1");
} 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
* GT1 (Guarantor) - 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 GT1 getGT1(int rep) {
GT1 ret = null;
try {
ret = (GT1)this.get("GT1", 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 GT1
*/
public int getGT1Reps() {
int reps = -1;
try {
reps = this.getAll("GT1").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 GT1.
*
*
* Note that unlike {@link #getGT1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getGT1All() throws HL7Exception {
return this.getAllAsList("GT1", GT1.class);
}
/**
* Inserts a specific repetition of GT1 (Guarantor)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertGT1(GT1 structure, int rep) throws HL7Exception {
super.insertRepetition( "GT1", structure, rep);
}
/**
* Inserts a specific repetition of GT1 (Guarantor)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public GT1 insertGT1(int rep) throws HL7Exception {
return (GT1)super.insertRepetition("GT1", rep);
}
/**
* Removes a specific repetition of GT1 (Guarantor)
* @see AbstractGroup#removeRepetition(String, int)
*/
public GT1 removeGT1(int rep) throws HL7Exception {
return (GT1)super.removeRepetition("GT1", rep);
}
/**
* Returns
* the first repetition of
* INSURANCE (a Group object) - creates it if necessary
*/
public VXR_V03_INSURANCE getINSURANCE() {
VXR_V03_INSURANCE ret = null;
try {
ret = (VXR_V03_INSURANCE)this.get("INSURANCE");
} 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
* INSURANCE (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 VXR_V03_INSURANCE getINSURANCE(int rep) {
VXR_V03_INSURANCE ret = null;
try {
ret = (VXR_V03_INSURANCE)this.get("INSURANCE", 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 INSURANCE
*/
public int getINSURANCEReps() {
int reps = -1;
try {
reps = this.getAll("INSURANCE").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 INSURANCE.
*
*
* Note that unlike {@link #getINSURANCE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getINSURANCEAll() throws HL7Exception {
return this.getAllAsList("INSURANCE", VXR_V03_INSURANCE.class);
}
/**
* Inserts a specific repetition of INSURANCE (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertINSURANCE(VXR_V03_INSURANCE structure, int rep) throws HL7Exception {
super.insertRepetition( "INSURANCE", structure, rep);
}
/**
* Inserts a specific repetition of INSURANCE (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public VXR_V03_INSURANCE insertINSURANCE(int rep) throws HL7Exception {
return (VXR_V03_INSURANCE)super.insertRepetition("INSURANCE", rep);
}
/**
* Removes a specific repetition of INSURANCE (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public VXR_V03_INSURANCE removeINSURANCE(int rep) throws HL7Exception {
return (VXR_V03_INSURANCE)super.removeRepetition("INSURANCE", rep);
}
/**
* Returns
* the first repetition of
* ORDER (a Group object) - creates it if necessary
*/
public VXR_V03_ORDER getORDER() {
VXR_V03_ORDER ret = null;
try {
ret = (VXR_V03_ORDER)this.get("ORDER");
} 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
* ORDER (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 VXR_V03_ORDER getORDER(int rep) {
VXR_V03_ORDER ret = null;
try {
ret = (VXR_V03_ORDER)this.get("ORDER", 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 ORDER
*/
public int getORDERReps() {
int reps = -1;
try {
reps = this.getAll("ORDER").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 ORDER.
*
*
* Note that unlike {@link #getORDER()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getORDERAll() throws HL7Exception {
return this.getAllAsList("ORDER", VXR_V03_ORDER.class);
}
/**
* Inserts a specific repetition of ORDER (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertORDER(VXR_V03_ORDER structure, int rep) throws HL7Exception {
super.insertRepetition( "ORDER", structure, rep);
}
/**
* Inserts a specific repetition of ORDER (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public VXR_V03_ORDER insertORDER(int rep) throws HL7Exception {
return (VXR_V03_ORDER)super.insertRepetition("ORDER", rep);
}
/**
* Removes a specific repetition of ORDER (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public VXR_V03_ORDER removeORDER(int rep) throws HL7Exception {
return (VXR_V03_ORDER)super.removeRepetition("ORDER", rep);
}
}