ca.uhn.hl7v2.model.v26.message.ADT_A17 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/
*/
package ca.uhn.hl7v2.model.v26.message;
import ca.uhn.hl7v2.model.v26.group.*;
import ca.uhn.hl7v2.model.v26.segment.*;
import ca.uhn.log.HapiLogFactory;
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 ADT_A17 message structure (see chapter 3.3.17). This structure contains the
* following elements:
*
* - 1: MSH (Message Header)
* - 2: SFT (Software Segment) optional repeating
* - 3: UAC (User Authentication Credential Segment) optional
* - 4: EVN (Event Type)
* - 5: PID (Patient Identification)
* - 6: PD1 (Patient Additional Demographic) optional
* - 7: PV1 (Patient Visit)
* - 8: PV2 (Patient Visit - Additional Information) optional
* - 9: DB1 (Disability) optional repeating
* - 10: OBX (Observation/Result) optional repeating
* - 11: PID (Patient Identification)
* - 12: PD1 (Patient Additional Demographic) optional
* - 13: PV1 (Patient Visit)
* - 14: PV2 (Patient Visit - Additional Information) optional
* - 15: DB1 (Disability) optional repeating
* - 16: OBX (Observation/Result) optional repeating
*
*/
public class ADT_A17 extends AbstractMessage {
/**
* Creates a new ADT_A17 message with DefaultModelClassFactory.
*/
public ADT_A17() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new ADT_A17 message with custom ModelClassFactory.
*/
public ADT_A17(ModelClassFactory factory) {
super(factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(MSH.class, true, false);
this.add(SFT.class, false, true);
this.add(UAC.class, false, false);
this.add(EVN.class, true, false);
this.add(PID.class, true, false);
this.add(PD1.class, false, false);
this.add(PV1.class, true, false);
this.add(PV2.class, false, false);
this.add(DB1.class, false, true);
this.add(OBX.class, false, true);
this.add(PID.class, true, false);
this.add(PD1.class, false, false);
this.add(PV1.class, true, false);
this.add(PV2.class, false, false);
this.add(DB1.class, false, true);
this.add(OBX.class, false, true);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating ADT_A17 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.6"
*/
public String getVersion() {
return "2.6";
}
/**
* Returns
* MSH (Message Header) - creates it if necessary
*/
public MSH getMSH() {
MSH ret = null;
try {
ret = (MSH)this.get("MSH");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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
* SFT (Software Segment) - creates it if necessary
*/
public SFT getSFT() {
SFT ret = null;
try {
ret = (SFT)this.get("SFT");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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
* SFT (Software 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 SFT getSFT(int rep) {
SFT ret = null;
try {
ret = (SFT)this.get("SFT", rep);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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 SFT
*/
public int getSFTReps() {
int reps = -1;
try {
reps = this.getAll("SFT").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* Inserts a specific repetition of SFT (Software Segment)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertSFT(SFT structure, int rep) throws HL7Exception {
super.insertRepetition( "SFT", structure, rep);
}
/**
* Inserts a specific repetition of SFT (Software Segment)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public SFT insertSFT(int rep) throws HL7Exception {
return (SFT)super.insertRepetition("SFT", rep);
}
/**
* Removes a specific repetition of SFT (Software Segment)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public SFT removeSFT(int rep) throws HL7Exception {
return (SFT)super.removeRepetition("SFT", rep);
}
/**
* Returns
* UAC (User Authentication Credential Segment) - creates it if necessary
*/
public UAC getUAC() {
UAC ret = null;
try {
ret = (UAC)this.get("UAC");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* EVN (Event Type) - creates it if necessary
*/
public EVN getEVN() {
EVN ret = null;
try {
ret = (EVN)this.get("EVN");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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) {
HapiLogFactory.getHapiLog(this.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) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* PV1 (Patient Visit) - creates it if necessary
*/
public PV1 getPV1() {
PV1 ret = null;
try {
ret = (PV1)this.get("PV1");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* PV2 (Patient Visit - Additional Information) - creates it if necessary
*/
public PV2 getPV2() {
PV2 ret = null;
try {
ret = (PV2)this.get("PV2");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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
* DB1 (Disability) - creates it if necessary
*/
public DB1 getDB1() {
DB1 ret = null;
try {
ret = (DB1)this.get("DB1");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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
* DB1 (Disability) - 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 DB1 getDB1(int rep) {
DB1 ret = null;
try {
ret = (DB1)this.get("DB1", rep);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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 DB1
*/
public int getDB1Reps() {
int reps = -1;
try {
reps = this.getAll("DB1").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* Inserts a specific repetition of DB1 (Disability)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertDB1(DB1 structure, int rep) throws HL7Exception {
super.insertRepetition( "DB1", structure, rep);
}
/**
* Inserts a specific repetition of DB1 (Disability)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public DB1 insertDB1(int rep) throws HL7Exception {
return (DB1)super.insertRepetition("DB1", rep);
}
/**
* Removes a specific repetition of DB1 (Disability)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public DB1 removeDB1(int rep) throws HL7Exception {
return (DB1)super.removeRepetition("DB1", rep);
}
/**
* Returns
* the first repetition of
* OBX (Observation/Result) - creates it if necessary
*/
public OBX getOBX() {
OBX ret = null;
try {
ret = (OBX)this.get("OBX");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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
* OBX (Observation/Result) - 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 OBX getOBX(int rep) {
OBX ret = null;
try {
ret = (OBX)this.get("OBX", rep);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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 OBX
*/
public int getOBXReps() {
int reps = -1;
try {
reps = this.getAll("OBX").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* Inserts a specific repetition of OBX (Observation/Result)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertOBX(OBX structure, int rep) throws HL7Exception {
super.insertRepetition( "OBX", structure, rep);
}
/**
* Inserts a specific repetition of OBX (Observation/Result)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public OBX insertOBX(int rep) throws HL7Exception {
return (OBX)super.insertRepetition("OBX", rep);
}
/**
* Removes a specific repetition of OBX (Observation/Result)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public OBX removeOBX(int rep) throws HL7Exception {
return (OBX)super.removeRepetition("OBX", rep);
}
/**
* Returns
* PID2 (Patient Identification) - creates it if necessary
*/
public PID getPID2() {
PID ret = null;
try {
ret = (PID)this.get("PID2");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* PD12 (Patient Additional Demographic) - creates it if necessary
*/
public PD1 getPD12() {
PD1 ret = null;
try {
ret = (PD1)this.get("PD12");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* PV12 (Patient Visit) - creates it if necessary
*/
public PV1 getPV12() {
PV1 ret = null;
try {
ret = (PV1)this.get("PV12");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* PV22 (Patient Visit - Additional Information) - creates it if necessary
*/
public PV2 getPV22() {
PV2 ret = null;
try {
ret = (PV2)this.get("PV22");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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
* DB12 (Disability) - creates it if necessary
*/
public DB1 getDB12() {
DB1 ret = null;
try {
ret = (DB1)this.get("DB12");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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
* DB12 (Disability) - 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 DB1 getDB12(int rep) {
DB1 ret = null;
try {
ret = (DB1)this.get("DB12", rep);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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 DB12
*/
public int getDB12Reps() {
int reps = -1;
try {
reps = this.getAll("DB12").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* Inserts a specific repetition of DB12 (Disability)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertDB12(DB1 structure, int rep) throws HL7Exception {
super.insertRepetition( "DB12", structure, rep);
}
/**
* Inserts a specific repetition of DB12 (Disability)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public DB1 insertDB12(int rep) throws HL7Exception {
return (DB1)super.insertRepetition("DB12", rep);
}
/**
* Removes a specific repetition of DB12 (Disability)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public DB1 removeDB12(int rep) throws HL7Exception {
return (DB1)super.removeRepetition("DB12", rep);
}
/**
* Returns
* the first repetition of
* OBX2 (Observation/Result) - creates it if necessary
*/
public OBX getOBX2() {
OBX ret = null;
try {
ret = (OBX)this.get("OBX2");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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
* OBX2 (Observation/Result) - 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 OBX getOBX2(int rep) {
OBX ret = null;
try {
ret = (OBX)this.get("OBX2", rep);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.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 OBX2
*/
public int getOBX2Reps() {
int reps = -1;
try {
reps = this.getAll("OBX2").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* Inserts a specific repetition of OBX2 (Observation/Result)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertOBX2(OBX structure, int rep) throws HL7Exception {
super.insertRepetition( "OBX2", structure, rep);
}
/**
* Inserts a specific repetition of OBX2 (Observation/Result)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public OBX insertOBX2(int rep) throws HL7Exception {
return (OBX)super.insertRepetition("OBX2", rep);
}
/**
* Removes a specific repetition of OBX2 (Observation/Result)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public OBX removeOBX2(int rep) throws HL7Exception {
return (OBX)super.removeRepetition("OBX2", rep);
}
}