ca.uhn.hl7v2.model.v251.group

Class REF_I12_PROVIDER_CONTACT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.REF_I12_PROVIDER_CONTACT

All Implemented Interfaces:

Group, Structure, Serializable

public class REF_I12_PROVIDER_CONTACT
extends AbstractGroup

Represents a REF_I12_PROVIDER_CONTACT group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: PRD (Provider Data)
• 2: CTD (Contact Data) optional repeating

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
REF_I12_PROVIDER_CONTACT(Group parent, ModelClassFactory factory) Creates a new REF_I12_PROVIDER_CONTACT group

Method Summary

Methods

Modifier and Type	Method and Description
CTD	getCTD() Returns the first repetition of CTD (Contact Data) - creates it if necessary
CTD	getCTD(int rep) Returns a specific repetition of CTD (Contact Data) - creates it if necessary
List<CTD>	getCTDAll() Returns a non-modifiable List containing all current existing repetitions of CTD.
int	getCTDReps() Returns the number of existing repetitions of CTD
PRD	getPRD() Returns PRD (Provider Data) - creates it if necessary
String	getVersion() Returns "2.5.1"
void	insertCTD(CTD structure, int rep) Inserts a specific repetition of CTD (Contact Data)
CTD	insertCTD(int rep) Inserts a specific repetition of CTD (Contact Data)
CTD	removeCTD(int rep) Removes a specific repetition of CTD (Contact Data)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Detail

REF_I12_PROVIDER_CONTACT

public REF_I12_PROVIDER_CONTACT(Group parent,
                        ModelClassFactory factory)

Creates a new REF_I12_PROVIDER_CONTACT group

Method Detail

getVersion

public String getVersion()

Returns "2.5.1"

getPRD

public PRD getPRD()

Returns PRD (Provider Data) - creates it if necessary

getCTD

public CTD getCTD()

Returns the first repetition of CTD (Contact Data) - creates it if necessary

getCTD

public CTD getCTD(int rep)

Returns a specific repetition of CTD (Contact Data) - creates it if necessary

Parameters:

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.

getCTDReps

public int getCTDReps()

Returns the number of existing repetitions of CTD

getCTDAll

public List<CTD> getCTDAll()
                    throws HL7Exception

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

Note that unlike getCTD(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertCTD

public void insertCTD(CTD structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of CTD (Contact Data)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCTD

public CTD insertCTD(int rep)
              throws HL7Exception

Inserts a specific repetition of CTD (Contact Data)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCTD

public CTD removeCTD(int rep)
              throws HL7Exception

Removes a specific repetition of CTD (Contact Data)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)