Package ca.uhn.hl7v2.model.v251.message

Class ADT_A17

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.ADT_A17

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class ADT_A17
extends AbstractMessage

Represents a ADT_A17 message structure (see chapter 3.3.17). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: EVN (Event Type)
• 4: PID (Patient Identification)
• 5: PD1 (Patient Additional Demographic) optional
• 6: PV1 (Patient Visit)
• 7: PV2 (Patient Visit - Additional Information) optional
• 8: DB1 (Disability) optional repeating
• 9: OBX (Observation/Result) optional repeating
• 10: PID (Patient Identification)
• 11: PD1 (Patient Additional Demographic) optional
• 12: PV1 (Patient Visit)
• 13: PV2 (Patient Visit - Additional Information) optional
• 14: DB1 (Disability) optional repeating
• 15: OBX (Observation/Result) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
ADT_A17()	Creates a new ADT_A17 message with DefaultModelClassFactory.
ADT_A17(ModelClassFactory factory)	Creates a new ADT_A17 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
DB1	getDB1()	Returns the first repetition of DB1 (Disability) - creates it if necessary
DB1	getDB1(int rep)	Returns a specific repetition of DB1 (Disability) - creates it if necessary
DB1	getDB12()	Returns the first repetition of DB12 (Disability) - creates it if necessary
DB1	getDB12(int rep)	Returns a specific repetition of DB12 (Disability) - creates it if necessary
List<DB1>	getDB12All()	Returns a non-modifiable List containing all current existing repetitions of DB12.
int	getDB12Reps()	Returns the number of existing repetitions of DB12
List<DB1>	getDB1All()	Returns a non-modifiable List containing all current existing repetitions of DB1.
int	getDB1Reps()	Returns the number of existing repetitions of DB1
EVN	getEVN()	Returns EVN (Event Type) - creates it if necessary
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
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
OBX	getOBX2()	Returns the first repetition of OBX2 (Observation/Result) - creates it if necessary
OBX	getOBX2(int rep)	Returns a specific repetition of OBX2 (Observation/Result) - creates it if necessary
List<OBX>	getOBX2All()	Returns a non-modifiable List containing all current existing repetitions of OBX2.
int	getOBX2Reps()	Returns the number of existing repetitions of OBX2
List<OBX>	getOBXAll()	Returns a non-modifiable List containing all current existing repetitions of OBX.
int	getOBXReps()	Returns the number of existing repetitions of OBX
PD1	getPD1()	Returns PD1 (Patient Additional Demographic) - creates it if necessary
PD1	getPD12()	Returns PD12 (Patient Additional Demographic) - creates it if necessary
PID	getPID()	Returns PID (Patient Identification) - creates it if necessary
PID	getPID2()	Returns PID2 (Patient Identification) - creates it if necessary
PV1	getPV1()	Returns PV1 (Patient Visit) - creates it if necessary
PV1	getPV12()	Returns PV12 (Patient Visit) - creates it if necessary
PV2	getPV2()	Returns PV2 (Patient Visit - Additional Information) - creates it if necessary
PV2	getPV22()	Returns PV22 (Patient Visit - Additional Information) - creates it if necessary
SFT	getSFT()	Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep)	Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll()	Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps()	Returns the number of existing repetitions of SFT
String	getVersion()	Returns "2.5.1"
DB1	insertDB1(int rep)	Inserts a specific repetition of DB1 (Disability)
void	insertDB1(DB1 structure, int rep)	Inserts a specific repetition of DB1 (Disability)
DB1	insertDB12(int rep)	Inserts a specific repetition of DB12 (Disability)
void	insertDB12(DB1 structure, int rep)	Inserts a specific repetition of DB12 (Disability)
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)
OBX	insertOBX2(int rep)	Inserts a specific repetition of OBX2 (Observation/Result)
void	insertOBX2(OBX structure, int rep)	Inserts a specific repetition of OBX2 (Observation/Result)
SFT	insertSFT(int rep)	Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep)	Inserts a specific repetition of SFT (Software Segment)
DB1	removeDB1(int rep)	Removes a specific repetition of DB1 (Disability)
DB1	removeDB12(int rep)	Removes a specific repetition of DB12 (Disability)
OBX	removeOBX(int rep)	Removes a specific repetition of OBX (Observation/Result)
OBX	removeOBX2(int rep)	Removes a specific repetition of OBX2 (Observation/Result)
SFT	removeSFT(int rep)	Removes a specific repetition of SFT (Software Segment)

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

accept, copy, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

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, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Group

addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName

Methods inherited from interface ca.uhn.hl7v2.model.Visitable

isEmpty, provideLocation

Constructor Details

ADT_A17

public ADT_A17()

Creates a new ADT_A17 message with DefaultModelClassFactory.

ADT_A17

public ADT_A17(ModelClassFactory factory)

Creates a new ADT_A17 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

Returns a specific repetition of SFT (Software Segment) - 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.

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getEVN

public EVN getEVN()

Returns EVN (Event Type) - creates it if necessary

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

getDB1

public DB1 getDB1()

Returns the first repetition of DB1 (Disability) - creates it if necessary

getDB1

public DB1 getDB1(int rep)

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

getDB1Reps

public int getDB1Reps()

Returns the number of existing repetitions of DB1

getDB1All

public List<DB1> getDB1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertDB1

public void insertDB1(DB1 structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of DB1 (Disability)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDB1

public DB1 insertDB1(int rep)
              throws HL7Exception

Inserts a specific repetition of DB1 (Disability)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDB1

public DB1 removeDB1(int rep)
              throws HL7Exception

Removes a specific repetition of DB1 (Disability)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

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

getOBXAll

public List<OBX> getOBXAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

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)

getPID2

public PID getPID2()

Returns PID2 (Patient Identification) - creates it if necessary

getPD12

public PD1 getPD12()

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

getPV12

public PV1 getPV12()

Returns PV12 (Patient Visit) - creates it if necessary

getPV22

public PV2 getPV22()

Returns PV22 (Patient Visit - Additional Information) - creates it if necessary

getDB12

public DB1 getDB12()

Returns the first repetition of DB12 (Disability) - creates it if necessary

getDB12

public DB1 getDB12(int rep)

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

getDB12Reps

public int getDB12Reps()

Returns the number of existing repetitions of DB12

getDB12All

public List<DB1> getDB12All()
                     throws HL7Exception

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

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

Throws:

HL7Exception

insertDB12

public void insertDB12(DB1 structure,
 int rep)
                throws HL7Exception

Inserts a specific repetition of DB12 (Disability)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDB12

public DB1 insertDB12(int rep)
               throws HL7Exception

Inserts a specific repetition of DB12 (Disability)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDB12

public DB1 removeDB12(int rep)
               throws HL7Exception

Removes a specific repetition of DB12 (Disability)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getOBX2

public OBX getOBX2()

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

getOBX2

public OBX getOBX2(int rep)

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

getOBX2Reps

public int getOBX2Reps()

Returns the number of existing repetitions of OBX2

getOBX2All

public List<OBX> getOBX2All()
                     throws HL7Exception

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

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

Throws:

HL7Exception

insertOBX2

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

Inserts a specific repetition of OBX2 (Observation/Result)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertOBX2

public OBX insertOBX2(int rep)
               throws HL7Exception

Inserts a specific repetition of OBX2 (Observation/Result)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeOBX2

public OBX removeOBX2(int rep)
               throws HL7Exception

Removes a specific repetition of OBX2 (Observation/Result)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)