All Downloads are FREE. Search and download functionalities are using the official Maven repository.

ca.uhn.hl7v2.model.v24.segment.OM4 Maven / Gradle / Ivy

There is a newer version: 2.5.1
Show newest version
/*
 * 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.segment;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

// import ca.uhn.hl7v2.model.v24.group.*;
import ca.uhn.hl7v2.model.v24.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 OM4 message segment (Observations that Require Specimens). * This segment has the following fields:

*
    *
  • OM4-1: Sequence Number - Test/ Observation Master File (NM) optional *
  • OM4-2: Derived Specimen (ID) optional *
  • OM4-3: Container Description (TX) optional *
  • OM4-4: Container Volume (NM) optional *
  • OM4-5: Container Units (CE) optional *
  • OM4-6: Specimen (CE) optional *
  • OM4-7: Additive (CE) optional *
  • OM4-8: Preparation (TX) optional *
  • OM4-9: Special Handling Requirements (TX) optional *
  • OM4-10: Normal Collection Volume (CQ) optional *
  • OM4-11: Minimum Collection Volume (CQ) optional *
  • OM4-12: Specimen Requirements (TX) optional *
  • OM4-13: Specimen Priorities (ID) optional repeating *
  • OM4-14: Specimen Retention Time (CQ) optional *
*/ @SuppressWarnings("unused") public class OM4 extends AbstractSegment { /** * Creates a new OM4 segment */ public OM4(Group parent, ModelClassFactory factory) { super(parent, factory); init(factory); } private void init(ModelClassFactory factory) { try { this.add(NM.class, false, 1, 4, new Object[]{ getMessage() }, "Sequence Number - Test/ Observation Master File"); this.add(ID.class, false, 1, 1, new Object[]{ getMessage(), new Integer(170) }, "Derived Specimen"); this.add(TX.class, false, 1, 60, new Object[]{ getMessage() }, "Container Description"); this.add(NM.class, false, 1, 20, new Object[]{ getMessage() }, "Container Volume"); this.add(CE.class, false, 1, 250, new Object[]{ getMessage() }, "Container Units"); this.add(CE.class, false, 1, 250, new Object[]{ getMessage() }, "Specimen"); this.add(CE.class, false, 1, 250, new Object[]{ getMessage() }, "Additive"); this.add(TX.class, false, 1, 10240, new Object[]{ getMessage() }, "Preparation"); this.add(TX.class, false, 1, 10240, new Object[]{ getMessage() }, "Special Handling Requirements"); this.add(CQ.class, false, 1, 20, new Object[]{ getMessage() }, "Normal Collection Volume"); this.add(CQ.class, false, 1, 20, new Object[]{ getMessage() }, "Minimum Collection Volume"); this.add(TX.class, false, 1, 10240, new Object[]{ getMessage() }, "Specimen Requirements"); this.add(ID.class, false, 0, 1, new Object[]{ getMessage(), new Integer(27) }, "Specimen Priorities"); this.add(CQ.class, false, 1, 20, new Object[]{ getMessage() }, "Specimen Retention Time"); } catch(HL7Exception e) { LoggerFactory.getLogger(getClass()).error("Unexpected error creating OM4 - this is probably a bug in the source code generator.", e); } } /** * Returns * OM4-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary */ public NM getSequenceNumberTestObservationMasterFile() { NM ret = null; try { Type t = this.getField(1, 0); ret = (NM)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-1: "Sequence Number - Test/ Observation Master File" - creates it if necessary */ public NM getOm41_SequenceNumberTestObservationMasterFile() { NM ret = null; try { Type t = this.getField(1, 0); ret = (NM)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-2: "Derived Specimen" - creates it if necessary */ public ID getDerivedSpecimen() { ID ret = null; try { Type t = this.getField(2, 0); ret = (ID)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-2: "Derived Specimen" - creates it if necessary */ public ID getOm42_DerivedSpecimen() { ID ret = null; try { Type t = this.getField(2, 0); ret = (ID)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-3: "Container Description" - creates it if necessary */ public TX getContainerDescription() { TX ret = null; try { Type t = this.getField(3, 0); ret = (TX)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-3: "Container Description" - creates it if necessary */ public TX getOm43_ContainerDescription() { TX ret = null; try { Type t = this.getField(3, 0); ret = (TX)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-4: "Container Volume" - creates it if necessary */ public NM getContainerVolume() { NM ret = null; try { Type t = this.getField(4, 0); ret = (NM)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-4: "Container Volume" - creates it if necessary */ public NM getOm44_ContainerVolume() { NM ret = null; try { Type t = this.getField(4, 0); ret = (NM)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-5: "Container Units" - creates it if necessary */ public CE getContainerUnits() { CE ret = null; try { Type t = this.getField(5, 0); ret = (CE)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-5: "Container Units" - creates it if necessary */ public CE getOm45_ContainerUnits() { CE ret = null; try { Type t = this.getField(5, 0); ret = (CE)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-6: "Specimen" - creates it if necessary */ public CE getSpecimen() { CE ret = null; try { Type t = this.getField(6, 0); ret = (CE)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-6: "Specimen" - creates it if necessary */ public CE getOm46_Specimen() { CE ret = null; try { Type t = this.getField(6, 0); ret = (CE)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-7: "Additive" - creates it if necessary */ public CE getAdditive() { CE ret = null; try { Type t = this.getField(7, 0); ret = (CE)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-7: "Additive" - creates it if necessary */ public CE getOm47_Additive() { CE ret = null; try { Type t = this.getField(7, 0); ret = (CE)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-8: "Preparation" - creates it if necessary */ public TX getPreparation() { TX ret = null; try { Type t = this.getField(8, 0); ret = (TX)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-8: "Preparation" - creates it if necessary */ public TX getOm48_Preparation() { TX ret = null; try { Type t = this.getField(8, 0); ret = (TX)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-9: "Special Handling Requirements" - creates it if necessary */ public TX getSpecialHandlingRequirements() { TX ret = null; try { Type t = this.getField(9, 0); ret = (TX)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-9: "Special Handling Requirements" - creates it if necessary */ public TX getOm49_SpecialHandlingRequirements() { TX ret = null; try { Type t = this.getField(9, 0); ret = (TX)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-10: "Normal Collection Volume" - creates it if necessary */ public CQ getNormalCollectionVolume() { CQ ret = null; try { Type t = this.getField(10, 0); ret = (CQ)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-10: "Normal Collection Volume" - creates it if necessary */ public CQ getOm410_NormalCollectionVolume() { CQ ret = null; try { Type t = this.getField(10, 0); ret = (CQ)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-11: "Minimum Collection Volume" - creates it if necessary */ public CQ getMinimumCollectionVolume() { CQ ret = null; try { Type t = this.getField(11, 0); ret = (CQ)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-11: "Minimum Collection Volume" - creates it if necessary */ public CQ getOm411_MinimumCollectionVolume() { CQ ret = null; try { Type t = this.getField(11, 0); ret = (CQ)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-12: "Specimen Requirements" - creates it if necessary */ public TX getSpecimenRequirements() { TX ret = null; try { Type t = this.getField(12, 0); ret = (TX)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-12: "Specimen Requirements" - creates it if necessary */ public TX getOm412_SpecimenRequirements() { TX ret = null; try { Type t = this.getField(12, 0); ret = (TX)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns all repetitions of Specimen Priorities (OM4-13). */ public ID[] getSpecimenPriorities() { ID[] ret = null; try { Type[] t = this.getField(13); ret = new ID[t.length]; for (int i = 0; i < ret.length; i++) { ret[i] = (ID)t[i]; } } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns a count of the current number of repetitions of Specimen Priorities (OM4-13). * This method does not create a repetition, so if no repetitions have currently been defined or accessed, * it will return zero. */ public int getSpecimenPrioritiesReps() { ID[] ret = null; try { Type[] t = this.getField(13); return t.length; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } } /** * Returns a specific repetition of * OM4-13: "Specimen Priorities" - creates it if necessary * * @param rep The repetition index (0-indexed) */ public ID getSpecimenPriorities(int rep) { ID ret = null; try { Type t = this.getField(13, rep); ret = (ID)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns a specific repetition of * OM4-13: "Specimen Priorities" - creates it if necessary * * @param rep The repetition index (0-indexed) */ public ID getOm413_SpecimenPriorities(int rep) { ID ret = null; try { Type t = this.getField(13, rep); ret = (ID)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns a count of the current number of repetitions of Specimen Priorities (OM4-13). * This method does not create a repetition, so if no repetitions have currently been defined or accessed, * it will return zero. */ public int getOm413_SpecimenPrioritiesReps() { ID[] ret = null; try { Type[] t = this.getField(13); return t.length; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } } /** * Inserts a repetition of * OM4-13: "Specimen Priorities" 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 ID insertSpecimenPriorities(int rep) throws HL7Exception { return (ID) super.insertRepetition(13, rep); } /** * Inserts a repetition of * OM4-13: "Specimen Priorities" 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 ID insertOm413_SpecimenPriorities(int rep) throws HL7Exception { return (ID) super.insertRepetition(13, rep); } /** * Removes a repetition of * OM4-13: "Specimen Priorities" 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 ID removeSpecimenPriorities(int rep) throws HL7Exception { return (ID) super.removeRepetition(13, rep); } /** * Removes a repetition of * OM4-13: "Specimen Priorities" 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 ID removeOm413_SpecimenPriorities(int rep) throws HL7Exception { return (ID) super.removeRepetition(13, rep); } /** * Returns * OM4-14: "Specimen Retention Time" - creates it if necessary */ public CQ getSpecimenRetentionTime() { CQ ret = null; try { Type t = this.getField(14, 0); ret = (CQ)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** * Returns * OM4-14: "Specimen Retention Time" - creates it if necessary */ public CQ getOm414_SpecimenRetentionTime() { CQ ret = null; try { Type t = this.getField(14, 0); ret = (CQ)t; } catch (ClassCastException cce) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce); throw new RuntimeException(cce); } catch (HL7Exception he) { LoggerFactory.getLogger(getClass()).error("Unexpected problem obtaining field value. This is a bug.", he); throw new RuntimeException(he); } return ret; } /** {@inheritDoc} */ protected Type createNewTypeWithoutReflection(int field) { switch (field) { case 0: return new NM(getMessage()); case 1: return new ID(getMessage(), new Integer( 170 )); case 2: return new TX(getMessage()); case 3: return new NM(getMessage()); case 4: return new CE(getMessage()); case 5: return new CE(getMessage()); case 6: return new CE(getMessage()); case 7: return new TX(getMessage()); case 8: return new TX(getMessage()); case 9: return new CQ(getMessage()); case 10: return new CQ(getMessage()); case 11: return new TX(getMessage()); case 12: return new ID(getMessage(), new Integer( 27 )); case 13: return new CQ(getMessage()); default: return null; } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy