ca.uhn.hl7v2.conf.spec.message

Class StaticDef

java.lang.Object

ca.uhn.hl7v2.conf.spec.message.AbstractSegmentContainer

ca.uhn.hl7v2.conf.spec.message.StaticDef

All Implemented Interfaces:

Iterable<ProfileStructure>

public class StaticDef
extends AbstractSegmentContainer

A "static message profile" (see HL7 2.5 section 2.12). Message profiles are a precise method of documenting message constraints, using a standard XML syntax defined by HL7 (introduced in version 2.5). XML message profiles define constraints on message content and structure in a well-defined manner, so that the conformance of a certain message to a certain profile can be tested automatically. There are several types of profiles:

• HL7 Profiles - the standard messages (relatively loosely constrained)
• Implementable Profiles - profiles with additional constraints such that all optionality has been removed (e.g. optional fields marked as "required" or "not supported").
• Constrainable Profiles - any profile with optionality that can be further constrained.

Thus profiles can constrain other profiles. A typical case would be for a country to create a constrainable profile based on an HL7 profile, for a vendor to create a different constrainable profile based on the same HL7 profile, and for a hospital to create an implementable profile for a particular implementation that constrains both.

The MessageProfile class is a parsed object representation of the XML profile.

Author:

Bryan Tripp

Constructor Summary

Constructors

Constructor and Description
StaticDef() Creates a new instance of MessageProfile

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener l) Adds a PropertyChangeListener to the listener list.
void	addVetoableChangeListener(VetoableChangeListener l) Adds a VetoableChangeListener to the listener list.
String	getEventDesc() Getter for property eventDesc.
String	getEventType() Getter for property eventType.
String	getIdentifier() Getter for property identifier.
MetaData	getMetaData() Getter for property metaData.
String	getMsgStructID() Getter for property msgStructID.
String	getMsgType() Getter for property msgType.
String	getOrderControl() Getter for property orderControl.
String	getRole() Getter for property role.
void	removePropertyChangeListener(PropertyChangeListener l) Removes a PropertyChangeListener from the listener list.
void	removeVetoableChangeListener(VetoableChangeListener l) Removes a VetoableChangeListener from the listener list.
void	setEventDesc(String eventDesc) Setter for property eventDesc.
void	setEventType(String eventType) Setter for property eventType.
void	setIdentifier(String identifier) Setter for property identifier.
void	setMetaData(MetaData metaData) Setter for property metaData.
void	setMsgStructID(String msgStructID) Setter for property msgStructID.
void	setMsgType(String msgType) Setter for property msgType.
void	setOrderControl(String orderControl) Setter for property orderControl.
void	setRole(String role) Setter for property role.

Methods inherited from class ca.uhn.hl7v2.conf.spec.message.AbstractSegmentContainer

getChild, getChildren, getChildrenAsList, getDescription, getImpNote, getReference, iterator, setChild, setDescription, setImpNote, setReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

StaticDef

public StaticDef()

Creates a new instance of MessageProfile

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Adds a PropertyChangeListener to the listener list.

Overrides:

addPropertyChangeListener in class AbstractSegmentContainer

Parameters:

l - The listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Removes a PropertyChangeListener from the listener list.

Overrides:

removePropertyChangeListener in class AbstractSegmentContainer

Parameters:

l - The listener to remove.

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener l)

Adds a VetoableChangeListener to the listener list.

Overrides:

addVetoableChangeListener in class AbstractSegmentContainer

Parameters:

l - The listener to add.

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener l)

Removes a VetoableChangeListener from the listener list.

Overrides:

removeVetoableChangeListener in class AbstractSegmentContainer

Parameters:

l - The listener to remove.

getMetaData

public MetaData getMetaData()

Getter for property metaData.

Returns:

Value of property metaData.

setMetaData

public void setMetaData(MetaData metaData)
                 throws ProfileException

Setter for property metaData.

Parameters:

msgType - New value of property metaData.

Throws:

ProfileException

getMsgType

public String getMsgType()

Getter for property msgType.

Returns:

Value of property msgType.

setMsgType

public void setMsgType(String msgType)
                throws ProfileException

Setter for property msgType.

Parameters:

msgType - New value of property msgType.

Throws:

ProfileException

getEventType

public String getEventType()

Getter for property eventType.

Returns:

Value of property eventType.

setEventType

public void setEventType(String eventType)
                  throws ProfileException

Setter for property eventType.

Parameters:

eventType - New value of property eventType.

Throws:

ProfileException

getMsgStructID

public String getMsgStructID()

Getter for property msgStructID.

Returns:

Value of property msgStructID.

setMsgStructID

public void setMsgStructID(String msgStructID)
                    throws ProfileException

Setter for property msgStructID.

Parameters:

msgStructID - New value of property msgStructID.

Throws:

ProfileException

getOrderControl

public String getOrderControl()

Getter for property orderControl.

Returns:

Value of property orderControl.

setOrderControl

public void setOrderControl(String orderControl)
                     throws ProfileException

Setter for property orderControl.

Parameters:

orderControl - New value of property orderControl.

Throws:

ProfileException

getEventDesc

public String getEventDesc()

Getter for property eventDesc.

Returns:

Value of property eventDesc.

setEventDesc

public void setEventDesc(String eventDesc)
                  throws ProfileException

Setter for property eventDesc.

Parameters:

eventDesc - New value of property eventDesc.

Throws:

ProfileException

getIdentifier

public String getIdentifier()

Getter for property identifier.

Returns:

Value of property identifier.

setIdentifier

public void setIdentifier(String identifier)
                   throws ProfileException

Setter for property identifier.

Parameters:

eventDesc - New value of property identifier.

Throws:

ProfileException

getRole

public String getRole()

Getter for property role.

Returns:

Value of property role.

setRole

public void setRole(String role)
             throws ProfileException

Setter for property role.

Parameters:

eventDesc - New value of property role.

Throws:

ProfileException