ca.uhn.hl7v2.model.v281.group

Class RSP_K21_QUERY_RESPONSE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.RSP_K21_QUERY_RESPONSE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RSP_K21_QUERY_RESPONSE
extends AbstractGroup

Represents a RSP_K21_QUERY_RESPONSE 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: ARV (Access Restriction) optional repeating
• 4: NK1 (Next of Kin / Associated Parties) optional repeating
• 5: QRI (Query Response Instance)

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ARV	getARV() Returns the first repetition of ARV (Access Restriction) - creates it if necessary
ARV	getARV(int rep) Returns a specific repetition of ARV (Access Restriction) - creates it if necessary
List<ARV>	getARVAll() Returns a non-modifiable List containing all current existing repetitions of ARV.
int	getARVReps() Returns the number of existing repetitions of ARV
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
PD1	getPD1() Returns PD1 (Patient Additional Demographic) - creates it if necessary
PID	getPID() Returns PID (Patient Identification) - creates it if necessary
QRI	getQRI() Returns QRI (Query Response Instance) - creates it if necessary
String	getVersion() Returns "2.8.1"
void	insertARV(ARV structure, int rep) Inserts a specific repetition of ARV (Access Restriction)
ARV	insertARV(int rep) Inserts a specific repetition of ARV (Access Restriction)
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)
ARV	removeARV(int rep) Removes a specific repetition of ARV (Access Restriction)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (Next of Kin / Associated Parties)

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

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

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_K21_QUERY_RESPONSE

public RSP_K21_QUERY_RESPONSE(Group parent,
                              ModelClassFactory factory)

Creates a new RSP_K21_QUERY_RESPONSE group

Method Detail

getVersion

public String getVersion()

Returns "2.8.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

getARV

public ARV getARV()

Returns the first repetition of ARV (Access Restriction) - creates it if necessary

getARV

public ARV getARV(int rep)

Returns a specific repetition of ARV (Access Restriction) - 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.

getARVReps

public int getARVReps()

Returns the number of existing repetitions of ARV

getARVAll

public List<ARV> getARVAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertARV

public void insertARV(ARV structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of ARV (Access Restriction)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertARV

public ARV insertARV(int rep)
              throws HL7Exception

Inserts a specific repetition of ARV (Access Restriction)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeARV

public ARV removeARV(int rep)
              throws HL7Exception

Removes a specific repetition of ARV (Access Restriction)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

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)

getQRI

public QRI getQRI()

Returns QRI (Query Response Instance) - creates it if necessary