Types concerned with message and document exchange using COM

Classes

DicomResponse
  • ** note: DICOM Support is under development. DICOM events and types are already present in the
API for declarative purposes, DICOM is not supported, and the API should be expected to change without notice ***

The outcome of processing a Dicom Message. The Dicom Message may be accepted or rejected.

If rejected, then the rejection *may* indicate whether the rejection is believed to be due to internal transient conditions, whether the condition is related to the content of the Dicom message itself, or whether it is caused by some business rules (policy). Note that it can be very hard to tell these conditions apart in the presence of an unexpected error, so the value should never be taken as gospel.

Some text description is expected to explain why the Dicom is rejected (Explanation). This won't make it into an actual DICOM Abort PDU, but it will appear in various HL7Connect records and logs. If a sending script chooses not to fill the response out, it *should* populate this field.

DocumentResponseThe outcome of a response to sending/processing the document. The document may be accepted or rejected.

If rejected, then the rejection *may* indicate whether the rejection is believed to be due to internal transient conditions, whether the condition is related to the content of the document itself, or whether it is caused by some business rules (policy). Note that it can be very hard to tell these conditions apart in the presence of an unexpected error, so the value should never be taken as gospel.

If the document is rejected, some text description is expected to explain why the document is rejected. HL7Connect will always populate the text message; if a sending script chooses not to send a document, it *should* populate this field.

MessageInformation about a message instance in the HL7Connect kernel

DocumentInformation about a Document instance in the HL7Connect kernel

DicomMessage
  • ** note: DICOM Support is under development. DICOM events and types are already present in the
API for declarative purposes, DICOM is not supported, and the API should be expected to change without notice ***

 Information about a Document instance in the HL7Connect kernel

AnnotationsA list of message or document annotations. Annotations can be set when sending a message or document, and read when receiving. Any annotations set when receiving a message will not be saved.

There can only be one annotation value for each name.

TransferredMessageA message passed to or from HL7Connect.

Whenever HL7Connect passes a message to across a COM interface, both the source and the message will be populated. In most contexts, the source is authoritative - it may occasionally have content (such as XML comments) that is not represented in the message model.

Whenever a message is passed across a COM interface to HL7Connect, HL7Connect will use the source if available (for the reason described above); else it will build the source from the Message. If neither property is assigned, an error will occur

TransferredDocumentA Document passed to or from HL7Connect.

Whenever HL7Connect passes a Document to across a COM interface, both the source and the Document will be populated. In most contexts, the source is authoritative - it may occasionally have content (such as XML comments) that is not represented in the Document model.

Whenever a Document is passed across a COM interface to HL7Connect, HL7Connect will use the source if available (for the reason described above); else it will build the source from the Document. If neither property is assigned, an error will occur

MessageInUsed to send a message to HL7Connect, and to get a v2 acknowledgement back.

MessageOutUsed when HL7Connect sends a message to the application.

DocumentInUsed to send a document to HL7Connect, and to get a response back

DocumentOutUsed when HL7Connect sends a document to the application.


© Kestral Computing P/L 2000 - 2003. HL7Connect v2.00-063 generated on 30-Nov 2015.
Keywords: HL7Connect.Exchange