ca.uhn.hl7v2.model.v24.group.BAR_P02_PATIENT 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.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;
import ca.uhn.hl7v2.model.Group;
import ca.uhn.hl7v2.model.AbstractGroup;
import ca.uhn.hl7v2.model.GenericSegment;
/**
* Represents a BAR_P02_PATIENT group structure (a Group object).
* A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
* This Group contains the following elements:
*
*
* - 1: PID (Patient identification)
* - 2: PD1 (patient additional demographic) optional
* - 3: PV1 (Patient visit) optional
* - 4: DB1 (Disability) optional repeating
*
*/
@SuppressWarnings("unused")
public class BAR_P02_PATIENT extends AbstractGroup {
/**
* Creates a new BAR_P02_PATIENT group
*/
public BAR_P02_PATIENT(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(PID.class, true, false);
this.add(PD1.class, false, false);
this.add(PV1.class, false, false);
this.add(DB1.class, false, true);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error creating BAR_P02_PATIENT - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.4"
*/
public String getVersion() {
return "2.4";
}
/**
* 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
* PV1 (Patient visit) - creates it if necessary
*/
public PV1 getPV1() {
PV1 ret = null;
try {
ret = (PV1)this.get("PV1");
} 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
* DB1 (Disability) - creates it if necessary
*/
public DB1 getDB1() {
DB1 ret = null;
try {
ret = (DB1)this.get("DB1");
} 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
* 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) {
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 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.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of DB1.
*
*
* Note that unlike {@link #getDB1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getDB1All() throws HL7Exception {
return this.getAllAsList("DB1", DB1.class);
}
/**
* 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);
}
}