Introduction
custo diagnostic is a server based software (referenced as "software"), intended to support physicians to acquired, analyze, document and report cardio pulmonary observations. The inherent patient, order and observation database can be interfaced via HL7, DICOM and GDT to an superior system. This document describes the typical use of the HL7 interface version 5.6.4 and above and addresses the HL7 communication partner. (The intention is not, to give a deep insight about the configuration in our service applications to configure this options).
Starting from the typical data handling / workflows regarding patients, orders, tenants ("Mandant"), etc the last sections covers the typically used segments to establish these usage.
Typical use / default does not imply, that the software has activated this options out of the box. Some manual configuration work is necessary by the authorized custo diagnostic vendor / implementer.
Content
General Data Used
Drübergehen DTM Format?
""
Gewicht / Größe / Medication
Key
Not listed fields are ignored
Default configuration - can be confgured in some extent.
Receiving / Sending seen from custo diagnostic perspective
optional - not reuqired, in some cases must be activated in custo diagnostic.
i - ignored.
General HL7 information
| Supported HL7 Version | 2.3, 2.5 (global for all message-types) | ||||||
| Character Sets | All typical character sets supported. In general, custo diagnostic is configured to export via Windows-1252 (global for all export messages) | ||||||
| Supported Transfer | TCP/IP Socket File based | ||||||
| Supported Message Types |
The message types must be licenced individually - which means not all installations provide all message types. | ||||||
| Empty Value / Null Value | In general custo diagnostic supports the null value for receiving messages.
|
Patient Data Logic (ADT)
ADT Messages
custo diagnostic accepts by default the following message types (further message types can be defined):
A01, A02, A03, A04, A05, A08, A11, A12, A13, A23, A29, A38, A40, A42, A43, A45
Patient / Visit Identification
custo diagnostic uses by default the patient ID from PID-3-1 and Visit-ID from PV1-19 to identify the patient/visit. In case these are not unique, an appropriate tenant system must be configured.
These IDs are processed as a string - in contrast to an numeric value. This means - a patient "0001234" is not the same as patient "1234".
Please note, that most custo diagnostic feature assume, that Patient and Visit IDs are present. In systems where one of these information is not available, some functions will by default not work the way they are defined by HL7. (e.g. Merging/Moving). Please contact custo med in advance, to discuss the appropriate configuration in circumstances where Patient- or Visit-ID are not available.
Creating and Updating Patient / Visit information
In case a patient does not exists in custo diagnostic, by default, custo diagnostic creates the patient and visit by each of theses ADT messages. For example, a patient/visit can be created in custo diagnostic by an A08 message - without any admission message.
In case a patient/visit already exists in custo diagnostic, it is updated by default by each ADT message. (see "Null Value").
In some environments, a patient is only created via Order-Messages and Merge/Move-Messages. (can be configured).
This behavior can be configured - meaning that it can be stipulated which message creates a patient/visit (e.g. only ADT^A01), and which messages updates a patient/visit information.
Discharge Patient / Visit
When receiving a discharge message (A03) - open observation requests (orders) are deleted. Other behavior can be configured (deletion of visit, delegation of observation etc.)
PV1-45 is used to set the discharge date of the patient. ##bitte prüfen - ich glaube es wird nicht der zeitstempel der nachricht/des events verwnedet, sonddern eben pv1-45. Wie ist dies mit der entlassnachricht`?)
Deleting Patients / Visits
Patients and visits can be deleted in custo diagnostic by A23, A29. A deletion means that it is marked as deleted and will be purged by the next purge-run which by default runs each night.
Tenant System
Tenant Systems can be configured in different ways to separate orders/observation and/or patients/visits.
The tenant system must be defined, by default the tenant information is expected in MSH-6 by custo diagnostic, and will be send back in MSH-4.
This must be a biunique definition, meaning one specific code for MSH-6 should point to one specific tenant and vice versa. In case several facilities should be part of one tenant in custo diagnostic, we strictly recommend to solve this on the HIS side.
Sample:
| Tenant (Description) | Receiving (e.g. ORM) MSH-6 (code) | Sending (e.g. ORU) MSH-4 | |
|---|---|---|---|
| Sea View Hospital | SVH | SVH | |
| Lake Hospital | LH | LH |
By default, custo diagnostic send back the tenant code in MSH-4.
Order Data / Order Entry Workflow
The software supports all messages to provide a full HL7 order-entry workflow and methods to update the superior system about the current order status.
Orders
Supported Message: ORM^O01
Typical workflow: custo diagnostic receives orders and show them as a worklist to the users. One order is (by default) identified by the Placer Number, and may contain several observation requests, identified by Alternate Order ID. A clinical question is visible to the user, which can contain a free text, The intention of the clinical question is to avoid unstructured communication by E-Mail/Phone etc.
The user choose the requested observation, and custo diagnostic determines the diagnostic mode by the service identified given in OBR-4, e.g. Spirometry, Resting-ECG, Holter.
When receiving an order, the software also supports additional information (optional):
| OBX-3-1 | OBX-3-2 |
|---|---|
| BODY WEIGHT | Weight |
| BODY HEIGHT | Height |
| MEDICATION | Medication |
Even this information is transfered with an order - it is stored/updates the visit information.
##bitte einheiten noch prüfen - rechnet er um in cm/m/inch/fuß? müsste in OBX-6 stehen Rechnet er um in pfund?
##was machen wir mit labor-werten?
Order Status
The acquired recording may be processed several times in the custo software by several users, before it is finally reported. This workflow must be stipulated for the specific customer and may vary for the different ECG types (like holter, Resting-ECG).
custo supports three methods to update the superior system (placer of the order) about the current state of the observation:
- ORR Messages
- ORU Status Messages (OBR-1/OBR-5)
- Observation Result Status in (OBX-11)
Furthermore the software can be configured, that only specific users/results with specific status can be transferred to the superior system.
Sending Observation Status via ORR / ORU Messages
ORR Message and / or ORU Status Messages can be configured on special activity / events.
The following events can be activated:
| Activity/Event | ORC-1 / ORC-5 |
|---|---|
| Order request accepted | by default not activated |
| Order request updated | by default not activated |
| Examination starts | SC / SC |
| Examination is finished | SC / CM |
| Order request will be deleted | SC / CA |
| Order request will be reset | by default not activated |
| Examination will be deleted | by default not activated |
Observation Result Status
The following result Status is part of the of the OBX-Segment, when sending the results.
##bitte nochmal OBX prüfen. Stimmt OBX-25?
| OBX-11/OBR-25 | Meaning |
|---|---|
| R | The results are entered or automatically generated. |
| P | The results are preconfirmed, in general not by an accountable person. |
| F | The results are confirmed by an accountable person. |
| D | The order was canceled / the evaluation was deleted. |
Observation Results (ORU)
Supported Message Type: ORU^R01
As mentioned above, an order / observation may be processed in different steps by different persons. This implies, that it may be send with different observation status several times to hte place, as stipulated for this specific installation and observation type. The observation gets and internal filler ID as soons as the observation is created.
In most installations, the manually typed in Report-Text (german "Befund") and a created PDF-File (also base64-embedded) are the most important data of the observation.
When the orders are processed, custo diagnostic adds an internal "Filler ID" . This can be configured by a fixed length consecutive number, with an arbitrary alphanumeric prefix, e.g. "CM00001234", or an GUID (OBR-3, ORC-3)
OBX-Segment
| Field | o/r/i | s/so | Default Usage |
|---|---|---|---|
| OBX-1 | 1) | s | Set-ID |
| OBX-2 | 1) | s | Value Type (ST, NM, FT, RP, ED) |
| OBX-3 | 1) | so | observation identifier, see below OBX-3-1 code, OBX-3-2 text/human readable |
| OBX-5 | 1) | so | observation value, see below |
| OBX-6 | 1) | so | OBX-6-1 empty, OBX-6-2 units |
| OBX-11 | so | Observation Result Status. (see above, section "Observation Result Status") |
1) Incoming: See section "Orders" above.
Sending specific observation data
custo diagnostic can send specific observation data. The most common one is the manually typed in report (referenced as AKT_BEF) or the entire observation (referenced as FILE_PDF) as PDF / base64 embedded, but more than hundred specific numeric values can be defined which are described more specific below. One or more of the listed observation data can be exported in the same message. Alternatively one message per observation data can be send.
Most used OBX-3 Codes:
| OBX-2 | OBX-3-1 (Code) | OBX-3-2 (Human Readable Text) | OBX-5-1 | OBX-5-3 | OBX-5-4 |
|---|---|---|---|---|---|
| FT | AKT_BEF | Report | Formatted Report, as typed in or automatcially generated by the software | ||
| RP | FILE_PDF | PDF File | Points to an PDF-File, including path. | ||
| ED | FILE_PDF | PDF File | Base64 | ||
| ST | STUDYUID_DCM | Study Instance UID | In combination with DICOM, that Study Instance UID of the DICOM object. | ||
Sample - Outgoing ORU Message with Formatted-Text Report and Base64-encoded PDF-File
MSH|^~\&|||||20210604110853.844+0200||ORU^R01^ORU_R01|2401|P|2.5|||NE|NE|D PID|1||197051008||Benson^Joe||19570213|M|||Trebeck Street 14^^Tedworth, South^^10417 PV1|1|U|H1A^^B377T^IM^^^3^5e||||||||||||||||3044281008||K ORC|SC|12345|CM0000000001||CM OBR|1|12345|CM0000000001|EKG03^EKG03|||20210602160514|||||||20210602160514||||||||20210604103235||||||||||&Supervisor OBX|1|ED|FILE_PDF^PDF File||^^pdf^Base64^JVBERi0xLjQKJcOiw6MKMSAwIG9iago8PAovVGl0bGUgKP7AGMAdQBzAHQAbwBfAGQAaQBhA ... olJUVPRgo=||||||F OBX|2|FT|AKT_BEF^Report|1|normofrequenter Sinusrhythmus\.br\Steiltyp||||||F
PDF Files
custo recommends to transfer the PDF-Files bas64 embedded as described above. In case this is not possible, the software can export the PDF-File on a file store / share, in general it should be located on the same host custo diagnostic server is executed. By default, the PDF-Filename is equivalent to the GUID (can be configured) of the observation. Already existing files with this filename are overwritten.
We recommend to move the file to another store while processing the referencing ORU/MDM message.
MSH|^~\&|||||20210604125019.69+0200||ORU^R01^ORU_R01|2701|P|2.5|||NE|NE|D PID|1||197051008||Benson^Joe||19570213|M|||Trebeck Street 14^^Tedworth, South^^10417 PV1|1|U|H1A^^B377T^IM^^^3^5e||||||||||||||||3044281008||K ORC|SC|12345|CM0000000001||CM OBR|1|12345|CM0000000001|EKG03^EKG03|||20210602160514|||||||20210602160514||||||||20210604103235||||||||||&Supervisor OBX|1|RP|FILE_PDF^PDF File||\E\\E\myserver\E\theshare\E\30c5ef4b-a5db-4b26-beab-d6922d4a4d47.pdf^^pdf||||||P OBX|2|ST|AKT_BEF^Report|1|Dnormofrequenter Sinusrhythmus\.br\Steiltyp||||||P
The reference pointer to the file \\myserver\theshare\30c5ef4b-a5db-4b26-beab-d6922d4a4d47.pdf use the \E\ to escape the backslash. (can be deactivated).
Measurement-Values
The software analyzes the recorded evaluation - e.g. ECG values, execute several algorithms and produces hundreds of physiologicial / statistical data - named "Measured Values". A list of possible measured values can be obtained from the manufacturer of the software or the implementer. The export of these values is normally not activated.
Exemplary, we use here the the measured Values:
- Heart Rate, Resting (HF_R): The heart rate for a resting patient, e.g. 71 beats per minute.
- Heart Axis Type (H_AXIS_TYPE): This is an physiological type, reflecting the direction of the main activation of the heart. e.g. "vertical heart".
- QT Time (QT_Zeit): This is an (statistical) timespan between the Q and the T-wave of an ECG graph, e.g. 374 milliseconds.
MSH|^~\&|||||20210604131051.208+0200||ORU^R01^ORU_R01|3301|P|2.5|||NE|NE|D PID|1||197051008||Benson^Joe||19570213000000+0100|M|||Trebeck Street 14^^Tedworth, South^^10417 PV1|1|U|H1A^^B377T^IM^^^3^5e||||||||||||||||3044281008||K ORC|SC|12345|CM0000000001||CM OBR|1|12345|CM0000000001|EKG03^EKG03|||20210602160514|||||||20210602160514||||||||20210604125008||||||||||&Supervisor OBX|1|ST|AKT_BEF^Report|1|Demo-EKG||||||P OBX|2|NM|HF_R^Heart Rate, Resting|1|71|^bpm|||||P OBX|3|FT|H_AXIS_TYPE^Heart axis type|1|vertical heart||||||P OBX|4|NM|QT_ZEIT^QT Time|1|374|^ms|||||P
It is recommended to use the OBX-3-1 as a filter, and OBX-3-2 as the text which is shown to a user.
Medical Document (MDM)
Supported Message Types: MDM^T01, MDM^T02, MDM^T07, MDM^T08, MDM^T11
When the results the following documents can be exported via MDM:
- PDF File
- Picture Data (PNG)
- DICOM ECG Data
- RTF File
Please note: Picture Data and RTF File may be subject to be declared as obsolete in the next versions. DICOM: In general, the separate DICOM store functionality should be used, instead of the HL7 export.
The export is done via TXA Segment and points to the file in the file share:
#####################
Additionally an OBX Segment can be added to the MDM message which follows the same syntax as in ORU message. (see section "OBX-Segment" above).
HL7 Segments
This HL7-Segements section describes the typical used data fields and components - it is not a complete mapping list, because it should focus on a reasonable usage of the system.
In case more information should be transferred or processed - please refer to the authorized system vendor.
Optionality Key
Incoming
| r | required | This value is required for a proper function of the software |
| o | optional | This value is not required but may be used for some functionality in custo diagnostic. |
| i | ignored | This value is ignored |
Outgoing
| s | send | This value will be send by default, in case the data is available |
| so | send optional | This value will be send, in case it is agreed between the communication partners. |
MSH - Segment
| Field | o/r/i | s/so | Default Usage |
|---|---|---|---|
| MSH-3 | o | so | Sending Application. Incoming: Expected value can be configured (default empty) in custo diagnostic and works as a filter - meaning messages with deviant content in MSH-3 are ignored. Outgoing: Sending Application, e.g. "CUSTO" can be configured in custo diagnostic. |
| MSH-4 | o | so | Sending Facility Incoming: Expected value can be configured in custo diagnostic and works as a filter - meaning messages with deviant content in MSH-4 are ignored. Outgoing: Sending Application, e.g. "CUSTO" can be configured in custo diagnostic. When a tenant system (german "Mandantensystem") is configured, this field contains the information about the tenant. See "Tenant System" below. |
| MSH-5 | o | so | Receiving Application Incoming: Expected value can be configured (default empty) in custo diagnostic and works as a filter - meaning messages with deviant content in MSH-3 are ignored. Outgoing: Receiving Application, can be configured (default empty) in custo diagnostic e.g. "HIS". |
| MSH-6 | o | so | Receiving Facility Incoming: Expected value can be configured in custo diagnostic and works as a filter - meaning messages with deviant content in MSH-3 are ignored. When a tenant system (german "Mandantensystem") is configured, this field should contain the information about the tenant. See "Tenant System" below. Outgoing: Receiving Facility, can be configured (default empty) in custo diagnostic e.g. "HIS". |
| MSH-7 | r | s | Date/Time Of Message, see HL7 Standard. ##DTM## |
| MSH-9 | r | s | Message Type. By default, custo diagnostic sends Messagetype^Event^Message-Structure, e.g. ORU^R01^ORU_R01. |
| MSH-10 | r | s | Message Control ID, see HL7 Standard |
| MSH-12 | r | s | Version ID, Outgoing: Custo diagnostic supports Version 2.3, 2.5 ##Verhalten bei eingehenden Nachrichten noch prüfen, wenn 2.7 2.9 oder 1.5 o.ä. drin steht## |
| MSH-13 | r | s | Sequence Number, see HL7 Standard |
| MSH-15 | s | Accept Acknowledge see below "Accept / Application Acknowledge" | |
| MSH-16 | i | s | Application Acknowledge Receiving: ignored. Sending: Always set to "NE" see below "Accept / Application Acknowledge" |
| MSH-18 | i | s | Character Set Receiving messages: custo diagnostic considers the character set specified in MSH-18. custo diagnostic can be configured to use a specific character set. In general Windows-1252 is used and send out via MSH-18. This one setting is used for alle outgoing messages. |
Accept / Application Acknowledge
custo diagnostic supports message acknowledge, but not application acknowledge.
Message Acknowledge can be configured for each channel / message type. While for TCP/IP socket connections message acknowledge is mandatory, it can be activated/deactivated for message transfer via files.
This means, when receiving a message MSH-15 / MSH-16 is ignored, because the general configuration is taken. When sending a message, MSH-15 will depict the configuration in custo diagnostic. MSH-16 will always be "NE".
PID - Segment
##Required sind patienten name/vorname, geburtsdatum?, Patienten-nummer, geschlecht?
| Field | o/r/i | s/so | Default Usage |
|---|---|---|---|
| PID-3 | r | s | PID-3-1 is used to identify the patient in custo diagnostic. It must be unique in one custo diagnostic installation, otherwise an appropriate tenant system must be used (see tenant system below). |
| PID-5 | r | s | PID-5-1, PID-5-2, PID-5-3, PID-5-4, PID-5-6: Family Name, Given Name, Second Name, Suffic, Degree/Title Required: PID-5-1 |
| PID-7 | r | s | Date of birth |
| PID-8 | r | s | Administrative Sex. Supported Values are F, M, ?? Other Values are interpeted as ... ##zu prüfen## |
| PID-11 | o | s | Address of the patient |
| PID-19 | o | s | Social Security Number |
PV1 - Segment
##bitte aus default mapping ergänzen## Ist wahrscheinlich alles optional
Auch die möglichen WErte für PV1-2 und PV1-21 wären interssant.##
| Field | o/r/i | s/so | Default Usage |
|---|---|---|---|
| PV1-2 / PV1-22 | o | Patient Visit price indicator. ### | |
| PV1-3 | o | s | Patient Visit location (Processed: PV1-3-1, PV1-3-2, PV1-3, PV1-3-4, PV1-3-5, PV1-3-7, PV1-3-8, PV1-3-9 (not supported PV1-3-6) |
| PV1-19 | r | s | Visit-ID. The visit id is used to identify the visit in custo diagnostic It must be unique in one custo diagnostic installation, otherwise an appropriate tenant system must be used (see tenant system below). |
| PV1-44 | o | - | Admission Date: custo diagnostic can store this information, even it is not shown in the user interface. Its done for future usage. |
| PV1-45 | o | - | Discharge Date/Time: custo diagnostic can store the discharge date/time to filter out discharged patients in patient search lists. It can be defined, how custo diagnostic interpretes an empty discharge date/time - either als missing, unknown information, or as the information, that the discharge date should be deleted in custo diagnostic. |
ORC - Segment
| Field | o/r/i | s/so | Default Usage |
|---|---|---|---|
| ORC-1/ORC-5 | r | See OBR-1 / OBR-5 | |
| ORC-16 | o | ORC-16-2: Order Control Code Reason / Clinical questions, shown to the user before processing the observation request. |
OBR - Segment
##bitte prüfen, ob hier alles aus default mapping drin ist
| Field | o/r/i | s/so | Default Usage | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| OBR-1 / OBR-5 | r | s/so | Order Control The combination of OBR-1 and OBR-5 can be configured as order control: Default:
By default, OBR-5 is not evaluated, but can be configured to specific values. In this case the combination of OBR-1 and OBR-5 must match. Outgoing: See also "Sending Observation Status via ORR / ORU Messages" | |||||||||||||||
| OBR-2 | r | s | Placer ID | |||||||||||||||
| OBR-3 | i | s | Outgoing: Consecutive Number with an alphanumeric prefix, e.g. "CM00001234" or a GUID,. This can be configured by a fixed length consecutive number, with an arbitrary alphanumeric prefix, e.g. "CM00001234", or an GUID e.g. "36eea93b-bc1b-4769-a84e-4ebeaaaf387e" | |||||||||||||||
| OBR-4 | r | s | OBR-4 contains information about the type of observation which should by executed. OBR-4-1 is a coded value which must be defined/agreed between interface partner. OBR-4-2 when incomfing, OBR-4-2 is shown to the user, e.g. "Resting ECG", must be defined/agreed between interface partner. OBR-4-1 and OBR-4-2 is required, other components optional. Outgoing: The software sends OBR-4 as received with the order. | |||||||||||||||
| OBR-5 | see OBR-1 | |||||||||||||||||
| OBR-20 | o | so | Incoming: Flexible text-fields which can be used to show additional information regarding this order to the user. | |||||||||||||||
| OBR-21 | o | so | Incoming: Flexible text-fields which can be used to show additional information regarding this order to the user. |
Physical Transport
custo diagnostic server supports TCP/IP socket based (recommended) and file based communication.
TCP/IP socket communication
For HL7 socket communication custo diagnostic server can act as an server or client.
In general for incoming messages (e.g. ADT) custo diagnostic server listens as a server on incoming connections. For safety and security reasons, the sending IP must be whitelisted.
In general for outgoing messages (e.g. ORU) custo diagnostic server acts as client and initiates the socket to the counterpart.
File based communication
custo diagnostic can poll for HL7-files in different file locations, process the files and deletes them.
custo diagnostic can write HL7 files to a specific file locations.
By default, the custo diagnostic server operates by Local System account on the windows host, meaning that the service is able to access all local files but no remote file share, residing on a different windows host.