ca.uhn.hl7v2.model.v26.message.MDM_T02 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.v26.message;
import ca.uhn.hl7v2.model.v26.group.*;
import ca.uhn.hl7v2.model.v26.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 MDM_T02 message structure (see chapter 9.5.2). 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: PV1 (Patient Visit)
* - 7: MDM_T02_COMMON_ORDER (a Group object) optional repeating
* - 8: TXA (Transcription Document Header)
* - 9: MDM_T02_OBSERVATION (a Group object) repeating
*
*/
//@SuppressWarnings("unused")
public class MDM_T02 extends AbstractMessage {
/**
* Creates a new MDM_T02 message with DefaultModelClassFactory.
*/
public MDM_T02() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new MDM_T02 message with custom ModelClassFactory.
*/
public MDM_T02(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(PV1.class, true, false);
this.add(MDM_T02_COMMON_ORDER.class, false, true);
this.add(TXA.class, true, false);
this.add(MDM_T02_OBSERVATION.class, true, true);
} catch(HL7Exception e) {
log.error("Unexpected error creating MDM_T02 - 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() {
return getTyped("MSH", MSH.class);
}
/**
*
* Returns
* the first repetition of
* SFT (Software Segment) - creates it if necessary
*
*
*
*/
public SFT getSFT() {
return getTyped("SFT", SFT.class);
}
/**
*
* 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) {
return getTyped("SFT", rep, SFT.class);
}
/**
*
* Returns the number of existing repetitions of SFT
*
*
*/
public int getSFTReps() {
return getReps("SFT");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of SFT.
*
*
* Note that unlike {@link #getSFT()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getSFTAll() throws HL7Exception {
return getAllAsList("SFT", SFT.class);
}
/**
*
* 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() {
return getTyped("UAC", UAC.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
* PV1 (Patient Visit) - creates it if necessary
*
*
*
*/
public PV1 getPV1() {
return getTyped("PV1", PV1.class);
}
/**
*
* Returns
* the first repetition of
* COMMON_ORDER (a Group object) - creates it if necessary
*
*
*
*/
public MDM_T02_COMMON_ORDER getCOMMON_ORDER() {
return getTyped("COMMON_ORDER", MDM_T02_COMMON_ORDER.class);
}
/**
*
* Returns a specific repetition of
* COMMON_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 MDM_T02_COMMON_ORDER getCOMMON_ORDER(int rep) {
return getTyped("COMMON_ORDER", rep, MDM_T02_COMMON_ORDER.class);
}
/**
*
* Returns the number of existing repetitions of COMMON_ORDER
*
*
*/
public int getCOMMON_ORDERReps() {
return getReps("COMMON_ORDER");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of COMMON_ORDER.
*
*
* Note that unlike {@link #getCOMMON_ORDER()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getCOMMON_ORDERAll() throws HL7Exception {
return getAllAsList("COMMON_ORDER", MDM_T02_COMMON_ORDER.class);
}
/**
*
* Inserts a specific repetition of COMMON_ORDER (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertCOMMON_ORDER(MDM_T02_COMMON_ORDER structure, int rep) throws HL7Exception {
super.insertRepetition( "COMMON_ORDER", structure, rep);
}
/**
*
* Inserts a specific repetition of COMMON_ORDER (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public MDM_T02_COMMON_ORDER insertCOMMON_ORDER(int rep) throws HL7Exception {
return (MDM_T02_COMMON_ORDER)super.insertRepetition("COMMON_ORDER", rep);
}
/**
*
* Removes a specific repetition of COMMON_ORDER (a Group object)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public MDM_T02_COMMON_ORDER removeCOMMON_ORDER(int rep) throws HL7Exception {
return (MDM_T02_COMMON_ORDER)super.removeRepetition("COMMON_ORDER", rep);
}
/**
*
* Returns
* TXA (Transcription Document Header) - creates it if necessary
*
*
*
*/
public TXA getTXA() {
return getTyped("TXA", TXA.class);
}
/**
*
* Returns
* the first repetition of
* OBSERVATION (a Group object) - creates it if necessary
*
*
*
*/
public MDM_T02_OBSERVATION getOBSERVATION() {
return getTyped("OBSERVATION", MDM_T02_OBSERVATION.class);
}
/**
*
* 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 MDM_T02_OBSERVATION getOBSERVATION(int rep) {
return getTyped("OBSERVATION", rep, MDM_T02_OBSERVATION.class);
}
/**
*
* Returns the number of existing repetitions of OBSERVATION
*
*
*/
public int getOBSERVATIONReps() {
return getReps("OBSERVATION");
}
/**
*
* 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 java.util.List getOBSERVATIONAll() throws HL7Exception {
return getAllAsList("OBSERVATION", MDM_T02_OBSERVATION.class);
}
/**
*
* Inserts a specific repetition of OBSERVATION (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertOBSERVATION(MDM_T02_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 MDM_T02_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
return (MDM_T02_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
}
/**
*
* Removes a specific repetition of OBSERVATION (a Group object)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public MDM_T02_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
return (MDM_T02_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
}
}