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

ca.uhn.hl7v2.model.v26.message.CRM_C01 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 CRM_C01 message structure (see chapter 7.7.1). This structure contains the * following elements:

*
    *
  • 1: MSH (Message Header)
  • *
  • 2: SFT (Software Segment) optional repeating
  • *
  • 3: UAC (User Authentication Credential Segment) optional
  • *
  • 4: CRM_C01_PATIENT (a Group object) repeating
  • *
*/ //@SuppressWarnings("unused") public class CRM_C01 extends AbstractMessage { /** * Creates a new CRM_C01 message with DefaultModelClassFactory. */ public CRM_C01() { this(new DefaultModelClassFactory()); } /** * Creates a new CRM_C01 message with custom ModelClassFactory. */ public CRM_C01(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(CRM_C01_PATIENT.class, true, true); } catch(HL7Exception e) { log.error("Unexpected error creating CRM_C01 - 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 * the first repetition of * PATIENT (a Group object) - creates it if necessary *

* * */ public CRM_C01_PATIENT getPATIENT() { return getTyped("PATIENT", CRM_C01_PATIENT.class); } /** *

* Returns a specific repetition of * PATIENT (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 CRM_C01_PATIENT getPATIENT(int rep) { return getTyped("PATIENT", rep, CRM_C01_PATIENT.class); } /** *

* Returns the number of existing repetitions of PATIENT *

* */ public int getPATIENTReps() { return getReps("PATIENT"); } /** *

* Returns a non-modifiable List containing all current existing repetitions of PATIENT. *

*

* Note that unlike {@link #getPATIENT()}, this method will not create any reps * if none are already present, so an empty list may be returned. *

* */ public java.util.List getPATIENTAll() throws HL7Exception { return getAllAsList("PATIENT", CRM_C01_PATIENT.class); } /** *

* Inserts a specific repetition of PATIENT (a Group object) *

* * * @see AbstractGroup#insertRepetition(Structure, int) */ public void insertPATIENT(CRM_C01_PATIENT structure, int rep) throws HL7Exception { super.insertRepetition( "PATIENT", structure, rep); } /** *

* Inserts a specific repetition of PATIENT (a Group object) *

* * * @see AbstractGroup#insertRepetition(Structure, int) */ public CRM_C01_PATIENT insertPATIENT(int rep) throws HL7Exception { return (CRM_C01_PATIENT)super.insertRepetition("PATIENT", rep); } /** *

* Removes a specific repetition of PATIENT (a Group object) *

* * * @see AbstractGroup#removeRepetition(String, int) */ public CRM_C01_PATIENT removePATIENT(int rep) throws HL7Exception { return (CRM_C01_PATIENT)super.removeRepetition("PATIENT", rep); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy