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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class SIU_S12_PATIENT
extends AbstractGroup

Represents a SIU_S12_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: PV1 (Patient visit) optional
• 4: PV2 (Patient visit - additional information) optional
• 5: OBX (Observation/Result) optional repeating
• 6: DG1 (Diagnosis) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

DG1	getDG1() Returns the first repetition of DG1 (Diagnosis) - creates it if necessary
DG1	getDG1(int rep) Returns a specific repetition of DG1 (Diagnosis) - creates it if necessary
int	getDG1Reps() Returns the number of existing repetitions of DG1
OBX	getOBX() Returns the first repetition of OBX (Observation/Result) - creates it if necessary
OBX	getOBX(int rep) Returns a specific repetition of OBX (Observation/Result) - creates it if necessary
int	getOBXReps() Returns the number of existing repetitions of OBX
PD1	getPD1() Returns PD1 (patient additional demographic) - creates it if necessary
PID	getPID() Returns PID (Patient identification) - creates it if necessary
PV1	getPV1() Returns PV1 (Patient visit) - creates it if necessary
PV2	getPV2() Returns PV2 (Patient visit - additional information) - creates it if necessary
String	getVersion() Returns "2.4"
void	insertDG1(DG1 structure, int rep) Inserts a specific repetition of DG1 (Diagnosis)
DG1	insertDG1(int rep) Inserts a specific repetition of DG1 (Diagnosis)
OBX	insertOBX(int rep) Inserts a specific repetition of OBX (Observation/Result)
void	insertOBX(OBX structure, int rep) Inserts a specific repetition of OBX (Observation/Result)
DG1	removeDG1(int rep) Removes a specific repetition of DG1 (Diagnosis)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (Observation/Result)

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

SIU_S12_PATIENT

public SIU_S12_PATIENT(Group parent,
                       ModelClassFactory factory)

Creates a new SIU_S12_PATIENT group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

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

getPV1

public PV1 getPV1()

Returns PV1 (Patient visit) - creates it if necessary

getPV2

public PV2 getPV2()

Returns PV2 (Patient visit - additional information) - creates it if necessary

getOBX

public OBX getOBX()

Returns the first repetition of OBX (Observation/Result) - creates it if necessary

getOBX

public OBX getOBX(int rep)

Returns a specific repetition of OBX (Observation/Result) - 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.

getOBXReps

public int getOBXReps()

Returns the number of existing repetitions of OBX

insertOBX

public void insertOBX(OBX structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBX

public OBX insertOBX(int rep)
              throws HL7Exception

Inserts a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBX

public OBX removeOBX(int rep)
              throws HL7Exception

Removes a specific repetition of OBX (Observation/Result)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getDG1

public DG1 getDG1()

Returns the first repetition of DG1 (Diagnosis) - creates it if necessary

getDG1

public DG1 getDG1(int rep)

Returns a specific repetition of DG1 (Diagnosis) - 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.

getDG1Reps

public int getDG1Reps()

Returns the number of existing repetitions of DG1

insertDG1

public void insertDG1(DG1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertDG1

public DG1 insertDG1(int rep)
              throws HL7Exception

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeDG1

public DG1 removeDG1(int rep)
              throws HL7Exception

Removes a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)