ca.uhn.hl7v2.model.v22.segment.OM3 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.v22.segment;
// import ca.uhn.hl7v2.model.v22.group.*;
import ca.uhn.hl7v2.model.v22.datatype.*;
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.Type;
import ca.uhn.hl7v2.model.AbstractSegment;
import ca.uhn.hl7v2.model.Varies;
/**
*Represents an HL7 OM3 message segment (CATEGORICAL TEST/OBSERVATION).
* This segment has the following fields:
*
* - OM3-1: Segment Type ID (ST) optional
*
- OM3-2: Sequence Number - Test/ Observation Master File (NM) optional
*
- OM3-3: Preferred Coding System (ID) optional
*
- OM3-4: Valid coded answers (CE) optional repeating
*
- OM3-5: Normal test codes for categorical observations (CE) optional repeating
*
- OM3-6: Abnormal test codes for categorical observations (CE) optional
*
- OM3-7: Critical test codes for categorical observations (CE) optional
*
- OM3-8: Data Type (ID) optional
*
*/
@SuppressWarnings("unused")
public class OM3 extends AbstractSegment {
/**
* Creates a new OM3 segment
*/
public OM3(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(ST.class, false, 1, 3, new Object[]{ getMessage() }, "Segment Type ID");
this.add(NM.class, false, 1, 4, new Object[]{ getMessage() }, "Sequence Number - Test/ Observation Master File");
this.add(ID.class, false, 1, 5, new Object[]{ getMessage(), new Integer(0) }, "Preferred Coding System");
this.add(CE.class, false, 0, 60, new Object[]{ getMessage() }, "Valid coded answers");
this.add(CE.class, false, 0, 200, new Object[]{ getMessage() }, "Normal test codes for categorical observations");
this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Abnormal test codes for categorical observations");
this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Critical test codes for categorical observations");
this.add(ID.class, false, 1, 2, new Object[]{ getMessage(), new Integer(0) }, "Data Type");
} catch(HL7Exception e) {
log.error("Unexpected error creating OM3 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns
* OM3-1: "Segment Type ID" - creates it if necessary
*/
public ST getSegmentTypeID() {
ST retVal = this.getTypedField(1, 0);
return retVal;
}
/**
* Returns
* OM3-1: "Segment Type ID" - creates it if necessary
*/
public ST getOm31_SegmentTypeID() {
ST retVal = this.getTypedField(1, 0);
return retVal;
}
/**
* Returns
* OM3-2: "Sequence Number - Test/ Observation Master File" - creates it if necessary
*/
public NM getSequenceNumberTestObservationMasterFile() {
NM retVal = this.getTypedField(2, 0);
return retVal;
}
/**
* Returns
* OM3-2: "Sequence Number - Test/ Observation Master File" - creates it if necessary
*/
public NM getOm32_SequenceNumberTestObservationMasterFile() {
NM retVal = this.getTypedField(2, 0);
return retVal;
}
/**
* Returns
* OM3-3: "Preferred Coding System" - creates it if necessary
*/
public ID getPreferredCodingSystem() {
ID retVal = this.getTypedField(3, 0);
return retVal;
}
/**
* Returns
* OM3-3: "Preferred Coding System" - creates it if necessary
*/
public ID getOm33_PreferredCodingSystem() {
ID retVal = this.getTypedField(3, 0);
return retVal;
}
/**
* Returns all repetitions of Valid coded answers (OM3-4).
*/
public CE[] getValidCodedAnswers() {
CE[] retVal = this.getTypedField(4, new CE[0]);
return retVal;
}
/**
* Returns all repetitions of Valid coded answers (OM3-4).
*/
public CE[] getOm34_ValidCodedAnswers() {
CE[] retVal = this.getTypedField(4, new CE[0]);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Valid coded answers (OM3-4).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getValidCodedAnswersReps() {
return this.getReps(4);
}
/**
* Returns a specific repetition of
* OM3-4: "Valid coded answers" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public CE getValidCodedAnswers(int rep) {
CE retVal = this.getTypedField(4, rep);
return retVal;
}
/**
* Returns a specific repetition of
* OM3-4: "Valid coded answers" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public CE getOm34_ValidCodedAnswers(int rep) {
CE retVal = this.getTypedField(4, rep);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Valid coded answers (OM3-4).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getOm34_ValidCodedAnswersReps() {
return this.getReps(4);
}
/**
* Inserts a repetition of
* OM3-4: "Valid coded answers" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CE insertValidCodedAnswers(int rep) throws HL7Exception {
return (CE) super.insertRepetition(4, rep);
}
/**
* Inserts a repetition of
* OM3-4: "Valid coded answers" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CE insertOm34_ValidCodedAnswers(int rep) throws HL7Exception {
return (CE) super.insertRepetition(4, rep);
}
/**
* Removes a repetition of
* OM3-4: "Valid coded answers" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CE removeValidCodedAnswers(int rep) throws HL7Exception {
return (CE) super.removeRepetition(4, rep);
}
/**
* Removes a repetition of
* OM3-4: "Valid coded answers" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CE removeOm34_ValidCodedAnswers(int rep) throws HL7Exception {
return (CE) super.removeRepetition(4, rep);
}
/**
* Returns all repetitions of Normal test codes for categorical observations (OM3-5).
*/
public CE[] getNormalTestCodesForCategoricalObservations() {
CE[] retVal = this.getTypedField(5, new CE[0]);
return retVal;
}
/**
* Returns all repetitions of Normal test codes for categorical observations (OM3-5).
*/
public CE[] getOm35_NormalTestCodesForCategoricalObservations() {
CE[] retVal = this.getTypedField(5, new CE[0]);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Normal test codes for categorical observations (OM3-5).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getNormalTestCodesForCategoricalObservationsReps() {
return this.getReps(5);
}
/**
* Returns a specific repetition of
* OM3-5: "Normal test codes for categorical observations" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public CE getNormalTestCodesForCategoricalObservations(int rep) {
CE retVal = this.getTypedField(5, rep);
return retVal;
}
/**
* Returns a specific repetition of
* OM3-5: "Normal test codes for categorical observations" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public CE getOm35_NormalTestCodesForCategoricalObservations(int rep) {
CE retVal = this.getTypedField(5, rep);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Normal test codes for categorical observations (OM3-5).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getOm35_NormalTestCodesForCategoricalObservationsReps() {
return this.getReps(5);
}
/**
* Inserts a repetition of
* OM3-5: "Normal test codes for categorical observations" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CE insertNormalTestCodesForCategoricalObservations(int rep) throws HL7Exception {
return (CE) super.insertRepetition(5, rep);
}
/**
* Inserts a repetition of
* OM3-5: "Normal test codes for categorical observations" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CE insertOm35_NormalTestCodesForCategoricalObservations(int rep) throws HL7Exception {
return (CE) super.insertRepetition(5, rep);
}
/**
* Removes a repetition of
* OM3-5: "Normal test codes for categorical observations" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CE removeNormalTestCodesForCategoricalObservations(int rep) throws HL7Exception {
return (CE) super.removeRepetition(5, rep);
}
/**
* Removes a repetition of
* OM3-5: "Normal test codes for categorical observations" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CE removeOm35_NormalTestCodesForCategoricalObservations(int rep) throws HL7Exception {
return (CE) super.removeRepetition(5, rep);
}
/**
* Returns
* OM3-6: "Abnormal test codes for categorical observations" - creates it if necessary
*/
public CE getAbnormalTestCodesForCategoricalObservations() {
CE retVal = this.getTypedField(6, 0);
return retVal;
}
/**
* Returns
* OM3-6: "Abnormal test codes for categorical observations" - creates it if necessary
*/
public CE getOm36_AbnormalTestCodesForCategoricalObservations() {
CE retVal = this.getTypedField(6, 0);
return retVal;
}
/**
* Returns
* OM3-7: "Critical test codes for categorical observations" - creates it if necessary
*/
public CE getCriticalTestCodesForCategoricalObservations() {
CE retVal = this.getTypedField(7, 0);
return retVal;
}
/**
* Returns
* OM3-7: "Critical test codes for categorical observations" - creates it if necessary
*/
public CE getOm37_CriticalTestCodesForCategoricalObservations() {
CE retVal = this.getTypedField(7, 0);
return retVal;
}
/**
* Returns
* OM3-8: "Data Type" - creates it if necessary
*/
public ID getDataType() {
ID retVal = this.getTypedField(8, 0);
return retVal;
}
/**
* Returns
* OM3-8: "Data Type" - creates it if necessary
*/
public ID getOm38_DataType() {
ID retVal = this.getTypedField(8, 0);
return retVal;
}
/** {@inheritDoc} */
protected Type createNewTypeWithoutReflection(int field) {
switch (field) {
case 0: return new ST(getMessage());
case 1: return new NM(getMessage());
case 2: return new ID(getMessage(), new Integer( 0 ));
case 3: return new CE(getMessage());
case 4: return new CE(getMessage());
case 5: return new CE(getMessage());
case 6: return new CE(getMessage());
case 7: return new ID(getMessage(), new Integer( 0 ));
default: return null;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy