ca.uhn.hl7v2.model.v24.segment.PRD 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.v24.segment;
// 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 PRD message segment (Provider Data).
* This segment has the following fields:
*
* - PRD-1: Provider Role (CE) repeating
*
- PRD-2: Provider Name (XPN) optional repeating
*
- PRD-3: Provider Address (XAD) optional repeating
*
- PRD-4: Provider Location (PL) optional
*
- PRD-5: Provider Communication Information (XTN) optional repeating
*
- PRD-6: Preferred Method of Contact (CE) optional
*
- PRD-7: Provider Identifiers (PI) optional repeating
*
- PRD-8: Effective Start Date of Provider Role (TS) optional
*
- PRD-9: Effective End Date of Provider Role (TS) optional
*
*/
@SuppressWarnings("unused")
public class PRD extends AbstractSegment {
/**
* Creates a new PRD segment
*/
public PRD(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(CE.class, true, 0, 250, new Object[]{ getMessage() }, "Provider Role");
this.add(XPN.class, false, 0, 250, new Object[]{ getMessage() }, "Provider Name");
this.add(XAD.class, false, 0, 250, new Object[]{ getMessage() }, "Provider Address");
this.add(PL.class, false, 1, 60, new Object[]{ getMessage() }, "Provider Location");
this.add(XTN.class, false, 0, 250, new Object[]{ getMessage() }, "Provider Communication Information");
this.add(CE.class, false, 1, 250, new Object[]{ getMessage() }, "Preferred Method of Contact");
this.add(PI.class, false, 0, 100, new Object[]{ getMessage() }, "Provider Identifiers");
this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Effective Start Date of Provider Role");
this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Effective End Date of Provider Role");
} catch(HL7Exception e) {
log.error("Unexpected error creating PRD - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns all repetitions of Provider Role (PRD-1).
*/
public CE[] getProviderRole() {
CE[] retVal = this.getTypedField(1, new CE[0]);
return retVal;
}
/**
* Returns all repetitions of Provider Role (PRD-1).
*/
public CE[] getPrd1_ProviderRole() {
CE[] retVal = this.getTypedField(1, new CE[0]);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Provider Role (PRD-1).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getProviderRoleReps() {
return this.getReps(1);
}
/**
* Returns a specific repetition of
* PRD-1: "Provider Role" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public CE getProviderRole(int rep) {
CE retVal = this.getTypedField(1, rep);
return retVal;
}
/**
* Returns a specific repetition of
* PRD-1: "Provider Role" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public CE getPrd1_ProviderRole(int rep) {
CE retVal = this.getTypedField(1, rep);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Provider Role (PRD-1).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getPrd1_ProviderRoleReps() {
return this.getReps(1);
}
/**
* Inserts a repetition of
* PRD-1: "Provider Role" 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 insertProviderRole(int rep) throws HL7Exception {
return (CE) super.insertRepetition(1, rep);
}
/**
* Inserts a repetition of
* PRD-1: "Provider Role" 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 insertPrd1_ProviderRole(int rep) throws HL7Exception {
return (CE) super.insertRepetition(1, rep);
}
/**
* Removes a repetition of
* PRD-1: "Provider Role" 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 removeProviderRole(int rep) throws HL7Exception {
return (CE) super.removeRepetition(1, rep);
}
/**
* Removes a repetition of
* PRD-1: "Provider Role" 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 removePrd1_ProviderRole(int rep) throws HL7Exception {
return (CE) super.removeRepetition(1, rep);
}
/**
* Returns all repetitions of Provider Name (PRD-2).
*/
public XPN[] getProviderName() {
XPN[] retVal = this.getTypedField(2, new XPN[0]);
return retVal;
}
/**
* Returns all repetitions of Provider Name (PRD-2).
*/
public XPN[] getPrd2_ProviderName() {
XPN[] retVal = this.getTypedField(2, new XPN[0]);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Provider Name (PRD-2).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getProviderNameReps() {
return this.getReps(2);
}
/**
* Returns a specific repetition of
* PRD-2: "Provider Name" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public XPN getProviderName(int rep) {
XPN retVal = this.getTypedField(2, rep);
return retVal;
}
/**
* Returns a specific repetition of
* PRD-2: "Provider Name" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public XPN getPrd2_ProviderName(int rep) {
XPN retVal = this.getTypedField(2, rep);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Provider Name (PRD-2).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getPrd2_ProviderNameReps() {
return this.getReps(2);
}
/**
* Inserts a repetition of
* PRD-2: "Provider Name" 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 XPN insertProviderName(int rep) throws HL7Exception {
return (XPN) super.insertRepetition(2, rep);
}
/**
* Inserts a repetition of
* PRD-2: "Provider Name" 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 XPN insertPrd2_ProviderName(int rep) throws HL7Exception {
return (XPN) super.insertRepetition(2, rep);
}
/**
* Removes a repetition of
* PRD-2: "Provider Name" 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 XPN removeProviderName(int rep) throws HL7Exception {
return (XPN) super.removeRepetition(2, rep);
}
/**
* Removes a repetition of
* PRD-2: "Provider Name" 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 XPN removePrd2_ProviderName(int rep) throws HL7Exception {
return (XPN) super.removeRepetition(2, rep);
}
/**
* Returns all repetitions of Provider Address (PRD-3).
*/
public XAD[] getProviderAddress() {
XAD[] retVal = this.getTypedField(3, new XAD[0]);
return retVal;
}
/**
* Returns all repetitions of Provider Address (PRD-3).
*/
public XAD[] getPrd3_ProviderAddress() {
XAD[] retVal = this.getTypedField(3, new XAD[0]);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Provider Address (PRD-3).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getProviderAddressReps() {
return this.getReps(3);
}
/**
* Returns a specific repetition of
* PRD-3: "Provider Address" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public XAD getProviderAddress(int rep) {
XAD retVal = this.getTypedField(3, rep);
return retVal;
}
/**
* Returns a specific repetition of
* PRD-3: "Provider Address" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public XAD getPrd3_ProviderAddress(int rep) {
XAD retVal = this.getTypedField(3, rep);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Provider Address (PRD-3).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getPrd3_ProviderAddressReps() {
return this.getReps(3);
}
/**
* Inserts a repetition of
* PRD-3: "Provider Address" 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 insertProviderAddress(int rep) throws HL7Exception {
return (XAD) super.insertRepetition(3, rep);
}
/**
* Inserts a repetition of
* PRD-3: "Provider Address" 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 insertPrd3_ProviderAddress(int rep) throws HL7Exception {
return (XAD) super.insertRepetition(3, rep);
}
/**
* Removes a repetition of
* PRD-3: "Provider Address" 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 removeProviderAddress(int rep) throws HL7Exception {
return (XAD) super.removeRepetition(3, rep);
}
/**
* Removes a repetition of
* PRD-3: "Provider Address" 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 removePrd3_ProviderAddress(int rep) throws HL7Exception {
return (XAD) super.removeRepetition(3, rep);
}
/**
* Returns
* PRD-4: "Provider Location" - creates it if necessary
*/
public PL getProviderLocation() {
PL retVal = this.getTypedField(4, 0);
return retVal;
}
/**
* Returns
* PRD-4: "Provider Location" - creates it if necessary
*/
public PL getPrd4_ProviderLocation() {
PL retVal = this.getTypedField(4, 0);
return retVal;
}
/**
* Returns all repetitions of Provider Communication Information (PRD-5).
*/
public XTN[] getProviderCommunicationInformation() {
XTN[] retVal = this.getTypedField(5, new XTN[0]);
return retVal;
}
/**
* Returns all repetitions of Provider Communication Information (PRD-5).
*/
public XTN[] getPrd5_ProviderCommunicationInformation() {
XTN[] retVal = this.getTypedField(5, new XTN[0]);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Provider Communication Information (PRD-5).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getProviderCommunicationInformationReps() {
return this.getReps(5);
}
/**
* Returns a specific repetition of
* PRD-5: "Provider Communication Information" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public XTN getProviderCommunicationInformation(int rep) {
XTN retVal = this.getTypedField(5, rep);
return retVal;
}
/**
* Returns a specific repetition of
* PRD-5: "Provider Communication Information" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public XTN getPrd5_ProviderCommunicationInformation(int rep) {
XTN retVal = this.getTypedField(5, rep);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Provider Communication Information (PRD-5).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getPrd5_ProviderCommunicationInformationReps() {
return this.getReps(5);
}
/**
* Inserts a repetition of
* PRD-5: "Provider Communication Information" 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 insertProviderCommunicationInformation(int rep) throws HL7Exception {
return (XTN) super.insertRepetition(5, rep);
}
/**
* Inserts a repetition of
* PRD-5: "Provider Communication Information" 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 insertPrd5_ProviderCommunicationInformation(int rep) throws HL7Exception {
return (XTN) super.insertRepetition(5, rep);
}
/**
* Removes a repetition of
* PRD-5: "Provider Communication Information" 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 removeProviderCommunicationInformation(int rep) throws HL7Exception {
return (XTN) super.removeRepetition(5, rep);
}
/**
* Removes a repetition of
* PRD-5: "Provider Communication Information" 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 removePrd5_ProviderCommunicationInformation(int rep) throws HL7Exception {
return (XTN) super.removeRepetition(5, rep);
}
/**
* Returns
* PRD-6: "Preferred Method of Contact" - creates it if necessary
*/
public CE getPreferredMethodOfContact() {
CE retVal = this.getTypedField(6, 0);
return retVal;
}
/**
* Returns
* PRD-6: "Preferred Method of Contact" - creates it if necessary
*/
public CE getPrd6_PreferredMethodOfContact() {
CE retVal = this.getTypedField(6, 0);
return retVal;
}
/**
* Returns all repetitions of Provider Identifiers (PRD-7).
*/
public PI[] getProviderIdentifiers() {
PI[] retVal = this.getTypedField(7, new PI[0]);
return retVal;
}
/**
* Returns all repetitions of Provider Identifiers (PRD-7).
*/
public PI[] getPrd7_ProviderIdentifiers() {
PI[] retVal = this.getTypedField(7, new PI[0]);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Provider Identifiers (PRD-7).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getProviderIdentifiersReps() {
return this.getReps(7);
}
/**
* Returns a specific repetition of
* PRD-7: "Provider Identifiers" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public PI getProviderIdentifiers(int rep) {
PI retVal = this.getTypedField(7, rep);
return retVal;
}
/**
* Returns a specific repetition of
* PRD-7: "Provider Identifiers" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public PI getPrd7_ProviderIdentifiers(int rep) {
PI retVal = this.getTypedField(7, rep);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Provider Identifiers (PRD-7).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getPrd7_ProviderIdentifiersReps() {
return this.getReps(7);
}
/**
* Inserts a repetition of
* PRD-7: "Provider Identifiers" 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 PI insertProviderIdentifiers(int rep) throws HL7Exception {
return (PI) super.insertRepetition(7, rep);
}
/**
* Inserts a repetition of
* PRD-7: "Provider Identifiers" 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 PI insertPrd7_ProviderIdentifiers(int rep) throws HL7Exception {
return (PI) super.insertRepetition(7, rep);
}
/**
* Removes a repetition of
* PRD-7: "Provider Identifiers" 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 PI removeProviderIdentifiers(int rep) throws HL7Exception {
return (PI) super.removeRepetition(7, rep);
}
/**
* Removes a repetition of
* PRD-7: "Provider Identifiers" 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 PI removePrd7_ProviderIdentifiers(int rep) throws HL7Exception {
return (PI) super.removeRepetition(7, rep);
}
/**
* Returns
* PRD-8: "Effective Start Date of Provider Role" - creates it if necessary
*/
public TS getEffectiveStartDateOfProviderRole() {
TS retVal = this.getTypedField(8, 0);
return retVal;
}
/**
* Returns
* PRD-8: "Effective Start Date of Provider Role" - creates it if necessary
*/
public TS getPrd8_EffectiveStartDateOfProviderRole() {
TS retVal = this.getTypedField(8, 0);
return retVal;
}
/**
* Returns
* PRD-9: "Effective End Date of Provider Role" - creates it if necessary
*/
public TS getEffectiveEndDateOfProviderRole() {
TS retVal = this.getTypedField(9, 0);
return retVal;
}
/**
* Returns
* PRD-9: "Effective End Date of Provider Role" - creates it if necessary
*/
public TS getPrd9_EffectiveEndDateOfProviderRole() {
TS retVal = this.getTypedField(9, 0);
return retVal;
}
/** {@inheritDoc} */
protected Type createNewTypeWithoutReflection(int field) {
switch (field) {
case 0: return new CE(getMessage());
case 1: return new XPN(getMessage());
case 2: return new XAD(getMessage());
case 3: return new PL(getMessage());
case 4: return new XTN(getMessage());
case 5: return new CE(getMessage());
case 6: return new PI(getMessage());
case 7: return new TS(getMessage());
case 8: return new TS(getMessage());
default: return null;
}
}
}