org.vmdb.hl7
Class PV1Segment

java.lang.Object
  |
  +--org.vmdb.hl7.HL7Object
        |
        +--org.vmdb.hl7.HL7Segment
              |
              +--org.vmdb.hl7.PV1Segment

public class PV1Segment

extends HL7Segment

Patient Visit (PV1) Segment.

Description: HL7 Network Connectivity For VMDB.

Copyright: Copyright (c) 2002-2003.

Company: Veterinary Medical Database (VMDB).

The use of the PV1 segment in VMDB reporting is to provide visit-specific information. This segment is required for all ORU messages and only one PV1 segment may be included in a VMDB message. Only 6 elements in the segment are used for VMDB messages. See HL7 Standard Chapter 3 for details.

Constructor Summary

PV1Segment()
Construct an empty patient visit segment.

PV1Segment(HL7SegmentContainer msgParent)
Construct an empty patient visit segment, setting its containing message object.

Method Summary

java.lang.String	getAdmissionType() Get AdmissionType string.
java.lang.String	getAdmitDateTime() Get the admit date/time as a string.
XCNElement	getAttendingDoctor() Get the full attending doctor as XCNElement
java.lang.String	getAttendingDoctorAssigningAuthority() Get just the assigning authority namespace id
java.lang.String	getAttendingDoctorId() Get just the attending doctor identifier
java.lang.String	getDischargeDateTime() Get the discharge date/time as a string.
java.lang.String	getDisposition() Get Discharge Disposition.
java.lang.String	getPatientClass() Get Patient class string.
CXElement	getVisitNumber() Get the full Visit Number as CXElement.
java.lang.String	getVisitNumberAssigningAuthority() Get just the assigning authority namespace id.
java.lang.String	getVisitNumberId() Get just the Visit Number identifier.
void	setAdmissionType(java.lang.String sAdmissionType) Set the Admission type.
void	setAdmitDateTime(java.lang.String sDateTime) Set the admit date/time of the message to string formatted date/time.
void	setAttendingDoctorAssigningAuthority(java.lang.String sAssigningAuthority) Set attending doctor assigning facility.
void	setAttendingDoctorId(java.lang.String sIdNumber) Set attending doctor name identifier.
void	setAttendingDoctorId(java.lang.String sIdNumber, java.lang.String sAssigningAuthority) Set attending doctor name identifier from ID and facility.
void	setAttendingDoctorName(XCNElement xcnName) Set full attending doctor name as XCN element defined as completely as you like.
void	setDischargeDateTime(java.lang.String sDateTime) Set the discharge date/time of the message to string formatted date/time.
void	setDisposition(java.lang.String sDisp) Set the Discharge Disposition.
void	setPatientClass(java.lang.String sPatClass) Set the Patient class.
void	setVisitNumber(CXElement cxVisitNumber) Set full Visit Number as CX element defined as completely as you like.
void	setVisitNumberAssigningAuthority(java.lang.String sAssigningAuthority) Set Visit Number assigning facility.
void	setVisitNumberId(java.lang.String sIdNumber) Set Visit Number identifier.
void	setVisitNumberId(java.lang.String sIdNumber, java.lang.String sAssigningAuthority) Set Visit Number identifier and assigning facility.

Methods inherited from class org.vmdb.hl7.HL7Segment

clearField, getField, getFieldValue, iterator, listFields, setField, setField, setField, setField, setField, setField, setField, toString, toXML

Methods inherited from class org.vmdb.hl7.HL7Object

getRule

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PV1Segment

public PV1Segment()

Construct an empty patient visit segment.

PV1Segment

public PV1Segment(HL7SegmentContainer msgParent)

Construct an empty patient visit segment, setting its containing message object.

Parameters:

msgParent - HL7SegmentContainer (normally a Group 3 loop) object that contains this segment.

Method Detail

setPatientClass

public void setPatientClass(java.lang.String sPatClass)

Set the Patient class.

getPatientClass

public java.lang.String getPatientClass()

Get Patient class string.

Returns:

String (one character) with patient class code

setAdmissionType

public void setAdmissionType(java.lang.String sAdmissionType)

Set the Admission type.

getAdmissionType

public java.lang.String getAdmissionType()

Get AdmissionType string.

Returns:

String (one character) with AdmissionType code

setAttendingDoctorName

public void setAttendingDoctorName(XCNElement xcnName)

Set full attending doctor name as XCN element defined as completely as you like.

Parameters:

xcnName - XCNElement with name defined

setAttendingDoctorId

public void setAttendingDoctorId(java.lang.String sIdNumber,
                                 java.lang.String sAssigningAuthority)

Set attending doctor name identifier from ID and facility.

Parameters:

sIdNumber - String with id number

sAssigningAuthority - String with assigning facility namespace id

setAttendingDoctorId

public void setAttendingDoctorId(java.lang.String sIdNumber)

Set attending doctor name identifier.

Parameters:

sIdNumber - String with id number

setAttendingDoctorAssigningAuthority

public void setAttendingDoctorAssigningAuthority(java.lang.String sAssigningAuthority)

Set attending doctor assigning facility.

getAttendingDoctorId

public java.lang.String getAttendingDoctorId()

Get just the attending doctor identifier

Returns:

String with identifier number

getAttendingDoctorAssigningAuthority

public java.lang.String getAttendingDoctorAssigningAuthority()

Get just the assigning authority namespace id

Returns:

String with identifier number

getAttendingDoctor

public XCNElement getAttendingDoctor()

Get the full attending doctor as XCNElement

Returns:

XPNElement with fully defined name

setVisitNumber

public void setVisitNumber(CXElement cxVisitNumber)

Set full Visit Number as CX element defined as completely as you like.

Parameters:

cxVisitNumber - CXElement with name defined

setVisitNumberId

public void setVisitNumberId(java.lang.String sIdNumber,
                             java.lang.String sAssigningAuthority)

Set Visit Number identifier and assigning facility.

Parameters:

sIdNumber - String with id number

sAssigningAuthority - String with assigning facility namespace id

setVisitNumberId

public void setVisitNumberId(java.lang.String sIdNumber)

Set Visit Number identifier.

Parameters:

sIdNumber - String with id number

setVisitNumberAssigningAuthority

public void setVisitNumberAssigningAuthority(java.lang.String sAssigningAuthority)

Set Visit Number assigning facility.

getVisitNumberId

public java.lang.String getVisitNumberId()

Get just the Visit Number identifier.

Returns:

String with identifier number

getVisitNumberAssigningAuthority

public java.lang.String getVisitNumberAssigningAuthority()

Get just the assigning authority namespace id.

Returns:

String with identifier number

getVisitNumber

public CXElement getVisitNumber()

Get the full Visit Number as CXElement.

Returns:

XPNElement with fully defined name

setDisposition

public void setDisposition(java.lang.String sDisp)

Set the Discharge Disposition.

Parameters:

sDisp - one character string [0,1,2, or 3] for alive, dead, euthanized, or referred

getDisposition

public java.lang.String getDisposition()

Get Discharge Disposition.

Returns:

String (one character) with discharge disposition code

setAdmitDateTime

public void setAdmitDateTime(java.lang.String sDateTime)

Set the admit date/time of the message to string formatted date/time.

Parameters:

sDateTime - String with date/time in yyyyMMddHHmmss format

getAdmitDateTime

public java.lang.String getAdmitDateTime()

Get the admit date/time as a string.

Returns:

String date/time

setDischargeDateTime

public void setDischargeDateTime(java.lang.String sDateTime)

Set the discharge date/time of the message to string formatted date/time.

Parameters:

sDateTime - String with date/time in yyyyMMddHHmmss format

getDischargeDateTime

public java.lang.String getDischargeDateTime()

Get the discharge date/time as a string.

Returns:

String date/time