ca.uhn.hl7v2.model.v23.message.ADT_A03 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)
* 2012. 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.v23.message;
import ca.uhn.hl7v2.model.v23.group.*;
import ca.uhn.hl7v2.model.v23.segment.*;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.*;
/**
* Represents a ADT_A03 message structure (see chapter ?). This structure contains the
* following elements:
*
* - 1: MSH (Message header segment)
* - 2: EVN (Event type)
* - 3: PID (Patient Identification)
* - 4: PD1 (Patient Demographic) optional
* - 5: PV1 (Patient visit)
* - 6: PV2 (Patient visit - additional information) optional
* - 7: DB1 (Disability Segment) optional repeating
* - 8: DG1 (Diagnosis) optional repeating
* - 9: DRG (Diagnosis Related Group) optional
* - 10: ADT_A03_PROCEDURE (a Group object) optional repeating
* - 11: OBX (Observation segment) optional repeating
*
*/
//@SuppressWarnings("unused")
public class ADT_A03 extends AbstractMessage {
/**
* Creates a new ADT_A03 message with DefaultModelClassFactory.
*/
public ADT_A03() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new ADT_A03 message with custom ModelClassFactory.
*/
public ADT_A03(ModelClassFactory factory) {
super(factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(MSH.class, true, 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(DG1.class, false, true);
this.add(DRG.class, false, false);
this.add(ADT_A03_PROCEDURE.class, false, true);
this.add(OBX.class, false, true);
} catch(HL7Exception e) {
log.error("Unexpected error creating ADT_A03 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.3"
*/
public String getVersion() {
return "2.3";
}
/**
*
* Returns
* MSH (Message header segment) - creates it if necessary
*
*
*
*/
public MSH getMSH() {
return getTyped("MSH", MSH.class);
}
/**
*
* Returns
* EVN (Event type) - creates it if necessary
*
*
*
*/
public EVN getEVN() {
return getTyped("EVN", EVN.class);
}
/**
*
* Returns
* PID (Patient Identification) - creates it if necessary
*
*
*
*/
public PID getPID() {
return getTyped("PID", PID.class);
}
/**
*
* Returns
* PD1 (Patient Demographic) - creates it if necessary
*
*
*
*/
public PD1 getPD1() {
return getTyped("PD1", PD1.class);
}
/**
*
* Returns
* PV1 (Patient visit) - creates it if necessary
*
*
*
*/
public PV1 getPV1() {
return getTyped("PV1", PV1.class);
}
/**
*
* Returns
* PV2 (Patient visit - additional information) - creates it if necessary
*
*
*
*/
public PV2 getPV2() {
return getTyped("PV2", PV2.class);
}
/**
*
* Returns
* the first repetition of
* DB1 (Disability Segment) - creates it if necessary
*
*
*
*/
public DB1 getDB1() {
return getTyped("DB1", DB1.class);
}
/**
*
* Returns a specific repetition of
* DB1 (Disability 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 DB1 getDB1(int rep) {
return getTyped("DB1", rep, DB1.class);
}
/**
*
* Returns the number of existing repetitions of DB1
*
*
*/
public int getDB1Reps() {
return getReps("DB1");
}
/**
*
* 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 java.util.List getDB1All() throws HL7Exception {
return getAllAsList("DB1", DB1.class);
}
/**
*
* Inserts a specific repetition of DB1 (Disability Segment)
*
*
*
* @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 Segment)
*
*
*
* @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 Segment)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public DB1 removeDB1(int rep) throws HL7Exception {
return (DB1)super.removeRepetition("DB1", rep);
}
/**
*
* Returns
* the first repetition of
* DG1 (Diagnosis) - creates it if necessary
*
*
*
*/
public DG1 getDG1() {
return getTyped("DG1", DG1.class);
}
/**
*
* 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) {
return getTyped("DG1", rep, DG1.class);
}
/**
*
* Returns the number of existing repetitions of DG1
*
*
*/
public int getDG1Reps() {
return getReps("DG1");
}
/**
*
* 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 java.util.List getDG1All() throws HL7Exception {
return 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
* DRG (Diagnosis Related Group) - creates it if necessary
*
*
*
*/
public DRG getDRG() {
return getTyped("DRG", DRG.class);
}
/**
*
* Returns
* the first repetition of
* PROCEDURE (a Group object) - creates it if necessary
*
*
*
*/
public ADT_A03_PROCEDURE getPROCEDURE() {
return getTyped("PROCEDURE", ADT_A03_PROCEDURE.class);
}
/**
*
* Returns a specific repetition of
* PROCEDURE (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 ADT_A03_PROCEDURE getPROCEDURE(int rep) {
return getTyped("PROCEDURE", rep, ADT_A03_PROCEDURE.class);
}
/**
*
* Returns the number of existing repetitions of PROCEDURE
*
*
*/
public int getPROCEDUREReps() {
return getReps("PROCEDURE");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of PROCEDURE.
*
*
* Note that unlike {@link #getPROCEDURE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getPROCEDUREAll() throws HL7Exception {
return getAllAsList("PROCEDURE", ADT_A03_PROCEDURE.class);
}
/**
*
* Inserts a specific repetition of PROCEDURE (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPROCEDURE(ADT_A03_PROCEDURE structure, int rep) throws HL7Exception {
super.insertRepetition( "PROCEDURE", structure, rep);
}
/**
*
* Inserts a specific repetition of PROCEDURE (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public ADT_A03_PROCEDURE insertPROCEDURE(int rep) throws HL7Exception {
return (ADT_A03_PROCEDURE)super.insertRepetition("PROCEDURE", rep);
}
/**
*
* Removes a specific repetition of PROCEDURE (a Group object)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public ADT_A03_PROCEDURE removePROCEDURE(int rep) throws HL7Exception {
return (ADT_A03_PROCEDURE)super.removeRepetition("PROCEDURE", rep);
}
/**
*
* Returns
* the first repetition of
* OBX (Observation segment) - creates it if necessary
*
*
*
*/
public OBX getOBX() {
return getTyped("OBX", OBX.class);
}
/**
*
* Returns a specific repetition of
* OBX (Observation 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 OBX getOBX(int rep) {
return getTyped("OBX", rep, OBX.class);
}
/**
*
* Returns the number of existing repetitions of OBX
*
*
*/
public int getOBXReps() {
return getReps("OBX");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of OBX.
*
*
* Note that unlike {@link #getOBX()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getOBXAll() throws HL7Exception {
return getAllAsList("OBX", OBX.class);
}
/**
*
* Inserts a specific repetition of OBX (Observation segment)
*
*
*
* @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 segment)
*
*
*
* @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 segment)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public OBX removeOBX(int rep) throws HL7Exception {
return (OBX)super.removeRepetition("OBX", rep);
}
}