HL7Gateway

Anforderungen und Leistungsbeschreibung

Dieses Dokument bezieht sich auf HL7gateway in der Version v1.1.1, released 2024-04-18. (Changelog)

Download:

samedi-hl7gateway.msi (Windows Installer, 64bit)
hl7gateway_1.1.1 _windows_amd64.zip (Windows Portable, 64bit)
hl7gateway_1.1.1 _linux_amd64.tar.gz (Linux AMD64, 64bit)
hl7gateway_1.1.1 _linux_arm64.tar.gz (Linux ARM, 64bit)
hl7gateway_1.1.1 _darwin_all.tar.gz (macOS Universal Binary, 64bit)

Anforderungen für Termin-Synchronisation an das Kliniksystem

SIU-Out-Support (S12, S13, S14, S15) für Termindatenübertragung nach samedi.
SIU-In-Support (S12, S13, S14, S15) für Termindatenübertragung von samedi.
Support für ausgehende Patientendaten (ADT-Out) zur Übertragung von Patienten-Stammdaten und Falldaten zu samedi. (PID, PV1)
HL7 Version v2.x - mindestens v2.5 bis v2.8. (Nachrichtenübertragung via MLLP)

Funktionen der samedi HL7-Schnittstelle

HL7-Gateway ist ein Programm, das als Windows-Service auf einem Klinikrechner im Hintergrund läuft und kontinuierlich Termindaten synchronisiert. Die Synchronisation mehrerer samedi-Accounts wird unterstützt.

SIU-In-Support (S12, S13, S14, S15) für Termindatenübertragung ausserhalb von samedi gebuchter Termine zu samedi.
SIU-Out-Support (S12, S13, S14, S15) für Termindatenübertragung von samedi.
ADT-In-Support für Übertragung von Patienten-Stammdaten zu samedi.
Unterstützte Zeichensätze: ISO-8859-1, UTF-8, weitere Zeichensätze sind auf Anfrage möglich.
Updates von in samedi gebuchten Terminen über die HL7-Schnittstelle ist in begrenztem Umfang möglich.

In den verwendeten samedi-Accounts muss jeweils das HL7-Schnittstellen-Paket gebucht sein.

Systemanforderungen

Aktuelles Windows, 64-Bit.
HL7gateway benötigt Zugriff auf samedi über das Internet und auf das Kliniksystem via HL7.

Von der samedi HL7-Schnittstelle versandte Nachrichten

Terminupdates werden innerhalb weniger Sekunden nach der Buchung in samedi als HL7-Nachrichten von der Schnittstelle versendet.

SIU-S12

Wird versandt, wenn ein neuer Termin in den samedi-Kalender gebucht wird.

Feld	Inhalt	Kommentar
`SCH`
`SCH-2-1` (Placer Appointment ID)	Termin-ID in samedi
`SCH-8-1` (Appointment Type)	Terminart-ID in samedi
`SCH-8-2`	Terminart-Name
`SCH-8-4`	Externe Referenz der Terminart (frei konfigurierbarer Identifier)
`SCH-8-5`	Externe Referenz der Terminart
`SCH-25-1`	Terminstatus, `"Booked"` oder `"Cancelled"` (in S15-Nachrichten)
`TQ1`
`TQ1-7` (Start Date/Time)	Startzeit des Termins
`TQ1-8` (End Date/Time)	Endzeit des Termins
`TQ1-13` (Occurrence Duration)	Dauer des Termins (z.B.: `"45^min"`)
`NTE`	Für jedes Kommentarfeld in samedi Terminen wird ein NTE-Segment gesendet
`NTE-2`	Name des Kommentarfelds (`"_default"` für das Standard-Kommentarfeld)
`NTE-3`	Inhalt des Kommentarfelds
`RGS`
`RGS-1`	Ressourcen-Gruppe; für gelöschte und hinzugefügte Ressourcen wird ein eigenes RGS-Segment gesendet.
`RGS-2` (Segment Action Code)	Aktion `"A"` (Deleted: `"D"`, Updated: `"U"`, Unchanged: `"X"`)
`AIG`	Für jeden Teiltermin des Termins wird ein AIG-Segment gesendet
`AIG-1` (Set-ID)	Set-ID; fortlaufend numeriert.
`AIG-2` (Segment Action Code)	Aktion `"A"` (Deleted: `"D"`, Updated: `"U"`, Unchanged: `"X"`)
`AIG-3-1` (Resource ID - Identifier)	ID der Ressource in samedi
`AIG-3-2` (Resource ID - Text)	Name der Ressource in samedi
`AIG-3-3` (Resource ID - Name of Coding System)	`99SAMEDI-RESOURCE`
`AIG-3-4` (Resource ID - Alternate Identifier)	Externe Referenz der Ressource (frei konfigurierbarer Identifier)
`AIG-8` (Start Date/Time)	Startzeitpunkt der Ressourcenbelegung
`AIG-11` (Duration)	Dauer der Ressourcenbelegung (in Sekunden)
`AIG-12` (Duration Units)	Wert `"s"`
`AIS-10` (Filler Appointment Status)	Wartelistenstatus des Termins (siehe “SRM AIS.10 Filler Status Mapping”) `"s"`
`PID`
`PID-1` (Set-ID “1”)
`PID-2-1`	KIS-Patientennummer, sofern bekannt
`PID-3-1`	samedi-Patienten-ID
`PID-5-1`	Nachname
`PID-5-2`	Vorname
`PID-5-5` (Prefix)	Titel
`PID-7`	Geburtsdatum
`PID-8`	Geschlecht
`PID-11`	Adresse (Straße, PLZ, Ort)
`PID-13`	Telefonnummern (Mobil: `CP`, Fax: `FX`, Festnetz: `PH`) und Email Adresse (`X.400`)	`+49 171 1234567^^CP` `+49 89 12345-678^^PH` `mail@example.org^^X.400` `+49 89 12345-679^^FX`

SIU-S13

Wird versandt, wenn ein bestehender Termin verschoben wurde (d.h. die Startzeit oder die Dauer wurden verändert). Wenn gleichzeitig noch andere Attribute verändert wurden (Kommentare o.ä.), wird keine zusätzliche SIU^S14 gesendet.

Die Felddefinition ist analog zu SIU^S12.

SIU-S14

Wird versandt, wenn die Attribute eines bestehenden Termins verändert wurden, ohne dass der Termin dabei verschoben wurde (d.h. Startzeit und Dauer bleiben gleich).

Die Felddefinition ist analog zu SIU^S12.

SIU-S15

Wird versandt, wenn ein bestehender Termin abgesagt wurde.

Die Felddefinition ist analog zu SIU^S12.

ADT-A08 (Update Patient Information)

Wird versandt, wenn ein Patient in samedi angelegt oder aktualisiert wird.

ADT-A23

Wird versandt, wenn ein Patient in samedi gelöscht wird.

Feld	Inhalt	Kommentar
`EVN-2` (Recorded Date Time)	Timestamp des Ereignisses in samedi
`PID`	Patientendaten	Inhalt dieses Segments ist analog zum Format in `SIU-S12`-Nachrichten
`PV1-2` (Patient Class)	`U` (Unknown)

Eingehende Nachrichten

Von der samedi HL7-Schnittstelle verarbeitete Nachrichten aus dem Kliniksystem.

eingehende SIU-Nachrichten

Feld	Inhalt	Kommentar
`SCH`
`SCH-2-1` (Placer Appointment ID)	Externe Termin-ID-Referenz	muss angegeben werden
`SCH-8-1`	Titel des Termins in samedi
`SCH-8-4`	externe Referez der Terminart in samedi (wenn gesetzt wird `SCH-8-1` ignoriert)
`TQ1`
`TQ1-7`	Start Time
`TQ1-8`	End Time
`PID`	Patientendaten	Parsing ist analog zu eingehenden `ADT-A08`-Nachrichten
`RGS`
`NTE-2`	Titel des Terminkommentars in samedi
`NTE-3`	Text des Terminkommentars in samedi
`RGS-2`	“D”: Terminabsage, “A”: Neuer Termin, “U”: Terminänderung
`AIG`
`AIG-3-1`	Ressourcen-Referenz oder Ressourcen-ID in samedi
`AIG-3-3`	wenn dieses Feld den Wert `99SAMEDI-RESOURCE` hat ist `AIG-3-1` eine samedi Ressourcen-ID
`AIG-3-4`	Ressourcen-Referenz in samedi. Wenn dieses Feld einen Wert hat, überschreibt es die Ressourcen-Referenz aus `AIG-3-1`
`AIG-8`	Start Time	benutzt Zeit aus dem TQ1-Segment, falls hier keine Zeit angegeben ist
`AIG-11`	Duration	Dauer der Ressourcenbelegung
`AIG-12`	Duration Unit	`"min"`
`AIL`
`AIL-3`	parsing analog zu `AIG-3`
`AIL-6`	Start Time	benutzt Zeit aus dem TQ1-Segment, falls hier keine Zeit angegeben ist
`AIL-9`	Duration	Dauer der Ressourcenbelegung
`AIL-10`	Duration Unit	`"min"`
`AIP`
`AIP-3`	parsing analog zu `AIG-3`
`AIP-6`	Start Time	benutzt Zeit aus dem TQ1-Segment, falls hier keine Zeit angegeben ist
`AIP-9`	Duration	Dauer der Ressourcenbelegung
`AIP-10`	Duration Unit	`"min"`
`AIS-12`	Patientenbenachrichtigung	`"notify^true"` oder `"notify^false"`, default `false`

Unterstützte Telefonnummernformate in PID-13

- Telefonnummern werden in den Feldern `XTN-4`, `XTN-5,6,7,8`, `XTN-12` oder `XTN-1` erkannt.
- Die Art der Telefonnummer ergibt sich aus XTN-3: `PH`: Telefon, `FX`: Fax, `CP`: Mobiltelefon
- Für E-Mail-Adressen muss XTN-3 den Wert `X.400` oder `Internet` haben.

Beispiele:

- `^^CP^0151555123`
- `^^PH^^^^123`: Telefonnummer "123"
- `^^PH^^1^2^3^4`: Telefonnummer "1234"
- `email@example.org^^X.400`
- `^PRN^Internet^email@example.org`
- `^^CP^+4915212345~^^PH^030555123`: Patient mit sowohl Festnetz- als auch Mobiltelefonnummer

Eingehende ADT-Nachrichten

ADT-A01, ADT-A04, ADT-A08

Legt einen neuen Patienten an oder aktualisiert ihn, wenn er bereits existiert.

Feld	Inhalt	Kommentar
`PID`	Patientendaten
`PID-3`	Patientennummer. samedi-Patienten-ID, wenn `PID-3-4-2` (Assigning Authority) `www.samedi.de` ist; andernfalls KIS-Patienten-ID
`PID-5-1`	Nachname
`PID-5-2`	Vorname
`PID-5-5` (Prefix)	Titel
`PID-7`	Geburtsdatum
`PID-8`	Geschlecht
`PID-11`	Adresse (Straße, PLZ, Ort)
`PID-13`	Telefonnummer	`^^CP^+49 171 1234567` ¹

Beispielnachrichten

SIU-Nachrichten aus samedi

Neuer Termin (S12)

“radiologist” und “room-1” sind externe Ressourcenreferenzen und lassen sich in samedi frei konfigurieren. (samedi sendet stets “AIG”-Segmente für Ressourcen)
“p9088cd2903” ist die samedi Patienten-ID

MSH|^~\&|samedi-hl7gateway|samedi|system|clinic|20180207130859+0100||SIU^S12^SIU_S12|7504504064263669287|P|2.5||||||UNICODE UTF-8
SCH||9-dpcdk6gvsbetzd3v||||BOOKED||1^MRT|1800||^^M30^20180516130000+0200^20180516133000+0200||||||||||||||Booked
TQ1|1||||||20180516130000+0200|20180516133000+0200|||||30^min
NTE||_default|Comment
NTE||Kommentar zum Patienten|patient comment, patient without external patient number
PID|1||p9088cd2903^^^&www.samedi.de&DNS^PI~^^^^PT||Müller^Peter||19751024|M|||Bahnhofstrasse 12^^Berlin^^12345||+49 171 1234567^^CP~+49 89 12345-678^^PH~mail@example.org^^X.400~+49 89 12345-679^^FX
RGS|1|A
AIG|1|A|2^Peter Koch^99SAMEDI-RESOURCE^radiologist|||||20180516130000+0200|||1800|s
AIG|2|A|1^Sprechzimmer^99SAMEDI-RESOURCE^room-1|||||20180516130000+0200|||1800|s

Termin verschieben (S13)

MSH|^~\&|samedi-hl7gateway|samedi|system|clinic|20180207131000+0100||SIU^S13^SIU_S12|11199607447739267382|P|2.5||||||UNICODE UTF-8
SCH||9-dpcdk6gvsbetzd3v||||BOOKED||^Test|1800||^^M30^20180410135000+0200^20180410142000+0200||||||||||||||Booked
TQ1|1||||||20180410135000+0200|20180410142000+0200|||||30^min
RGS|1|D
AIG|1|D|1^Sprechzimmer^99SAMEDI-RESOURCE^c2|||||20180410125500+0200|||1800|s
RGS|2|A
AIG|2|A|2^Doc^99SAMEDI-RESOURCE^c1|||||20180410135000+0200|||1800|s

Termin aktualisieren (S14)

MSH|^~\&|samedi-hl7gateway|samedi|system|clinic|20180207131202+0100||SIU^S14^SIU_S12|12156940908066221323|P|2.5||||||UNICODE UTF-8
SCH||9-dpcdk6gvsbetzd3v||||BOOKED||1^MRT|1800||^^M30^20180516140000+0200^20180516143000+0200||||||||||||||Booked
TQ1|1||||||20180516140000+0200|20180516143000+0200|||||30^min
NTE||_default|updated comment
NTE||Kommentar zum Patienten|patient comment, patient without external patient number
PID|1||p9088cd2903^^^&www.samedi.de&DNS^PI~^^^^PT||Müller^Peter||19751024|M
RGS|1|X
AIG|1|X|2^Peter Koch^99SAMEDI-RESOURCE^radiologist|||||20180516140000+0200|||1800|s
AIG|2|X|1^Sprechzimmer^99SAMEDI-RESOURCE^room-1|||||20180516140000+0200|||1800|s

Termin absagen (S15)

MSH|^~\&|samedi-hl7gateway|samedi|system|clinic|20180207131507+0100||SIU^S15^SIU_S12|6263450610539110790|P|2.5||||||UNICODE UTF-8
SCH||9-dpcdk6gvsbetzd3v||||BOOKED||1^MRT|1800||^^M30^20180516140000+0200^20180516143000+0200||||||||||||||Deleted
TQ1|1||||||20180516140000+0200|20180516143000+0200|||||30^min
NTE||_default|updated comment
NTE||Kommentar zum Patienten|patient comment, patient without external patient number
PID|1||p9088cd2903^^^&www.samedi.de&DNS^PI~^^^^PT||Müller^Peter||19751024|M
RGS|1|D
AIG|1|D|1^Sprechzimmer^99SAMEDI-RESOURCE^room-1|||||20180516140000+0200|||1800|s

Beispiel für einen Blocker-Termin (ohne Patient)

MSH|^~\&|samedi-hl7gateway|samedi|system|clinic|20180207123459+0100||SIU^S12^SIU_S12|5577006791947779410|P|2.5||||||UNICODE UTF-8
SCH||5-dpcdk6gvsbetzd3v||||BOOKED||^blocked time|1800||^^M30^20180514110000+0200^20180514113000+0200||||||||||||||Booked
TQ1|1||||||20180514110000+0200|20180514113000+0200|||||30^min
NTE||_default|this is a comment
RGS|1|A
AIG|1|A|2^Peter Koch^99SAMEDI-RESOURCE^radiologist|||||20180514110000+0200|||1800|s
AIG|2|A|1^Sprechzimmer^99SAMEDI-RESOURCE^room-1|||||20180514110000+0200|||1800|s

Beispiel für einen Termin eines Patienten mit externer Patientennummer (12345)

MSH|^~\&|samedi-hl7gateway|samedi|system|clinic|20180207124406+0100||SIU^S12^SIU_S12|3916589616287113937|P|2.5||||||UNICODE UTF-8
SCH||7-dpcdk6gvsbetzd3v||||BOOKED||1^MRT|1800||^^M30^20180516100000+0200^20180516103000+0200||||||||||||||Booked
TQ1|1||||||20180516100000+0200|20180516103000+0200|||||30^min
NTE||Kommentar zum Patienten|patient with an external patient ID
PID|1|12345|pb327b78324^^^&www.samedi.de&DNS^PI~12345^^^^PT||Schmitt^Julia|||F
RGS|1|A
AIG|1|A|2^Peter Koch^99SAMEDI-RESOURCE^radiologist|||||20180516100000+0200|||1800|s
AIG|2|A|1^Sprechzimmer^99SAMEDI-RESOURCE^room-1|||||20180516100000+0200|||1800|

ADT-Nachrichten aus samedi

Neu angeleger Patient / Update eines Patienten

MSH|^~\&|samedi-hl7gateway|samedi|APPLICATION|CLINIC|20190403151846+0200||ADT^A08^ADT_A01|880654704043574241|P|2.5||||||UNICODE UTF-8
EVN|A08|201904031516+0200
PID|1|12345|pbd7aac1a98^^^&www.samedi.de&DNS^PI~12345^^^^PT||Lastname^Robert^^^Prof.||19900613|M|||Street Address 12^^City^^12345||+49151 555 12345^^CP~+49 30 555 123^^PH~email@example.org^^X.400
PV1|1|U

Gelöschter Patient

MSH|^~\&|samedi-hl7gateway|samedi|APPLICATION|CLINIC|20190403152323+0200||ADT^A23^ADT_A21|10360301753052711884|P|2.5||||||UNICODE UTF-8
EVN|A23|201904031523+0200
PID|1|98|p61d45a7a54^^^&www.samedi.de&DNS^PI~98^^^^PT||Last^First||197810201
PV1|1|U

Eingehende ADT-Nachricht

MSH|^~\&|KomServer|KOMSERV|samedi-hl7gateway|samedi|20180523123517||ADT^A08|1527069055426|P|2.5|8D51C41E7CD680A||AL|NE||8859/1
EVN|A08|201710260719
PID|1||1233^^^&www.samedi.de&DNS^PI~159922^^^Medavis^PI|10000026^^^MOS^PI|Test^Frauke||19431011|F|||Musterstr. 15&Musterstr. 15^^Duesseldorf^^40545^^L||^^PH^^^^0211-1234567 Toch|^^PH

Beispiel für eingehende SIU-Nachrichten

Neuer Termin

MSH|^~\&|system|clinic|samedi-hl7gateway|samedi|20170101000000||SIU^S12^SIU_S12|76543|P|2.5||||||8859/1
SCH||456789^system||||||Sprechstunde, Peter Mueller|||||||||||||||||Booked
TQ1|1||||||201701150800|201701150830|||||30^min
RGS|1|A
AIG|1|A|room-1|||||201701150800^YYYYLLDDHHMM|||30|min

MSH|^~\&|system|clinic|samedi-hl7gateway|samedi|20170101000000||SIU^S12^SIU_S12|76543|P|2.5||||||8859/1
SCH||456789^system||||||Sprechstunde, Peter Mueller|||||||||||||||||Booked
TQ1|1||||||201701150800|201701150830|||||30^min
PID|1|12345|pb327b78324^^^&www.samedi.de^PI~12345^^^^PT||Schmitt^Julia|||F
RGS|1|A
AIL|1||room-1|||201701150800^YYYYLLDDHHMM|||30|min
AIP|1||radiologist|||201701150800^YYYYLLDDHHMM|||30|min

Spezifikation einer Ressource über die samedi-ID:

MSH|^~\&|system|clinic|samedi-hl7gateway|samedi|20170101000000||SIU^S12^SIU_S12|76543|P|2.5||||||8859/1
SCH||456789^system||||||Sprechstunde, Peter Mueller|||||||||||||||||Booked
TQ1|1||||||201701150800|201701150830|||||30^min
RGS|1|A
AIG|1|A|123456^^99SAMEDI-RESOURCE|||||201701150800^YYYYLLDDHHMM|||30|min

↩︎