ca.uhn.hl7v2.model.v24.group

Class OMG_O19_ORDER_PRIOR

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.OMG_O19_ORDER_PRIOR

All Implemented Interfaces:

Group, Structure, Serializable

public class OMG_O19_ORDER_PRIOR
extends AbstractGroup

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

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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
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
OBR	getOBR() Returns OBR (Observation Request) - creates it if necessary
OMG_O19_OBSERVATION_PRIOR	getOBSERVATION_PRIOR() Returns the first repetition of OBSERVATION_PRIOR (a Group object) - creates it if necessary
OMG_O19_OBSERVATION_PRIOR	getOBSERVATION_PRIOR(int rep) Returns a specific repetition of OBSERVATION_PRIOR (a Group object) - creates it if necessary
List<OMG_O19_OBSERVATION_PRIOR>	getOBSERVATION_PRIORAll() Returns a non-modifiable List containing all current existing repetitions of OBSERVATION_PRIOR.
int	getOBSERVATION_PRIORReps() Returns the number of existing repetitions of OBSERVATION_PRIOR
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)
OMG_O19_OBSERVATION_PRIOR	insertOBSERVATION_PRIOR(int rep) Inserts a specific repetition of OBSERVATION_PRIOR (a Group object)
void	insertOBSERVATION_PRIOR(OMG_O19_OBSERVATION_PRIOR structure, int rep) Inserts a specific repetition of OBSERVATION_PRIOR (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
OMG_O19_OBSERVATION_PRIOR	removeOBSERVATION_PRIOR(int rep) Removes a specific repetition of OBSERVATION_PRIOR (a Group object)

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

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, 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

OMG_O19_ORDER_PRIOR

public OMG_O19_ORDER_PRIOR(Group parent,
                   ModelClassFactory factory)

Creates a new OMG_O19_ORDER_PRIOR 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

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)

getCTD

public CTD getCTD()

Returns CTD (Contact Data) - creates it if necessary

getOBSERVATION_PRIOR

public OMG_O19_OBSERVATION_PRIOR getOBSERVATION_PRIOR()

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

getOBSERVATION_PRIOR

public OMG_O19_OBSERVATION_PRIOR getOBSERVATION_PRIOR(int rep)

Returns a specific repetition of OBSERVATION_PRIOR (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.

getOBSERVATION_PRIORReps

public int getOBSERVATION_PRIORReps()

Returns the number of existing repetitions of OBSERVATION_PRIOR

getOBSERVATION_PRIORAll

public List<OMG_O19_OBSERVATION_PRIOR> getOBSERVATION_PRIORAll()
                                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertOBSERVATION_PRIOR

public void insertOBSERVATION_PRIOR(OMG_O19_OBSERVATION_PRIOR structure,
                           int rep)
                             throws HL7Exception

Inserts a specific repetition of OBSERVATION_PRIOR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION_PRIOR

public OMG_O19_OBSERVATION_PRIOR insertOBSERVATION_PRIOR(int rep)
                                                  throws HL7Exception

Inserts a specific repetition of OBSERVATION_PRIOR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION_PRIOR

public OMG_O19_OBSERVATION_PRIOR removeOBSERVATION_PRIOR(int rep)
                                                  throws HL7Exception

Removes a specific repetition of OBSERVATION_PRIOR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)