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

ca.uhn.hl7v2.model.v28.segment.ROL 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) 
 * 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.v28.segment;

// import ca.uhn.hl7v2.model.v28.group.*;
import ca.uhn.hl7v2.model.v28.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 ROL message segment (Role). * This segment has the following fields:

*
    *
  • ROL-1: Role Instance ID (EI) optional *
  • ROL-2: Action Code (ID) *
  • ROL-3: Role-ROL (CWE) *
  • ROL-4: Role Person (XCN) repeating *
  • ROL-5: Role Begin Date/Time (DTM) optional *
  • ROL-6: Role End Date/Time (DTM) optional *
  • ROL-7: Role Duration (CWE) optional *
  • ROL-8: Role Action Reason (CWE) optional *
  • ROL-9: Provider Type (CWE) optional repeating *
  • ROL-10: Organization Unit Type (CWE) optional *
  • ROL-11: Office/Home Address/Birthplace (XAD) optional repeating *
  • ROL-12: Phone (XTN) optional repeating *
  • ROL-13: Person's Location (PL) optional *
  • ROL-14: Organization (XON) optional *
*/ @SuppressWarnings("unused") public class ROL extends AbstractSegment { /** * Creates a new ROL segment */ public ROL(Group parent, ModelClassFactory factory) { super(parent, factory); init(factory); } private void init(ModelClassFactory factory) { try { this.add(EI.class, false, 1, 0, new Object[]{ getMessage() }, "Role Instance ID"); this.add(ID.class, true, 1, 2, new Object[]{ getMessage(), new Integer(206) }, "Action Code"); this.add(CWE.class, true, 1, 0, new Object[]{ getMessage() }, "Role-ROL"); this.add(XCN.class, true, 0, 0, new Object[]{ getMessage() }, "Role Person"); this.add(DTM.class, false, 1, 0, new Object[]{ getMessage() }, "Role Begin Date/Time"); this.add(DTM.class, false, 1, 0, new Object[]{ getMessage() }, "Role End Date/Time"); this.add(CWE.class, false, 1, 0, new Object[]{ getMessage() }, "Role Duration"); this.add(CWE.class, false, 1, 0, new Object[]{ getMessage() }, "Role Action Reason"); this.add(CWE.class, false, 0, 0, new Object[]{ getMessage() }, "Provider Type"); this.add(CWE.class, false, 1, 0, new Object[]{ getMessage() }, "Organization Unit Type"); this.add(XAD.class, false, 0, 0, new Object[]{ getMessage() }, "Office/Home Address/Birthplace"); this.add(XTN.class, false, 0, 0, new Object[]{ getMessage() }, "Phone"); this.add(PL.class, false, 1, 0, new Object[]{ getMessage() }, "Person's Location"); this.add(XON.class, false, 1, 0, new Object[]{ getMessage() }, "Organization"); } catch(HL7Exception e) { log.error("Unexpected error creating ROL - this is probably a bug in the source code generator.", e); } } /** * Returns * ROL-1: "Role Instance ID" - creates it if necessary */ public EI getRoleInstanceID() { EI retVal = this.getTypedField(1, 0); return retVal; } /** * Returns * ROL-1: "Role Instance ID" - creates it if necessary */ public EI getRol1_RoleInstanceID() { EI retVal = this.getTypedField(1, 0); return retVal; } /** * Returns * ROL-2: "Action Code" - creates it if necessary */ public ID getActionCode() { ID retVal = this.getTypedField(2, 0); return retVal; } /** * Returns * ROL-2: "Action Code" - creates it if necessary */ public ID getRol2_ActionCode() { ID retVal = this.getTypedField(2, 0); return retVal; } /** * Returns * ROL-3: "Role-ROL" - creates it if necessary */ public CWE getRoleROL() { CWE retVal = this.getTypedField(3, 0); return retVal; } /** * Returns * ROL-3: "Role-ROL" - creates it if necessary */ public CWE getRol3_RoleROL() { CWE retVal = this.getTypedField(3, 0); return retVal; } /** * Returns all repetitions of Role Person (ROL-4). */ public XCN[] getRolePerson() { XCN[] retVal = this.getTypedField(4, new XCN[0]); return retVal; } /** * Returns all repetitions of Role Person (ROL-4). */ public XCN[] getRol4_RolePerson() { XCN[] retVal = this.getTypedField(4, new XCN[0]); return retVal; } /** * Returns a count of the current number of repetitions of Role Person (ROL-4). * This method does not create a repetition, so if no repetitions have currently been defined or accessed, * it will return zero. */ public int getRolePersonReps() { return this.getReps(4); } /** * Returns a specific repetition of * ROL-4: "Role Person" - creates it if necessary * * @param rep The repetition index (0-indexed) */ public XCN getRolePerson(int rep) { XCN retVal = this.getTypedField(4, rep); return retVal; } /** * Returns a specific repetition of * ROL-4: "Role Person" - creates it if necessary * * @param rep The repetition index (0-indexed) */ public XCN getRol4_RolePerson(int rep) { XCN retVal = this.getTypedField(4, rep); return retVal; } /** * Returns a count of the current number of repetitions of Role Person (ROL-4). * This method does not create a repetition, so if no repetitions have currently been defined or accessed, * it will return zero. */ public int getRol4_RolePersonReps() { return this.getReps(4); } /** * Inserts a repetition of * ROL-4: "Role Person" 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 XCN insertRolePerson(int rep) throws HL7Exception { return (XCN) super.insertRepetition(4, rep); } /** * Inserts a repetition of * ROL-4: "Role Person" 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 XCN insertRol4_RolePerson(int rep) throws HL7Exception { return (XCN) super.insertRepetition(4, rep); } /** * Removes a repetition of * ROL-4: "Role Person" 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 XCN removeRolePerson(int rep) throws HL7Exception { return (XCN) super.removeRepetition(4, rep); } /** * Removes a repetition of * ROL-4: "Role Person" 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 XCN removeRol4_RolePerson(int rep) throws HL7Exception { return (XCN) super.removeRepetition(4, rep); } /** * Returns * ROL-5: "Role Begin Date/Time" - creates it if necessary */ public DTM getRoleBeginDateTime() { DTM retVal = this.getTypedField(5, 0); return retVal; } /** * Returns * ROL-5: "Role Begin Date/Time" - creates it if necessary */ public DTM getRol5_RoleBeginDateTime() { DTM retVal = this.getTypedField(5, 0); return retVal; } /** * Returns * ROL-6: "Role End Date/Time" - creates it if necessary */ public DTM getRoleEndDateTime() { DTM retVal = this.getTypedField(6, 0); return retVal; } /** * Returns * ROL-6: "Role End Date/Time" - creates it if necessary */ public DTM getRol6_RoleEndDateTime() { DTM retVal = this.getTypedField(6, 0); return retVal; } /** * Returns * ROL-7: "Role Duration" - creates it if necessary */ public CWE getRoleDuration() { CWE retVal = this.getTypedField(7, 0); return retVal; } /** * Returns * ROL-7: "Role Duration" - creates it if necessary */ public CWE getRol7_RoleDuration() { CWE retVal = this.getTypedField(7, 0); return retVal; } /** * Returns * ROL-8: "Role Action Reason" - creates it if necessary */ public CWE getRoleActionReason() { CWE retVal = this.getTypedField(8, 0); return retVal; } /** * Returns * ROL-8: "Role Action Reason" - creates it if necessary */ public CWE getRol8_RoleActionReason() { CWE retVal = this.getTypedField(8, 0); return retVal; } /** * Returns all repetitions of Provider Type (ROL-9). */ public CWE[] getProviderType() { CWE[] retVal = this.getTypedField(9, new CWE[0]); return retVal; } /** * Returns all repetitions of Provider Type (ROL-9). */ public CWE[] getRol9_ProviderType() { CWE[] retVal = this.getTypedField(9, new CWE[0]); return retVal; } /** * Returns a count of the current number of repetitions of Provider Type (ROL-9). * This method does not create a repetition, so if no repetitions have currently been defined or accessed, * it will return zero. */ public int getProviderTypeReps() { return this.getReps(9); } /** * Returns a specific repetition of * ROL-9: "Provider Type" - creates it if necessary * * @param rep The repetition index (0-indexed) */ public CWE getProviderType(int rep) { CWE retVal = this.getTypedField(9, rep); return retVal; } /** * Returns a specific repetition of * ROL-9: "Provider Type" - creates it if necessary * * @param rep The repetition index (0-indexed) */ public CWE getRol9_ProviderType(int rep) { CWE retVal = this.getTypedField(9, rep); return retVal; } /** * Returns a count of the current number of repetitions of Provider Type (ROL-9). * This method does not create a repetition, so if no repetitions have currently been defined or accessed, * it will return zero. */ public int getRol9_ProviderTypeReps() { return this.getReps(9); } /** * Inserts a repetition of * ROL-9: "Provider Type" 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 CWE insertProviderType(int rep) throws HL7Exception { return (CWE) super.insertRepetition(9, rep); } /** * Inserts a repetition of * ROL-9: "Provider Type" 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 CWE insertRol9_ProviderType(int rep) throws HL7Exception { return (CWE) super.insertRepetition(9, rep); } /** * Removes a repetition of * ROL-9: "Provider Type" 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 CWE removeProviderType(int rep) throws HL7Exception { return (CWE) super.removeRepetition(9, rep); } /** * Removes a repetition of * ROL-9: "Provider Type" 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 CWE removeRol9_ProviderType(int rep) throws HL7Exception { return (CWE) super.removeRepetition(9, rep); } /** * Returns * ROL-10: "Organization Unit Type" - creates it if necessary */ public CWE getOrganizationUnitType() { CWE retVal = this.getTypedField(10, 0); return retVal; } /** * Returns * ROL-10: "Organization Unit Type" - creates it if necessary */ public CWE getRol10_OrganizationUnitType() { CWE retVal = this.getTypedField(10, 0); return retVal; } /** * Returns all repetitions of Office/Home Address/Birthplace (ROL-11). */ public XAD[] getOfficeHomeAddressBirthplace() { XAD[] retVal = this.getTypedField(11, new XAD[0]); return retVal; } /** * Returns all repetitions of Office/Home Address/Birthplace (ROL-11). */ public XAD[] getRol11_OfficeHomeAddressBirthplace() { XAD[] retVal = this.getTypedField(11, new XAD[0]); return retVal; } /** * Returns a count of the current number of repetitions of Office/Home Address/Birthplace (ROL-11). * This method does not create a repetition, so if no repetitions have currently been defined or accessed, * it will return zero. */ public int getOfficeHomeAddressBirthplaceReps() { return this.getReps(11); } /** * Returns a specific repetition of * ROL-11: "Office/Home Address/Birthplace" - creates it if necessary * * @param rep The repetition index (0-indexed) */ public XAD getOfficeHomeAddressBirthplace(int rep) { XAD retVal = this.getTypedField(11, rep); return retVal; } /** * Returns a specific repetition of * ROL-11: "Office/Home Address/Birthplace" - creates it if necessary * * @param rep The repetition index (0-indexed) */ public XAD getRol11_OfficeHomeAddressBirthplace(int rep) { XAD retVal = this.getTypedField(11, rep); return retVal; } /** * Returns a count of the current number of repetitions of Office/Home Address/Birthplace (ROL-11). * This method does not create a repetition, so if no repetitions have currently been defined or accessed, * it will return zero. */ public int getRol11_OfficeHomeAddressBirthplaceReps() { return this.getReps(11); } /** * Inserts a repetition of * ROL-11: "Office/Home Address/Birthplace" 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 XAD insertOfficeHomeAddressBirthplace(int rep) throws HL7Exception { return (XAD) super.insertRepetition(11, rep); } /** * Inserts a repetition of * ROL-11: "Office/Home Address/Birthplace" 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 XAD insertRol11_OfficeHomeAddressBirthplace(int rep) throws HL7Exception { return (XAD) super.insertRepetition(11, rep); } /** * Removes a repetition of * ROL-11: "Office/Home Address/Birthplace" 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 XAD removeOfficeHomeAddressBirthplace(int rep) throws HL7Exception { return (XAD) super.removeRepetition(11, rep); } /** * Removes a repetition of * ROL-11: "Office/Home Address/Birthplace" 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 XAD removeRol11_OfficeHomeAddressBirthplace(int rep) throws HL7Exception { return (XAD) super.removeRepetition(11, rep); } /** * Returns all repetitions of Phone (ROL-12). */ public XTN[] getPhone() { XTN[] retVal = this.getTypedField(12, new XTN[0]); return retVal; } /** * Returns all repetitions of Phone (ROL-12). */ public XTN[] getRol12_Phone() { XTN[] retVal = this.getTypedField(12, new XTN[0]); return retVal; } /** * Returns a count of the current number of repetitions of Phone (ROL-12). * This method does not create a repetition, so if no repetitions have currently been defined or accessed, * it will return zero. */ public int getPhoneReps() { return this.getReps(12); } /** * Returns a specific repetition of * ROL-12: "Phone" - creates it if necessary * * @param rep The repetition index (0-indexed) */ public XTN getPhone(int rep) { XTN retVal = this.getTypedField(12, rep); return retVal; } /** * Returns a specific repetition of * ROL-12: "Phone" - creates it if necessary * * @param rep The repetition index (0-indexed) */ public XTN getRol12_Phone(int rep) { XTN retVal = this.getTypedField(12, rep); return retVal; } /** * Returns a count of the current number of repetitions of Phone (ROL-12). * This method does not create a repetition, so if no repetitions have currently been defined or accessed, * it will return zero. */ public int getRol12_PhoneReps() { return this.getReps(12); } /** * Inserts a repetition of * ROL-12: "Phone" 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 XTN insertPhone(int rep) throws HL7Exception { return (XTN) super.insertRepetition(12, rep); } /** * Inserts a repetition of * ROL-12: "Phone" 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 XTN insertRol12_Phone(int rep) throws HL7Exception { return (XTN) super.insertRepetition(12, rep); } /** * Removes a repetition of * ROL-12: "Phone" 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 XTN removePhone(int rep) throws HL7Exception { return (XTN) super.removeRepetition(12, rep); } /** * Removes a repetition of * ROL-12: "Phone" 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 XTN removeRol12_Phone(int rep) throws HL7Exception { return (XTN) super.removeRepetition(12, rep); } /** * Returns * ROL-13: "Person's Location" - creates it if necessary */ public PL getPersonSLocation() { PL retVal = this.getTypedField(13, 0); return retVal; } /** * Returns * ROL-13: "Person's Location" - creates it if necessary */ public PL getRol13_PersonSLocation() { PL retVal = this.getTypedField(13, 0); return retVal; } /** * Returns * ROL-14: "Organization" - creates it if necessary */ public XON getOrganization() { XON retVal = this.getTypedField(14, 0); return retVal; } /** * Returns * ROL-14: "Organization" - creates it if necessary */ public XON getRol14_Organization() { XON retVal = this.getTypedField(14, 0); return retVal; } /** {@inheritDoc} */ protected Type createNewTypeWithoutReflection(int field) { switch (field) { case 0: return new EI(getMessage()); case 1: return new ID(getMessage(), new Integer( 206 )); case 2: return new CWE(getMessage()); case 3: return new XCN(getMessage()); case 4: return new DTM(getMessage()); case 5: return new DTM(getMessage()); case 6: return new CWE(getMessage()); case 7: return new CWE(getMessage()); case 8: return new CWE(getMessage()); case 9: return new CWE(getMessage()); case 10: return new XAD(getMessage()); case 11: return new XTN(getMessage()); case 12: return new PL(getMessage()); case 13: return new XON(getMessage()); default: return null; } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy