org.vmdb.hl7
Class CXElement

java.lang.Object
  |
  +--org.vmdb.hl7.HL7Object
        |
        +--org.vmdb.hl7.HL7Element
              |
              +--org.vmdb.hl7.CXElement

public class CXElement

extends HL7Element

Extended Composite ID with Check Digit (CX) Element.

Description: HL7 Network Connectivity For VMDB.

Copyright: Copyright (c) 2002-2003.

Company: Veterinary Medical Database (VMDB).

The method names follow the convention established by other Element type classes. Names follow the HL7 documentation.

See the HL7 documentation for an explanation of each component.

Constructor Summary

CXElement()
Construct a Composite ID Element using the default name and type constants at the default level FIELD.

CXElement(int iLevel)
Construct a Composite ID Element using the default name and type constants.

Method Summary

HDElement	getAssigningAuthority()
java.lang.String	getAssigningAuthorityId()
java.lang.String	getAssigningAuthorityName()
HDElement	getAssigningFacility()
java.lang.String	getAssigningFacilityId()
java.lang.String	getAssigningFacilityName()
java.lang.String	getCheckDigit()
java.lang.String	getCheckDigitSystem()
java.lang.String	getIdentifier()
java.lang.String	getIdentifierTypeCode()
void	setAssigningAuthority(HDElement hdE)
void	setAssigningAuthority(java.lang.String sNamespaceId, java.lang.String sUniversalId, java.lang.String sIdType) Set the assigning authority from the individual components of an HD Element.
void	setAssigningAuthorityName(java.lang.String sNamespaceId) Set just the namespace id of the assigning authority.
void	setAssigningFacility(HDElement hdE)
void	setAssigningFacility(java.lang.String sNamespaceId, java.lang.String sUniversalId, java.lang.String sIdType) Set the assigning facility from the individual components of an HD Element.
void	setAssigningFacilityName(java.lang.String sNamespaceId) Set just the namespace id of the assigning facility.
void	setCheckDigit(java.lang.String sCheckDigit)
void	setCheckDigitSystem(java.lang.String sCheckDigitSystem)
void	setIdentifier(java.lang.String sId)
void	setIdentifierTypeCode(java.lang.String sIdentifierTypeCode)

Methods inherited from class org.vmdb.hl7.HL7Element

clear, empty, getComponent, getLevel, getType, getValue, initialize, iterator, makeElement, setComponent, setLevel, setType, setValue, size, toHL7String, 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

CXElement

public CXElement(int iLevel)

Construct a Composite ID Element using the default name and type constants.

Parameters:

iLevel - One of the constants for specifying level as FIELD, COMPONENT, or SUBCOMPONENT. Default FIELD.

CXElement

public CXElement()

Construct a Composite ID Element using the default name and type constants at the default level FIELD.

Method Detail

setIdentifier

public void setIdentifier(java.lang.String sId)

getIdentifier

public java.lang.String getIdentifier()

setCheckDigit

public void setCheckDigit(java.lang.String sCheckDigit)

getCheckDigit

public java.lang.String getCheckDigit()

setCheckDigitSystem

public void setCheckDigitSystem(java.lang.String sCheckDigitSystem)

getCheckDigitSystem

public java.lang.String getCheckDigitSystem()

setAssigningAuthorityName

public void setAssigningAuthorityName(java.lang.String sNamespaceId)

Set just the namespace id of the assigning authority.

This is a convenience method to allow simple assigner identification via one-field CX's.

Parameters:

sNamespaceId - String name of assigning authority

setAssigningAuthority

public void setAssigningAuthority(java.lang.String sNamespaceId,
                                  java.lang.String sUniversalId,
                                  java.lang.String sIdType)

Set the assigning authority from the individual components of an HD Element.

This is a convenience method to automatically build the HD Element required here.

Parameters:

sNamespaceId - String name of assigning authority

sIdType - String with the identifier type of the assigner's identifier

setAssigningAuthority

public void setAssigningAuthority(HDElement hdE)

getAssigningAuthority

public HDElement getAssigningAuthority()

getAssigningAuthorityName

public java.lang.String getAssigningAuthorityName()

getAssigningAuthorityId

public java.lang.String getAssigningAuthorityId()

setIdentifierTypeCode

public void setIdentifierTypeCode(java.lang.String sIdentifierTypeCode)

getIdentifierTypeCode

public java.lang.String getIdentifierTypeCode()

setAssigningFacilityName

public void setAssigningFacilityName(java.lang.String sNamespaceId)

Set just the namespace id of the assigning facility.

This is a convenience method to allow simple assigner identification via one-field CX's.

Parameters:

sNamespaceId - String name of assigning facility

setAssigningFacility

public void setAssigningFacility(java.lang.String sNamespaceId,
                                 java.lang.String sUniversalId,
                                 java.lang.String sIdType)

Set the assigning facility from the individual components of an HD Element.

This is a convenience method to automatically build the HD Element required here.

Parameters:

sNamespaceId - String name of assigning facility

sIdType - String with the identifier type of the assigner's identifier

setAssigningFacility

public void setAssigningFacility(HDElement hdE)

getAssigningFacility

public HDElement getAssigningFacility()

getAssigningFacilityName

public java.lang.String getAssigningFacilityName()

getAssigningFacilityId

public java.lang.String getAssigningFacilityId()