ca.uhn.hl7v2.model.v24.datatype
Class PL

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.v24.datatype.PL

All Implemented Interfaces:

Composite, Type, Serializable

public class PL
extends AbstractType
implements Composite

Represents an HL7 PL (person location) data type. This type consists of the following components:

• point of care (IS)
• room (IS)
• bed (IS)
• facility (HD) (HD)
• location status (IS)
• person location type (IS)
• building (IS)
• floor (IS)
• Location description (ST)

See Also:

Serialized Form

Constructor Summary

PL(Message message)
Creates a new PL type

Method Summary

IS	getBed() Returns bed (component #3).
IS	getBuilding() Returns building (component #7).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
HD	getFacility() Returns facility (HD) (component #4).
IS	getFloor() Returns floor (component #8).
ST	getLocationDescription() Returns Location description (component #9).
IS	getLocationStatus() Returns location status (component #5).
IS	getPersonLocationType() Returns person location type (component #6).
IS	getPl1_PointOfCare() Returns point of care (component #1).
IS	getPl2_Room() Returns room (component #2).
IS	getPl3_Bed() Returns bed (component #3).
HD	getPl4_Facility() Returns facility (HD) (component #4).
IS	getPl5_LocationStatus() Returns location status (component #5).
IS	getPl6_PersonLocationType() Returns person location type (component #6).
IS	getPl7_Building() Returns building (component #7).
IS	getPl8_Floor() Returns floor (component #8).
ST	getPl9_LocationDescription() Returns Location description (component #9).
IS	getPointOfCare() Returns point of care (component #1).
IS	getRoom() Returns room (component #2).

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

clear, encode, getExtraComponents, getMessage, getName, parse

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.Type

clear, encode, getExtraComponents, getMessage, getName, parse

Constructor Detail

PL

public PL(Message message)

Creates a new PL type

Method Detail

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

Specified by:

getComponents in interface Composite

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Specified by:

getComponent in interface Composite

Parameters:

number - The component number (0-indexed)

Throws:

DataTypeException - if the given element number is out of range.

getPointOfCare

public IS getPointOfCare()

Returns point of care (component #1). This is a convenience method that saves you from casting and handling an exception.

getPl1_PointOfCare

public IS getPl1_PointOfCare()

Returns point of care (component #1). This is a convenience method that saves you from casting and handling an exception.

getRoom

public IS getRoom()

Returns room (component #2). This is a convenience method that saves you from casting and handling an exception.

getPl2_Room

public IS getPl2_Room()

Returns room (component #2). This is a convenience method that saves you from casting and handling an exception.

getBed

public IS getBed()

Returns bed (component #3). This is a convenience method that saves you from casting and handling an exception.

getPl3_Bed

public IS getPl3_Bed()

Returns bed (component #3). This is a convenience method that saves you from casting and handling an exception.

getFacility

public HD getFacility()

Returns facility (HD) (component #4). This is a convenience method that saves you from casting and handling an exception.

getPl4_Facility

public HD getPl4_Facility()

Returns facility (HD) (component #4). This is a convenience method that saves you from casting and handling an exception.

getLocationStatus

public IS getLocationStatus()

Returns location status (component #5). This is a convenience method that saves you from casting and handling an exception.

getPl5_LocationStatus

public IS getPl5_LocationStatus()

Returns location status (component #5). This is a convenience method that saves you from casting and handling an exception.

getPersonLocationType

public IS getPersonLocationType()

Returns person location type (component #6). This is a convenience method that saves you from casting and handling an exception.

getPl6_PersonLocationType

public IS getPl6_PersonLocationType()

Returns person location type (component #6). This is a convenience method that saves you from casting and handling an exception.

getBuilding

public IS getBuilding()

Returns building (component #7). This is a convenience method that saves you from casting and handling an exception.

getPl7_Building

public IS getPl7_Building()

Returns building (component #7). This is a convenience method that saves you from casting and handling an exception.

getFloor

public IS getFloor()

Returns floor (component #8). This is a convenience method that saves you from casting and handling an exception.

getPl8_Floor

public IS getPl8_Floor()

Returns floor (component #8). This is a convenience method that saves you from casting and handling an exception.

getLocationDescription

public ST getLocationDescription()

Returns Location description (component #9). This is a convenience method that saves you from casting and handling an exception.

getPl9_LocationDescription

public ST getPl9_LocationDescription()

Returns Location description (component #9). This is a convenience method that saves you from casting and handling an exception.