ca.uhn.hl7v2.model.v251.group

Class RSP_Z90_PATIENT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.RSP_Z90_PATIENT

All Implemented Interfaces:

Group, Structure, Serializable

public class RSP_Z90_PATIENT
extends AbstractGroup

Represents a RSP_Z90_PATIENT 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: PID (Patient Identification)
• 2: PD1 (Patient Additional Demographic) optional
• 3: NK1 (Next of Kin / Associated Parties) optional repeating
• 4: NTE (Notes and Comments) optional repeating
• 5: RSP_Z90_VISIT (a Group object) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
NK1	getNK1() Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
NK1	getNK1(int rep) Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
List<NK1>	getNK1All() Returns a non-modifiable List containing all current existing repetitions of NK1.
int	getNK1Reps() Returns the number of existing repetitions of NK1
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
PD1	getPD1() Returns PD1 (Patient Additional Demographic) - creates it if necessary
PID	getPID() Returns PID (Patient Identification) - creates it if necessary
String	getVersion() Returns "2.5.1"
RSP_Z90_VISIT	getVISIT() Returns VISIT (a Group object) - creates it if necessary
NK1	insertNK1(int rep) Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
void	insertNK1(NK1 structure, int rep) Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)

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

RSP_Z90_PATIENT

public RSP_Z90_PATIENT(Group parent,
               ModelClassFactory factory)

Creates a new RSP_Z90_PATIENT group

Method Detail

getVersion

public String getVersion()

Returns "2.5.1"

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPD1

public PD1 getPD1()

Returns PD1 (Patient Additional Demographic) - creates it if necessary

getNK1

public NK1 getNK1()

Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary

getNK1

public NK1 getNK1(int rep)

Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - 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.

getNK1Reps

public int getNK1Reps()

Returns the number of existing repetitions of NK1

getNK1All

public List<NK1> getNK1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNK1

public void insertNK1(NK1 structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getVISIT

public RSP_Z90_VISIT getVISIT()

Returns VISIT (a Group object) - creates it if necessary