org.hl7.rim
public interface AcknowledgementDetail extends RimObject
A message that provides information about the communication, parsing or non-business-rule validation of the message being acknowledged.
| Method Summary | |
|---|---|
| Acknowledgement | getAcknowledgement()
Gets association 'acknowledgement' to RIM class Acknowledgement with cardinality (1..1).
|
| CE | getCode()
Gets attribute code of type CE and cardinality 0..1.
|
| SET<ST> | getLocation()
Gets attribute location of type SET |
| ED | getText()
Gets attribute text of type ED and cardinality 0..1.
|
| CS | getTypeCode()
Gets attribute typeCode of type CS and cardinality 0..1.
|
| void | setAcknowledgement(Acknowledgement value)
Sets association 'acknowledgement' to RIM class Acknowledgement with cardinality (1..1).
|
| void | setCode(CE value)
Sets attribute code of type CE and cardinality 0..1.
|
| void | setLocation(SET<ST> value)
Sets attribute location of type SET |
| void | setText(ED value)
Sets attribute text of type ED and cardinality 0..1.
|
| void | setTypeCode(CS value)
Sets attribute typeCode of type CS and cardinality 0..1.
|
Identifies the relationship between an acknowledgment and the error, warning and informational detail accompanying that acknowledgment.
Returns: the reference to the linked class
A code identifying the specific message to be provided.
Discussion: A textual value may be specified as the print name, or for non-coded messages, as the original text.
Examples: 'Required attribute xxx is missing', 'System will be unavailable March 19 from 0100 to 0300'
Returns: the attribute value
Identifies a position within the message being acknowledged that is related to the message.
Discussion: Not all messages will have an associated location. Some messages may relate to multiple locations.
Example: There is no location for a missing element, and there may be two locations if two elements violate a conditionality constraint.
Returns: the attribute value
Identifies additional diagnostic information relevant to the message.
Discussion: This may be free text or structured data (e.g. XML).
Examples: Java exception, memory dump, internal error code, call-stack information, etc.
Returns: the attribute value
Identifies the kind of information specified in the acknowledgement message. Options are: Error, Warning or Information.
Returns: the attribute value
Identifies the relationship between an acknowledgment and the error, warning and informational detail accompanying that acknowledgment.
Parameters: value the new association value
A code identifying the specific message to be provided.
Discussion: A textual value may be specified as the print name, or for non-coded messages, as the original text.
Examples: 'Required attribute xxx is missing', 'System will be unavailable March 19 from 0100 to 0300'
Parameters: value the new attribute value
Identifies a position within the message being acknowledged that is related to the message.
Discussion: Not all messages will have an associated location. Some messages may relate to multiple locations.
Example: There is no location for a missing element, and there may be two locations if two elements violate a conditionality constraint.
Parameters: value the new attribute value
Identifies additional diagnostic information relevant to the message.
Discussion: This may be free text or structured data (e.g. XML).
Examples: Java exception, memory dump, internal error code, call-stack information, etc.
Parameters: value the new attribute value
Identifies the kind of information specified in the acknowledgement message. Options are: Error, Warning or Information.
Parameters: value the new attribute value