...
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. (It is not a comprehensive description, because it should focus on the typical usage. In case more information fields / data is necessary, please refer to your authorized custo med partner to see specific options to use specific mappings of data fields.
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 . 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
Table of Contents |
---|
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.
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.
ToDo
FHo: Alles nochmal mit Mapping Tabelle abgleichen
Dev: Alle ## Einträge nachschauen/ergänzen.
Content
Table of Contents |
---|
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
The role of custo diagnostic in HL7 context is to act as a consumer for patient data, process incoming orders and/or exporting results via HL7.
ADT Messages
Supported messages: A01, A02, A03, A04, A05, A08, A11, A12, A13, A23, A29, A38, A40, A42, A43, A45 (further message types can be defined).
Patient / Visit Identification
...
In case a patient/visit already exists in custo diagnostic, it is updated by default by each ADT message. (please also see "Null Value" in section "General HL7 information" ).
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/or which messages updates a patient/visit information.
...
PV1-45 is used to set the discharge date of the patient.
##bitte ##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`?)
...
When receiving an order, the software also supports additional information (optional):
OBX-3-1 | OBX-3-2 |
---|
Usage | |
---|---|
PATIENT WEIGHT | Weight |
of patient | custo diagnostic uses this value to determine the |
PATIENT |
HEIGHT | Height of patient | |
MEDICATION | Medication | This string can be shown to the user, while working with custo diagnostic. |
Even this information is transferred Even this information is transfered with an order - it is stored/updates the visit information.
The following units are supported:
- Weight:
...
- kg, ##
- Height: m, cm, ##
Order Status
##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).
...
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
...
observation identifier, see below
OBX-3-1 code, OBX-3-2 text/human readable
...
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. One or more of the listed observation data can be exported in the same message. Alternatively one message per observation data can be send.
Sample - Outgoing ORU Message with Formatted-Text Report and Base64-encoded PDF-File
e.g. AKT_BEF contains the typed in report, marked with (OBX-11) "F" → Final.
Code Block |
---|
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 shown in sample 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. We do not recommend, to use the referenced file share as a long-lasting "archive".
...
Observation Result Status. (see above, section "Observation Result Status")
1) Incoming: See section "Orders".
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:
...
Points to an PDF-File, including path.
...
Code Block |
---|
MSH|^~\&|||||2021060411085320210604125019.84469+0200||ORU^R01^ORU_R01|24012701|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|EDRP|FILE_PDF^PDF File||^^pdf^Base64^JVBERi0xLjQKJcOiw6MKMSAwIG9iago8PAovVGl0bGUgKP7AGMAdQBzAHQAbwBfAGQAaQBhA ... olJUVPRgo=\E\\E\myserver\E\theshare\E\30c5ef4b-a5db-4b26-beab-d6922d4a4d47.pdf^^pdf||||||F P OBX|2|FTST|AKT_BEF^Report|1|normofrequenterDnormofrequenter 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.
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.
Code Block |
---|
MSH|^~\&|||||20210604131051.208+0200||ORU^R01^ORU_R01|3301|P|2.5||| |
Code Block |
MSH|^~\&|||||20210604125019.69+0200||ORU^R01^ORU_R01|2701|P|2.5|||NE|NE|D PID|1||197051008||Benson^Joe||1957021319570213000000+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||||||||2021060410323520210604125008||||||||||&Supervisor OBX|1|RPST|FILEAKT_PDF^PDF FileBEF^Report||\E\\E\myserver\E\theshare\E\30c5ef4b-a5db-4b26-beab-d6922d4a4d47.pdf^^pdf1|Demo-EKG||||||P OBX|2|STNM|AKT_BEF^ReportHF_R^Heart Rate, Resting|1|Dnormofrequenter Sinusrhythmus\.br\Steiltyp|71|^bpm|||||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.
Code Block |
---|
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.
Components which are affected by the workflow are described in the above data handling / workflow sections.
Optionality Key
Incoming
...
Outgoing
...
MSH - Segment
...
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.
...
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.
...
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".
...
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".
...
Message Type. By default, custo diagnostic sends Messagetype^Event^Message-Structure, e.g. ORU^R01^ORU_R01.
...
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##
...
Accept Acknowledge
see below "Accept / Application Acknowledge"
...
Application Acknowledge
Receiving: ignored. Sending: Always set to "NE"
see below "Accept / Application Acknowledge"
...
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?
...
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-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
...
Administrative Sex. Supported Values are F, M, ?? Other Values are interpeted as ...
##zu prüfen##
...
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.
Operation Results via MDM
Supported Message Types: MDM^T01, MDM^T02, MDM^T07, MDM^T08, MDM^T11
Independently from ORU, custo diagnostic can also transfer data via MDM to another system.
The MDM export is typically used to transfer PDF-Files. (For historical reasons other exports may be possible via MDM: Picture Data (PNG), DICOM Waveform, RTF-File - but these options may no longer supported).
DICOM: In general, the separate DICOM store functionality should be used, instead of the HL7 export.
The MDM message contains a TXA and OBX segment, which points to the file in the file share / or covers the PDF as base64 embedded.
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.
Components which are affected by the workflow are described in the above data handling / workflow sections.
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" above. |
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" above. 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 (see section General HL7 information) |
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? Stimmt das?
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 above). |
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
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-21 | 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" above). | |||||||||||||||||||||
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 | s | See OBR-1 / OBR-5 |
ORC-2 | r | so | Placer ID (see OBR-2) |
ORC-3 | i | s | Filler ID (see OBR-3) |
ORC-7-6 | o | so | Priority Description |
ORC-16 | o | so | ORC-16-2: Order Control Code Reason / Clinical questions, shown to the user before processing the observation request. |
OBR - Segment
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-1 / -2 | r | s | OBR-4-1/OBR-4-2 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 incoming, 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-4-4 | o | so | Alternate Order ID. This might be an additional id, given bei the ordering system, to handle several observation requests in one common order (ORC). In DICOM environments, OBR-4-4 is used as Study Instance UID. | |||||||||||||||
OBR-5 | see OBR-1 | |||||||||||||||||
OBR-7-1 | i | s | Time of Acquisition | |||||||||||||||
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. | |||||||||||||||
OBR-32-1-2 | i | s | User-Account, entering/confirming the report | |||||||||||||||
OBR-36 | o | - | Scheduled Date / Time |
OBX
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.##
...
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).
...
-Segment
Field | o/r/i | s/so | Default Usage |
---|
OBX-1 |
See OBR-1 / OBR-5
OBR - Segment
##bitte prüfen, ob hier alles aus default mapping drin ist
...
Order Control
The combination of OBR-1 and OBR-5 can be configured as order control:
Default:
OBR-1 | OBR-5 | Usage |
---|---|---|
NW | * | New order |
XO | * | Change Order |
not configured | not configured | Delete scheduled datetime |
CA | * | Cancel Order |
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"
...
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 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.
...
1) | s | Set-ID | |
OBX-2 | 1) | s | Value Type (ST, NM, FT, RP, ED) |
OBX-3 | 1) | s | observation identifier, see below OBX-3-1 code, OBX-3-2 text/human readable |
OBX-5 | 1) | s | observation value, see below |
OBX-6 | 1) | s | OBX-6-1 empty, OBX-6-2 units |
OBX-11 | 1) | so | Observation Result Status. (see above, section "Observation Result Status") |
1) Incoming: See section "Orders"
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. | ||
TXA-Segment
(Use Case: PDF Export)
Field | s/so | Default Usage |
---|---|---|
TXA-2 | s | Always CD |
TXA-3 | Always AP | |
TXA-4-1 | s | Acquisition Time of Evaluation |
TXA-6-1 | s | Export Time / Creation Time of Document |
TXA-9-2-1 | s | User-Account, created the report |
TXA-15-1 | Filler ID |
(Use Case: PDF Export)
...
Physical Transport
custo diagnostic server supports TCP/IP socket based (recommended) and file based communication.
...
In general for incoming messages (e.g. ADT) custo diagnostic server listens as a server on for incoming connections. For safety and security reasons, the sending IP must be whitelisted.
...
custo diagnostic can poll for HL7-files in different file locations, process the files and deletes them.
...