ca.uhn.hl7v2.model.v24.group
Class RSP_Z90_COMMON_ORDER

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v24.group.RSP_Z90_COMMON_ORDER

All Implemented Interfaces:

Group, Structure, Serializable

public class RSP_Z90_COMMON_ORDER
extends AbstractGroup

Represents a RSP_Z90_COMMON_ORDER 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: ORC (Common Order)
• 2: OBR (Observation Request)
• 3: NTE (Notes and Comments) optional repeating
• 4: CTD (Contact Data) optional
• 5: RSP_Z90_OBSERVATION (a Group object) repeating

See Also:

Serialized Form

Constructor Summary

RSP_Z90_COMMON_ORDER(Group parent, ModelClassFactory factory)
Creates a new RSP_Z90_COMMON_ORDER group

Method Summary

CTD	getCTD() Returns CTD (Contact Data) - creates it if necessary
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
int	getNTEReps() Returns the number of existing repetitions of NTE
OBR	getOBR() Returns OBR (Observation Request) - creates it if necessary
RSP_Z90_OBSERVATION	getOBSERVATION() Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
RSP_Z90_OBSERVATION	getOBSERVATION(int rep) Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
int	getOBSERVATIONReps() Returns the number of existing repetitions of OBSERVATION
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
String	getVersion() Returns "2.4"
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)
RSP_Z90_OBSERVATION	insertOBSERVATION(int rep) Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(RSP_Z90_OBSERVATION structure, int rep) Inserts a specific repetition of OBSERVATION (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
RSP_Z90_OBSERVATION	removeOBSERVATION(int rep) Removes a specific repetition of OBSERVATION (a Group object)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getMessage, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

Methods inherited from class java.lang.Object

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

Constructor Detail

RSP_Z90_COMMON_ORDER

public RSP_Z90_COMMON_ORDER(Group parent,
                            ModelClassFactory factory)

Creates a new RSP_Z90_COMMON_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - creates it if necessary

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

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)

getCTD

public CTD getCTD()

Returns CTD (Contact Data) - creates it if necessary

getOBSERVATION

public RSP_Z90_OBSERVATION getOBSERVATION()

Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary

getOBSERVATION

public RSP_Z90_OBSERVATION getOBSERVATION(int rep)

Returns a specific repetition of OBSERVATION (a Group object) - 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.

getOBSERVATIONReps

public int getOBSERVATIONReps()

Returns the number of existing repetitions of OBSERVATION

insertOBSERVATION

public void insertOBSERVATION(RSP_Z90_OBSERVATION structure,
                              int rep)
                       throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION

public RSP_Z90_OBSERVATION insertOBSERVATION(int rep)
                                      throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION

public RSP_Z90_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)