Versions Compared

Old Version 10

changes.mady.by.user Lisa Moser

Saved on

compared with

New Version Current

changes.mady.by.user Lisa Moser

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Table of Contents


1 Der VeKa-Abfrage-Webservice

1.1 Vorwort

Das VeKa-Center stellt ein Abfragemodul in Form eines Webservice bereit.
 
Dieses Abfragemodul beinhaltet Daten der Versicherer, die die Zustimmung zu der Abfrage gegeben haben.

Die vertraglichen Vereinbarungen sind im Lizenzvertrag und den Richtlinien vorhanden. Dieses Dokument soll vor allem die technische Sicht des Webservice wiedergeben.

Der Webservice hat eine einzige Methode „Query“. Der Inhalt des Inputparameters beinhaltet die Felder, aufgeschlüsselt in XML, die im Vertrag definiert sind. Die Methode liefert wiederum die Felder zurück, die im Vertrag als Rückgabewerte definiert sind. Dort ist auch der fachliche Beschrieb als Anhang definiert. Der eigentliche Datenaustausch wird im SOAP-Body durchgeführt. Dort werden die Daten zum VeKa-Center übermittelt und in der Antwort Struktur zurückgeliefert. Dabei werden die Anfragewerte teilweise kopiert und mit Werten aus dem VeKa-Center ergänzt.

Der Zugriff auf den Webserver wird mit SSL abgesichert. Dabei verlangt der Web-Server nach einem Clientzertifikat. Wird dieses nicht mit der Anfrage übermittelt, so kann keine Abfrage stattfinden.

Weiter verlangt der Webservice eine Benutzer-Passwort Kombination. Nur, wenn das Subject des Zertifikats mit dem Benutzer übereinstimmt und die Benutzer-Passwort Kombination korrekt ist wird die Anfrage behandelt.
Der Webservice ist im WSDL beschrieben:
https://www.versichertenkarte.ch/queryws_1_0/VeKa_Query_1_0.asmx?wsdl

Die korrekten Verbindungsparameter und das Zertifikat werden Ihnen separat mitgeteilt.

Bei der Implementierung ist darauf zu achten, dass keine Kürzel für die Namespaces im Body akzeptiert werden. Der Webservice kann die Inputparameter nicht verarbeiten und somit kommen Fehlermeldungen zurück, dass nicht alle Parameter gefüllt sind.

In der Version 1.2 hat sich geändert, dass neu das Feld basic_insurance_military_delay (Militärversicherung) entfernt wurde, da es von den Versicherern als unnötig deklariert wurde. 
Ebenfalls wurden die Stammtabellen im Kapitel 2.5, das Kapitel 2.2 und die Fehlermeldungen 
mit den Rückmeldecodes 15/16 ergänzt.

In der Version 1.3 hat sich geändert, dass offizielle Angaben der Zentralen Ausgleichsstelle ZAS zurückgeliefert werden. Dabei handelt es sich um Vornamen, Nachnamen, Geburtsdatum und Geschlecht.

Die ZAS-Attribute sind in einen eigenen Knoten verschoben worden, da die Datenquelle das ZAS ist und nicht das VeKa. Um einen Parallelbetrieb aufrecht zu erhalten werden die Attribute noch bis 31.12.2015 am alten Platz geliefert.

Weiterhin kommt in der Version 2.0 die Blacklist des Kantons hinzu. Die Quelle der Daten an dieser Stelle ist das herausgebende Kanton. Sie werden auch nur angezeigt, wenn der abfragende Leistungserbringer bei LSP der

...

santéservices ag angemeldet ist.

Nähere Informationen finden Sie unter https://www.lsp-online.ch.

Die Blacklist wird immer zum aktuellen Stand abgefragt. Es findet keine Historisierung statt.

In der Version 2.1 wurden im Kapitel

...

typeRES_patient die zusätzliche Felder zum erweiterten Deckungsrecord hinzugefügt

...

und beschrieben.

1.1.1 Schutzmechanismen / WAF

Der Zugriff auf den Webservice ist durch Schutzmechanismen einer Web Application Firewall (WAF) abgesichert.

Ein HTTP-Status 400 (Bad Request) kann in einzelnen Fällen darauf zurückzuführen sein, dass der Request durch diese Schutzmechanismen abgewiesen wurde.

Bitte beachten Sie bei der Integration, dass keine zusätzlichen HTTP-Header mitgesendet werden, die für den Webservice nicht erforderlich sind. Bestimmte Header können durch die Schutzmechanismen als potenziell schädlich eingestuft werden. 

Falls ein Request mit HTTP 400 abgewiesen wird, kann santéservices ag anhand der RequestID prüfen, ob der Request durch einen Schutzmechanismus blockiert wurde und weshalb. Bitte geben Sie die RequestID bei einer entsprechenden Anfrage an santéservices ag an.

1.2 Endpoint

Der VeKa-Webservice Endpoint lautet:
https://www.versichertenkarte.ch/queryws_1_0/VeKa_Query_1_0.asmx 



1.3 Graphische Darstellung


1.3.1 Request

1.3.2 Rückgabestruktur



Expand
titleDetail

Image Added



Expand
titleÜberblick

Image Added


Expand
titleDetail VeKa Response/Patient

Image Added

Image Added



→ Für das blau eingefärbte Kreuz (siehe folgende Grafik) ist jeweils Masterdata vorhanden:

    Image Added

1.3.3 Beispiel einer kompletten SOAP Anfrage

Anfragestruktur

Rückgabestruktur


Expand
titleZum Ausklappen hier klicken...

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:veka="http://www.vekacenter.ch/veka_query/">

                <soap:Header/>

                <soap:Body>

                <veka:VeKa_Request>


                <veka:requestDate>2013-08-13T00:00:00</veka:requestDate>

                   <veka:questioners>

                                <veka:questioners>Abfragedienst-Name</veka:questioners>

                                <veka:user>User-Name</veka:user>

                                <veka:password>********</veka:password>

                                <veka:language>D</veka:language>

                   </veka:questioners>


                <veka:provider>

                                <veka:ZSR>T000001</veka:ZSR>

                </veka:provider>


                <veka:insurance/>   


                <veka:patient>

                                <veka:card_id>80756012340000000527</veka:card_id>


                <!--Behandlungsdatum (Schadensdatum):-->

                                <veka:treatment_date>2013-08-13</veka:treatment_date>


                </veka:patient>

                </veka:VeKa_Request>

  </soap:Body>

</soap:Envelope>



Expand
titleZum Ausklappen hier klicken...

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   <soap:Body>

      <VeKa_Response xmlns="http://www.vekacenter.ch/veka_query/">

         <returnCode>0</returnCode>

         <returnMessage/>

         <requestDate>2013-08-13T17:19:48.5267901+02:00</requestDate>

         <request_ID>109783678</request_ID>

         <version>

            <version_no>1.3.0.2</version_no>

            <version_date>2013-03-26T18:15:00+01:00</version_date>

         </version>

         <biller/>

         <provider>

            <ZSR>T000001</ZSR>

         </provider>

         <patient>

            <validFrom>2009-01-01T00:00:00</validFrom>

            <validUntil>2014-06-30T00:00:00</validUntil>

            <cardValidFrom>2009-01-01T00:00:00</cardValidFrom>

            <cardValidUntil>2014-06-30T00:00:00</cardValidUntil>

            <language>D</language>

            <insurance>

               <ean_party>7600000000000</ean_party>

               <BAG_insurance_id>1234</BAG_insurance_id>

               <name>sanacur (Testversicherer)</name>

               <description>Servicecenter</description>

               <phone>012 345 67 89</phone>

               <e_mail>info@sanacur.ch</e_mail>

               <name1>Irgendeine Versicherung</name1>

               <name2/>

               <address>

                  <street>Strasse 1</street>

                  <postbox>Postfach. 1234</postbox>

                  <zip>8099</zip>

                  <city>Zürich</city>

                  <countrycode>CH</countrycode>

               </address>

               <dateofimport>2010-03-03T18:29:59.783</dateofimport>

            </insurance>

            <basicData>

               <card_id>80756012340000000527</card_id>

               <assured_id>52</assured_id>

               <unique_id>7569999999472</unique_id>

               <familyname>Devon</familyname>

               <givenname>Ann</givenname>

               <birthdate>1987-02-14T00:00:00</birthdate>

               <gender>female</gender>

               <address>

                  <street>Sonnenpark 20b</street>

                  <postbox/>

                  <zip>8051</zip>

                  <city>Zürich</city>

                  <countrycode>CH</countrycode>

               </address>

            </basicData>

            <KVG>

               <basic_insurance>

                  <Code>1</Code>

                  <Text>Deckung OKP gems KVG</Text>

               </basic_insurance>

               <basic_insurance_model>

                  <Code>1</Code>

                  <Text>Standard-Modell gemäss KVG</Text>

               </basic_insurance_model>

               <basic_insurance_description/>

               <basic_insurance_region>ZH</basic_insurance_region>

               <basic_insurance_accident>

                  <Code>0</Code>

                  <Text>Keine Unfalldeckung gemäss KVG</Text>

               </basic_insurance_accident>

               <basic_insurance_data_locked_insured>false

               </basic_insurance_data_locked_insured>

               <basic_insurance_benefit_delay>false</basic_insurance_benefit_delay>

               <basic_insurance_product>

                  <Code>1</Code>

                  <Text>Testprodukt OKP 1</Text>

               </basic_insurance_product>

            </KVG>

            <drugs>

               <drugs_Hors_Liste>

                  <Code>0</Code>

                  <Text>Keine Deckung für Medikamente gemäss Hors Liste</Text>

               </drugs_Hors_Liste>

               <drugs_Hors_Liste_accident>

                  <Code>1</Code>

                  <Text>Unfalldeckung für Medikamente gemäss Hors Liste</Text>

               </drugs_Hors_Liste_accident>

               <drugs_complementary>

                  <Code>0</Code>

                  <Text>Keine Deckung für Medikamente Komplementärmedizin</Text>

               </drugs_complementary>

               <drugs_complementary_accident>

                  <Code>0</Code>

                  <Text>Keine Unfalldeckung für Medikamente Komplementärmedizin</Text>

               </drugs_complementary_accident>

               <drugs_benefit_delay>false</drugs_benefit_delay>

            </drugs>

            <hospital>

               <hospital_unit>

                  <Code>3</Code>

                  <Text>Private Spitalabteilung VVG</Text>

               </hospital_unit>

               <hospital_model>

                  <Code>30</Code>

                  <Text>Einzelzimmer mit freier Arztwahl</Text>

               </hospital_model>

               <hospital_accident>

                  <Code>0</Code>

                  <Text>Keine Unfalldeckung für Spitalversicherung gemäss VVG</Text>

               </hospital_accident>

               <hospital_benefit_delay>false</hospital_benefit_delay>

            </hospital>

            <vvg_product>

               <Code>1</Code>

               <Text>Prod VVG 1</Text>

            </vvg_product>

            <treatment_date>2013-08-13T00:00:00</treatment_date>

         </patient>

         <ZAS>

                      <official_familynames>Devon-Miller</official_familynames>

            <official_givennames>Annemaria</official_givennames >

            <official_birthdate>1987-02-14T00:00:00</official_birthdate>

            <official_gender>female</official_gender>

         </ZAS>

         <canton>

            <isZsrInBlacklistActive>true</isZsrInBlacklistActive>

            <blacklist>

               <canton_name>SH</canton_name>

               <validFrom>2014-01-01T00:00:00</validFrom>

               <validUntil>2014-01-20T00:00:00</validUntil>

            </blacklist >

            <blacklist>

               <canton_name>TI</canton_name>

               <validFrom>2014-01-05T00:00:00</validFrom>

            </blacklist >

         </canton>

      </VeKa_Response>

   </soap:Body>

</soap:Envelope>





1.4 Rückmeldungen (ReturnValue) des Webservice

Im Moment werden folgende Rückmeldungen generiert. Diese Meldungen sind nicht fix und werden bei Bedarf ausgebaut.

Ok = 0

Abfrage konnte korrekt durchgeführt werden

NoMatch = 1

Keine Treffer

ToMuchMatches = 2

Kein eindeutiger Treffer: Bitte verwenden Sie die 20-stellige Versichertenkartennummer um ein eindeutiges Resultat zu erhalten.

NoEnoughInformationForQuery = 4

Die Abfragestruktur wurde nicht korrekt gefüllt (Mussfelder sind leer, Felder nicht korrekt gefüllt)

UserDoesntMatchCertificate = 5

Der User passt nicht zum Zertifikat

UserPasswordNotFound = 6

User/Passwort-Kombination falsch

NoCertificate = 7

Der Zugriff erfolgt ohne gültiges Zertifikat (Wird schon vom Internetserver abgefangen)

UserLocked = 8

Der User ist gesperrt

ZSRNotForProvider = 9

Die Anfragende Zahlstelle wurde für das Zertifikat nicht freigeschaltet

BAGNrLocked = 10

Es konnte ein Treffer gelandet werden, die ZSR oder der Provider hat jedoch keine Freischaltung des Versicherers

NoFurtherRightsForQuery= 11

Es wurde mit den eingestellten Rechten kein Treffer gelandet

WrongCity= 12

Es konnte ein Treffer gelandet werden, der übergebene Ort stimmt jedoch nicht mit dem Ort im VeKa-Center überein

ZSRNotForUser = 13

Die übergebene ZSR-Nummer (Provider) ist nicht für den übergebenen User freigeschaltet

CardNotValid = 14

Die übergebene Kartennummer konnte zwar gefunden werden, jedoch ist die Karte nicht mehr gültig (wg. Neuer Karte, Sperrung, Austritt)

NewCardInInsurance = 15

Die mitgelieferte Kartenummer ist nicht mehr aktiv, es wurde  eine aktive Kartennummer innerhalb des gleichen Versicherers gefundent.

OtherInsurance = 16

Die mitgelieferte Kartenummer ist nicht mehr aktiv, es wurde  eine aktive Kartennummer innerhalb eines anderen Versicherers gefundent.

UnknownError = 999

Unbekannter Fehler, ReturnMessage beachten (Normalerweise ein Programmfehler)




2 Detaillierte Beschreibung der Knoten

2.1 Einleitung

Da jeder Versicherer selbst über seine Daten bestimmt ist es möglich, dass bestimmte Informationen bei bestimmten Leistungserbringern nicht freigeschaltet sind oder dass die Versicherung die Daten nicht liefert. Dies kann dazu führen, dass einzelne Knoten ausgeblendet werden und als Serverrückmeldung eine entsprechende Meldung kommt.

2.2 Allgemeine Datentypen

Expand
titletypeGLN


Beschreibung

Einschränkung

Beinhaltet die eine EAN-Nummer.

String: (20[0-9]{11}|76[0-9]{11})



Expand
titletypeBAG_id


Beschreibung

Einschränkung

Beinhaltet die eine BAG-Nummer.

Integer von 1 bis 9999



Expand
titletypeCard_id


Beschreibung

Einschränkung

Beinhaltet die eine Karten-Nummer.

String, (80756[0-9]{15}|80438[0-9]{15})



Expand
titletypeString2


Beschreibung

Einschränkung

Beinhaltet eine Zeichenkette.

String maximale Länge 2 Zeichen



Expand
titletypeString20


Beschreibung

Einschränkung

Beinhaltet eine Zeichenkette.

String maximale Länge 20 Zeichen



Expand
titletypeString40


Beschreibung

Einschränkung

Beinhaltet eine Zeichenkette.

String maximale Länge 40 Zeichen



Expand
titletypeString100


Beschreibung

Einschränkung

Beinhaltet eine Zeichenkette.

String maximale Länge 100 Zeichen



Expand
titletypeUnique_id (Sozialversicherungsnummer)


Beschreibung

Einschränkung

Beinhaltet eine Sozialversicherungsnummer.

String, (756[0-9]{10})



Expand
titletypeZSR


Beschreibung

Einschränkung

Beinhaltet eine Zahlstellenregister Nummer.

String, ([A-Z][0-9]{6})



Expand
titletypeLanguage


Beschreibung

Einschränkung

Beinhaltet die Abfragesprache.

String(1), (D/F/I)



Expand
titletypeGender


Beschreibung

Einschränkung

Beinhaltet das Geschlecht.

String, Enumeration (male/female)






2. 3 Abfrage beim VeKa (Request)

2.3.1 Abfragestruktur «VeKa Request»

Image Added

Beschreibung

Element

Beschreibung

requestDate

In diesem Tag wird das Abfragedatum des Clients übergeben.

questioners

Siehe Das Element «questioners» (typeQRY_questioners)

biller

Siehe Das Element «biller» (typeQRY_biller)

provider

Siehe Das Element «provider» (typeQRY_provider)

insurance

Siehe Das Element «insurance» (typeQRY_insurance)

patient

Siehe Das Element «patient» (typeQRY_patient)



Expand
title2.3.1.1 Das Element «questioners» (typeQRY_questioners)


Image Added


Element

Beschreibung

questioners

Abfragestelle: Wird vom VeKa-Center vergeben

user

User: Wird vom VeKa-Center vergeben

password

Passwort: Wird vom VeKa-Center vergeben

language

Sprache der Antwort (D, F, I)



Expand
title2.3.1.2 Das Element «biller» (typeQRY_biller)


Image Added


Element

Beschreibung

ean_party

EAN

ZSR

ZSR

invoice_id

RechnungsNr

invoice_date

RechnungsDatum



Expand
title2.3.1.3 Das Element «provider» (typeQRY_provider)


Image Added


Element

Beschreibung

ean_party

EAN

ZSR

ZSR



Expand
title2.3.1.4 Das Element «insurance» (typeQRY_insurance)


Image Added


Element

Beschreibung

ean_party

EAN

BAG_insurance_id

BAGNr

name

Bezeichnung



Expand
title2.3.1.5 Das Element «patient» (typeQRY_patient)


Image Added


Element

Beschreibung

card_id

Kartennummer von VeKa-Center

assured_id

VersichertenNummer

unique_id

Sozialversicherungsnummer

familyname

Hauptname

givenname

Vorname

birthdate

Geburtsdatum

gender

Geschlecht

zip

Postleitzahl des Wohnorts des Patienten

treatment_date

Behandlungsbeginn





2. 4 Rückmeldung beim VeKa (Response)

2.4.1 Abfragestruktur «VeKa Response»

Beschreibung

Element

Beschreibung

returnCode

Siehe Beispiel einer kompletten SOAP Anfrage - Rückgabestruktur

returnMessage

Siehe Beispiel einer kompletten SOAP Anfrage - Rückgabestruktur

requestDate

Datum der Anfrage vom Server

request_ID

Eindeutige Anfragenummer

version

Versionsnummer des Abfragemoduls

biller

Siehe Abfragestruktur «biller» (typeRES_biller)

provider

Siehe Abfragestruktur «provider» (typeRES_provider)

patient

Siehe 

  • Abfragestruktur «patient» (typeRES_patient)
  • Abfragestruktur «patient/basicData» (typeRES_basicData)
  • Abfragestruktur «patient/insurance» (typeRES_insurance)
  • Abfragestruktur «patient/KVG» (typeRES_basic_insurance_KVG)
  • Abfragestruktur «patient/drugs“ (typeRES_drugs)
  • Abfragestruktur «patient/hospital» (typeRES_hospital)
  • Abfragestruktur «patient/vvg_zvs» (typeRES_vvg_zvs)

ZAS

Offizielle Attribute der zurückgelieferten AHV-Nummer. Siehe (typeRES_ZAS)

Einschränkungen:

·         Sollte vertraglich keine Vereinbarung über diese Attribute bestehen so werden sie nicht mit ausgeliefert.

·         Bei Roaming anfragen werden diese Daten nicht gefüllt.

canton

Meldungen des Kantons zu der AHV-Nummer. Siehe (typeRES_canton)

Einschränkungen:

·         Dieser Knoten wird nur ausgeliefert, wenn der Leistungserbringer dem ordentlichen Meldeverfahren von LSP beigetreten ist. Nähere Informationen siehe https://www.lsp-online.ch oder unter http://www.santeservices.ch.



Expand
title2.4.1.1 Abfragestruktur «biller» (typeRES_biller)


Image Added


Element

Beschreibung

ean_party

EAN

ZSR

ZSR

invoice_id

RechnungsNr

invoice_date

RechnungsDatum




Expand
title2.4.1.2 Abfragestruktur «version» (typeRES_version)


Image Added


Element

Beschreibung

version_No

2.0.0.0

version_date

Datum der Version




Expand
title2.4.1.3 Abfragestruktur «provider» (typeRES_provider)


Image Added


Element

Beschreibung

ean_party

EAN

ZSR

ZSR

message

Jeder Versicherer kann jedem Versicherten in der Kombination mit dem Leistungserbringer bzw. dessen Partnerart wie sie im santéservices Zahlstellenregister definiert ist Meldungen bzw. Hinweise zukommen lassen.




Expand
title2.4.1.4 Abfragestruktur «patient» (typeRES_patient)


Image Added


Element

Beschreibung

message_query

Rückmeldung des Servers bei etwaigen Besonderheiten des Tags bei der Versicherung

validFrom

Ab wann gilt die Deckung

validUntil

Bis wann gilt die Deckung

cardValidFrom

Beginndatum, das auf der Versichertenkarte aufgedruckt ist

cardValidUntil

Endedatum, das auf der Versichertenkarte aufgedruckt ist

language

Sprache des Versicherten (D, F, I, E, R)

insurance

Versicherung: Siehe (typeRES_insurance)

basicData

Basisdaten: Siehe (typeRES_basicData)

KVG

Grundversicherung KVG: Siehe (typeRES_basic_insurance_KVG)

drugs

Medikamente: Siehe (typeRES_drugs)

hospital

Spitalzusatzversicherung: Siehe (typeRES_hospital)

vvg_zvs

Zusatzversicherung VVG mit Spezialversicherungen: Siehe (typeRES_vvg_zvs)

vvg_product

Alle VVG-Produkte, die der Versicherte bei der Versicherung hat.

treatment_date

Datum der Behandlung




Expand
title2.4.1.5 Abfragestruktur «patient/basicData» (typeRES_basicData)


Image Added


Element

Beschreibung

message_query

Rückmeldung des Servers bei etwaigen Besonderheiten des Tags bei der Versicherung

card_id

Kartennummer

assured_id

VersichertenNummer

unique_id

SozialversicherungsNummer

familyname

Hauptname

givenname

Vorname

birthdate

Geburtsdatum

gender

Geschlecht

Address

Wohnadresse des Patienten, siehe (typeRES_Address)

official_familynames (bis 31.12.2015)

Offizielle(r) Familienname(n) gemäss ZAS

official_givennames (bis 31.12.2015)

Offizielle(r) Vorname(n) gemäss ZAS

official_birthdate (bis 31.12.2015)

Offizielles Geburtsdatum gemäss ZAS

official_gender (bis 31.12.2015)

Offizielles Geschlecht, siehe (typeGender)




Expand
title2.4.1.6 Abfragestruktur «patient/insurance» (typeRES_insurance)


Image Added


Element

Beschreibung

ean_party

EAN-Nummer der Versicherung

BAG_insurance_id

Zulassungsnummer der Versicherung beim Bundesamt für Gesundheit

name

Name der Versicherung

description

Kontaktstelle: Bezeichnung

phone

Kontaktstelle: Telefonnummer

e_mail

Kontaktstelle: E-Mail Adresse

name1

Kontaktstelle: Name 1

name2

Kontaktstelle: Name 2

address

Kontaktstelle: Adresse der Kontaktstelle. Siehe (typeRES_Address)

dateofimport

Datum des letzten Imports der Versicherung




Expand
title2.4.1.7 Abfragestruktur «patient/KVG» (typeRES_basic_insurance_KVG)


Image Added


Element

Beschreibung

message_query

Rückmeldung des Servers bei etwaigen Besonderheiten des Tags bei der Versicherung

basic_insurance

Basisversicherung: siehe (Basisversicherung GV)

basic_insurance_model

Modell Grundversicherung: siehe (Modell Grundversicherung GV-Modell)

basic_insurance_description

Beschreibung Grundversicherung

basic_insurance_region

Wohnkanton des Patienten, siehe (Wohnkanton KANTON)

basic_insurance_accident

Unfall Grundversicherung: siehe (Unfalldeckung Grundversicherung GV-Unfall)

basic_insurance_data_locked_insured

Der Versicherte hat die Daten für die Online-Abfrage gesperrt

basic_insurance_remark

Bemerkungen Grundversicherung

basic_insurance_benefit_delay

Tiers garant (ja oder nein)

basic_insurance_product

KVG-Produkte, die der Versicherte bei der Versicherung hat. Siehe (Produkte Versicherer GV-Prod)




Expand
title2.4.1.8 Abfragestruktur «patient/drugs“ (typeRES_drugs)


Image Added


Element

Beschreibung

message_query

Rückmeldung des Servers bei etwaigen Besonderheiten des Tags bei der Versicherung

drugs_Hors_Liste

Medikamente Hors Liste: siehe (Medikamente Hors Liste Medi-HL)

drugs_Hors_Liste_accident

Medikamente Hors Liste Unfall: siehe (Unfalldeckung Hors Liste Medi-HL-Unfall)

drugs_complementary

Medikamente Komplementär: siehe (Medikamente Komplementärmedizin Medi-KM)

drugs_complementary_accident

Medikamente Komplementär Unfall: siehe (Unfalldeckung Medi-KM-Unfall)

drugs_remark

Bemerkung Medikamente

drugs_benefit_delay

Deckungsunterbruch




Expand
title2.4.1.9 Abfragestruktur «patient/hospital» (typeRES_hospital)


Image Added


Element

Beschreibung

message_query

Rückmeldung des Servers bei etwaigen Besonderheiten des Tags bei der Versicherung

hospital_unit

Spitalabteilung: siehe (Spitalabteilung VVG ABT)

hospital_model

Spitalmodell: siehe (Spitalabteilungsmodell Zusatzversicherung ZV-modell)

hospital_accident

Spital Unfallversicherung: siehe (Unfalldeckung Zusatzvers. Spitalabteilung ZV-Unfall)

hospital_akutsomatik

Vergütung/Sperrung besonderer akutsomatischer Leistungen siehe (Einschränkung Spitaldeckung ZV-Akut)

hospital_psychiatry

Vergütung/Sperrung besonderer psychiatrische Leistungen  siehe (Einschränkung Spitaldeckung ZV-Psych)

hospital_list

Spitallisten-Modell: Listentyps siehe (Einschränkung Spitaldeckung ZV-Liste)

hospital_remark

Bemerkung Spital

hospital_benefit_delay

Deckungsunterbruch




Expand
title2.4.1.10 Abfragestruktur «patient/vvg_zvs» (typeRES_vvg_zvs)


Image Added


 

Element

Beschreibung

ambulant_private

message_query

Rückmeldung des Servers bei etwaigen Besonderheiten des Tags bei der Versicherung

ambulant_private

Ambulant Privat

ambulant_private_accident

Unfalldeckung Ambulant Privat

ambulant_private_accident_add1

Ambulant Privat-Zusatzfeld 1 (Sperre Online)

ambulant_private_accident_add2

Ambulant Privat-Zusatzfeld 2

ambulant_private_accident_add3

Ambulant Privat-Zusatzfeld 3

ambulant_private_accident_add4

Ambulant Privat-Zusatzfeld 4

ambulant_private_remark1

Bemerkung 1 Ambulant Privat

ambulant_private_remark2

Bemerkung 2 Ambulant Privat

therapy_alternative

therapy_alternative

Therapien Alternativ

accident_therapy_alternative

Unfalldeckung Therapien Alternativ

accident_therapy_alternative_add1

Therapien Alternativ-Zusatzfeld 1 (Sperre Online)

accident_therapy_alternative_add2

Therapien Alternativ-Zusatzfeld 2

accident_therapy_alternative_add3

Therapien Alternativ-Zusatzfeld 3

accident_therapy_alternative_add4

Therapien Alternativ-Zusatzfeld 4

therapy_alternative_remark1

Bemerkung 1 Therapien Alternativ

therapy_alternative_remark2

Bemerkung 2 Therapien Alternativ

EUP

hospital_unit_eup

Spitalabteilung Spezialversich. EUP

hospital_model_eup

Spital-Modell Spezialversich. EUP

insurance_accident_eup

Unfalldeckung Spitalversich. Spezial_EUP

hospital_special_add1_eup

Spital-Zusatzfeld 1 Spezial_EUP

hospital_special_add2_eup

Spital-Zusatzfeld 2 Spezial_EUP

hospital_special_add3_eup

Spital-Zusatzfeld 3 Spezial_EUP

hospital_special_add4_eup

Zusatzfeld 4 (Sperre Online) EUP

remark1_eup

Bemerkung 1 Spitalversich. Spezial_EUP

remark2_eup

Bemerkung 2 Spitalversich. Spezial_EUP

KLV

basic_insurance_amb_klv

Basisversicherung ambulant nach KLV aus VVG

basic_insurance_stat_klv

Basisversicherung stationär nach KLV aus VVG

name_basic_insurance_klv

Bezeichnung Basisversicherung nach KLV aus VVG

basic_insurance_accident_klv

Unfalldeckung Basisversicherung KLV aus VVG

basic_insurance_klv_add1

Basisversicherung nach KLV Zusatzfeld 1 Spezial

basic_insurance_klv_add2

Basisversicherung nach KLV Zusatzfeld 2 Spezial

basic_insurance_klv_add3

Basisversicherung nach KLV Zusatzfeld 3 Spezial

basic_insurance_klv_add4

Basisvers. nach KLV Zusatzfeld 4 (Sperre Online)

basic_insurance_klv_remark1

Bemerkung 1 Basisversicherung nach KLV

basic_insurance_klv_remark2

Bemerkung 2 Basisversicherung nach KLV

drugs_preventiondrugs_hors_liste_prevention

Medikamente Hors Liste (HL) Prävention

drugs_complementary_prevention

Medikamente Komplementärmedizin (KM) Prävention

Gatekeeper

ZSR

ZSR-Nummer des Gatekeepers

name1

Nachname des Gatekeepers

name2

Vorname des Gatekeepers

Free_text

Free_text4

Freier Text 04

Free_text5

Freier Text 05

Free_text6

Freier Text 06

Free_text7

Freier Text 07

Free_text8

Freier Text 08

Free_text9

Freier Text 09

Free_text10

Freier Text 10




Expand
title2.4.1.11 Abfragestruktur «typeRES_Address»


Image Added


Element

Beschreibung

street

Strasse

postbox

Adresszusatz

zip

Postleitzahl

city

Ort

countrycode

Land




Expand
title2.4.1.12 Abfragestruktur «typeRES_masterdata»


Image Added


Element

Beschreibung

Code

StammID der Daten

Text

Stammdatenwert in der übergebenen Sprache (typeQRY_questioners)




Expand
title2.4.1.13 Abfragestruktur «typeRES_canton»


Image Added


Element

Beschreibung

isZsrInBlackListActive

Flag das anzeigt, ob die ZSR Nummer in der blacklist erwähnt wird

blacklist

Ist ein Liste vom type typeRES_blacklist




Expand
title2.4.1.14 Abfragestruktur «typeRES_blacklist»


Image Added


Element

Beschreibung

canton_name

Kantone, 2 stelliges offizielles Kürzel, siehe (Wohnkanton)

remark

Bemerkung des Kantons

valid_from

Ab wann ist die AHV-Nummer auf der schwarzen Liste

valid_until

Wenn leer dann ist die AHV Nummer aktuell auf der Liste




Expand
title2.4.1.15 Abfragestruktur «typeRES_ZAS»


Image Added


Element

Beschreibung

official_familynames

Offizielle(r) Familienname(n) gemäss ZAS

official_givennames

Offizielle(r) Vorname(n) gemäss ZAS

official_birthdate

Offizielles Geburtsdatum gemäss ZAS

official_gender

Offizielles Geschlecht (Inhalt siehe typeGender)





2. 5 Stammdaten

2.5.1 Basisversicherung (GV)

Expand
titleZulässige Werte für die Basisversicherung KVG:


ID

Bezeichnung Basisversicherung KVG

00

Keine Deckung OKP gemäss KVG

01

Deckung OKP gemäss KVG

Abschliessende Definition


2.5.2 Modell Grundversicherung (GV-MODELL)

Expand
titleZulässige Werte das Grundversicherungs-Modell KVG:


ID

Bezeichnung Modell Grundversicherung KVG

00

Keine Grundversicherung

01

Standard-Modell gemäss KVG

02

Hausarzt-Modell gemäss KVG

03

HMO-Modell gemäss KVG

04

Listen-Modell gemäss KVG

05

Telefonmodell gemäss KVG

06

Apotheken-Modell

99

Spezialmodell gemäss KVG (genauere Bezeichnung ins Bemerkungsfeld)

Abschliessende Definition


2.5.3 Wohnkanton (KANTON)

Expand
titleZulässige Werte für den Wohnkanton (Prämienkanton) des Versicherten:


ID

Bezeichnung Wohnkanton für KVG-Deckung

00

Keine Grundversicherung

AG

Aargau

AI

Appenzell Innerrhoden

AR

Appenzell Ausserrhoden

BE

Bern

BL

Basel-Landschaft

BS

Basel-Stadt

FR

Freiburg

GE

Genf

GL

Glarus

GR

Graubünden

JU

Jura

LU

Luzern

NE

Neuenburg

NW

Nidwalden

OW

Obwalden

SG

St. Gallen

SH

Schaffhausen

SO

Solothurn

SZ

Schwyz

TG

Thurgau

TI

Tessin

UR

Uri

VD

Waadt

VS

Wallis

ZG

Zug

ZH

Zürich

99

Ausland

FL

Fürstentum Liechtenstein

Abschliessende Definition gemäss Autokennzeichen, ohne FL


2.5.4 Unfalldeckung Grundversicherung (GV-UNFALL)

Expand
titleZulässige Werte für die KVG-Unfalldeckung:


ID

Bezeichnung Unfalldeckung Grundversicherung

00

Keine Unfalldeckung gemäss KVG

01

Unfalldeckung gemäss KVG

Abschliessende Definition


2.5.5 Medikamente Hors Liste (MEDI-HL)

Expand
titleZulässige Werte für die VVG-Medikamente HL:


ID

Bezeichnung Hors Liste (HL)

00

Keine Deckung für Medikamente gemäss Hors Liste

01

Deckung für Medikamente gemäss Hors Liste

02

Eingeschränkte Deckung für Medikamente gemäss Hors Liste

Abschliessende Definition


2.5.6 Unfalldeckung Hors Liste (MEDI-HL_UNFALL)

Expand
titleZulässige Werte für die Unfalldeckung für VVG-Medikamente:


ID

Bezeichnung Unfalldeckung für Hors Liste (HL)

00

Keine Unfalldeckung für Medikamente gemäss Hors Liste

01

Unfalldeckung für Medikamente gemäss Hors Liste

Abschliessende Definition


2.5.7 Medikamente Komplemetärmedizin (MEDI-KM)

Expand
titleZulässige Werte für die VVG-Medikamente KM:


ID

Bezeichnung Komplementärmedizin (KM)

00

Keine Deckung für Medikamente Komplementärmedizin

01

Deckung für Medikamente Komplementärmedizin

02

Eingeschränkte Deckung für Medikamente Komplementärmedizin

Abschliessende Definition


2.5.8 Unfalldeckung KM (MEDI-KM-UNFALL)

Expand
titleZulässige Werte für die VVG-Medikamente Komplementärmedizin:


ID

Bezeichnung Unfalldeckung Komplementärmedizin (KM)

00

Keine Unfalldeckung für Medikamente Komplementärmedizin

02

Eingeschränkte Unfalldeckung für Medikamente Komplementärmedizin

01

Unfalldeckung für Medikamente Komplementärmedizin

Abschliessende Definition


2.5.9 Spitalabteilung VVG (ABT)

Expand
titleZulässige Werte für VVG-Spitaldeckung:


ID

Bezeichnung VVG-Spitalabteilung

00

Keine VVG-Spitalabteilung

01

Allgemeine Spitalabteilung ganze Schweiz

02

Halbprivate Spitalabteilung VVG

03

Private Spitalabteilung VVG

04

Summenversicherung VVG

05

Privat-Abteilung Weltweit VVG

06

Privat-Abteilung Europa VVG

Abschliessende Definition


2.5.10 Spitalabteilungsmodell Zusatzversicherung (ZV-MODELL)

Expand
titleZulässige Werte spezielle Modell zur Spitalabteilung:


ID

Bezeichnung für VVG-Spitalmodell (Komfort und Arztwahl)

10

Mehrbettzimmer ohne freier Arztwahl (ABT=01)

20

Zweierzimmer mit freier Arztwahl (ABT=02, 01)

30

Einerzimmer mit freie Arztwahl (ABT=03, 02, 01)

40

Wahl der Spitalabteilung bei Eintritt (ABT=01, 04)

50

Zweierzimmer ohne freie Arztwahl (ABT=01)

60

Einerzimmer ohne freie Arztwahl (ABT=01)

70

Mehrbettzimmer mit freier Arztwahl (ABT=01, 04)

00

Keine VVG-Spitaldeckung (ABT=00)

Abschliessende Definition


2.5.11 Unfalldeckung Zusatzvers. Spitalabteilung (ZV-UNFALL)

Expand
titleZulässige Werte für Unfalldeckung der Spitalversicherung:


ID

Bezeichnung Unfalldeckung Spitalversicherung

00

Keine Unfalldeckung für Spitalversicherung gemäss VVG

01

Unfalldeckung für Spitalversicherung gemäss VVG

Abschliessende Definition


2.5.12 Einschränkung Spitaldeckung (ZV-AKUT)

Expand
titleZulässige Werte für Zusatzfelder der stationären Spitalversicherung zur Abbildung von allgemei-nen Beschränkungen gemäss ZVB, AVG oder ZB:


ID

Bezeichnung Einschränkungen Akutsomatik (ohne persönliche Vorbehalte)

01

Keine Einschränkung Akutsomatik VVG

02

Mit Einschränkung Akutsomatik VVG (z.B. Mutterschaft)

00

Keine Deckung  Akutsomatik VVG

Abschliessende Definition


2.5.13 Einschränkung Spitaldeckung (ZV-PSYCH)

Expand
titleZulässige Werte für Zusatzfelder der stationären Spitalversicherung zur Abbildung von allgemei-nen Beschränkungen gemäss ZVB, AVG oder ZB:


ID

Bezeichnung Einschränkungen Psychiatrie (ohne persönliche Vorbehalte)

01

Keine Einschränkung Psychiatrie VVG

02

Mit Einschränkung Psychiatrie VVG (Limitierte Beträge und Dauer)

00

Keine Deckung  Psychiatrie VVG

Abschliessende Definition


2.5.14 Einschränkung Spitaldeckung (ZV-LISTE)

Expand
titleZulässige Werte für Zusatzfelder der stationären Spitalversicherung zur Abbildung von allgemei-nen Beschränkungen gemäss ZVB, AVG oder ZB:


ID

Bezeichnung Einschränkungen Spitalliste (ohne persönliche Vorbehalte)

01

Keine Einschränkung durch Spitalliste VVG (ganze CH, öffentliche/private Spitäler

02

Mit Einschränkung durch Spitalliste VVG (Spitalliste Versicherer)

00

Keine Deckung Spitalliste VVG

Abschliessende Definition


2.5.15 Produkte Versicherer GV (GV-PROD)

Expand
titleProdukte Grundversicherung des Versicherers (GV-PROD)


ID

Bezeichnung Produkt Grundversicherung

01

Produkt X

02

Produkt Y


2.5.16 Produkte Versicherer ZV (ZV-PROD)

Expand
titleProdukte Zusatzversicherung des Versicherers (ZV-PROD)


ID

Bezeichnung Produkt Zusatzversicherung

01

Produkt X

02

Produkt Y



Sv translation
languageen

Table of Contents


1 Insurance card query web service

1.1 Foreword

The insurance card centre offers a query module as a web service containing data from insurers that have given their consent to be included.

The contractual terms and conditions can be found in the licence agreement and the guidelines. The main purpose of this document is to provide a technical overview of the web service.

The web service operates with a single query method. The input parameters comprise XML-coded fields defined in the agreement. The query method returns the response fields (return values) defined in the agreement. Technical descriptions can be found in the appendix to the agreement. The actual data exchange happens in the SOAP body, where data are sent to the insurance card centre and returned in the response structure. In some cases, the request values are copied and supplemented with values from the insurance card centre.

Access to the web server is protected using SSL. The server asks for a client certificate. If no certificate is sent with the request, the query cannot be carried out.

The web service also asks for a user ID and password. The request is only processed if the subject of the certificate matches the user and the user ID and password are correct.
The web service is described in WSDL:

The correct connection parameters and certificate are sent to you separately.

With regard to implementation, it must be borne in mind that no abbreviations are accepted for the namespaces in the body. If abbreviations are used, the web service cannot process the input parameters, so error messages are returned stating that not all parameters have been filled in.

In version 1.2, the field basic_insurance_military_delay (military insurance) was removed because the insurers deemed it unnecessary. 
In addition, the master data tables in section 2.5 as well as section 2.2 and the error messages were expanded 
to include return codes 15 and 16.

A new feature in version 1.3 is that official details from the Central Compensation Office (CCO) are returned, namely the first and last names, date of birth and gender.

The CCO attributes have been placed in their own node as the CCO is the data source, not the insurance card centre. In order to maintain parallel operation, the attributes are still delivered in the same place as before up to 31 December 2015.

A new feature in version 2.0 is the cantonal blacklist. The data source here is the respective canton. The list is only displayed if the service provider making the query is registered with SASIS AG’s list of defaulting premium payers (LSP).

For more information, please see https://www.lsp-online.ch.

The blacklist is always queried in up-to-date  form. No history is kept.

In version 2.1, additional fields for the expanded cover record are included and described in section typeRES_patient.

1.1.1 Protection Mechanisms / WAF

Access to the web service is protected by Web Application Firewall (WAF) security mechanisms.

In some cases, an HTTP status 400 (Bad Request) may be caused by the request being rejected by these security mechanisms.

When integrating the web service, please ensure that no additional HTTP headers are sent that are not required by the web service. Certain headers may be classified as potentially malicious by the security mechanisms.

If a request is rejected with HTTP 400, santéservices ag can use the RequestID to check whether the request was blocked by a security mechanism and why. Please provide the RequestID when contacting santéservices ag regarding such an issue.

1.2 Endpoint

The insurance card web service endpoint is as follows:
https://www.versichertenkarte.ch/queryws_1_0/VeKa_Query_1_0.asmx 



1.3 Graphical representation


1.3.1 Request

1.3.2 Response structure



Expand
titleDetail

Image Added



Expand
titleOverview

Image Added


Expand
titleDetail VeKa Response/Patient

Image Added

Image Added



→ Master data are available for the blue cross (see image below):


    Image Added

1.3.3 Example of a complete SOAP request

Request structure

Response structure


Expand
titleZum Ausklappen hier klicken...

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:veka="http://www.vekacenter.ch/veka_query/">

                <soap:Header/>

                <soap:Body>

                <veka:VeKa_Request>


                <veka:requestDate>2013-08-13T00:00:00</veka:requestDate>

                   <veka:questioners>

                                <veka:questioners>Abfragedienst-Name</veka:questioners>

                                <veka:user>User-Name</veka:user>

                                <veka:password>********</veka:password>

                                <veka:language>D</veka:language>

                   </veka:questioners>


                <veka:provider>

                                <veka:ZSR>T000001</veka:ZSR>

                </veka:provider>


                <veka:insurance/>   


                <veka:patient>

                                <veka:card_id>80756012340000000527</veka:card_id>


                <!--Behandlungsdatum (Schadensdatum):-->

                                <veka:treatment_date>2013-08-13</veka:treatment_date>


                </veka:patient>

                </veka:VeKa_Request>

  </soap:Body>

</soap:Envelope>



Expand
titleZum Ausklappen hier klicken...

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   <soap:Body>

      <VeKa_Response xmlns="http://www.vekacenter.ch/veka_query/">

         <returnCode>0</returnCode>

         <returnMessage/>

         <requestDate>2013-08-13T17:19:48.5267901+02:00</requestDate>

         <request_ID>109783678</request_ID>

         <version>

            <version_no>1.3.0.2</version_no>

            <version_date>2013-03-26T18:15:00+01:00</version_date>

         </version>

         <biller/>

         <provider>

            <ZSR>T000001</ZSR>

         </provider>

         <patient>

            <validFrom>2009-01-01T00:00:00</validFrom>

            <validUntil>2014-06-30T00:00:00</validUntil>

            <cardValidFrom>2009-01-01T00:00:00</cardValidFrom>

            <cardValidUntil>2014-06-30T00:00:00</cardValidUntil>

            <language>D</language>

            <insurance>

               <ean_party>7600000000000</ean_party>

               <BAG_insurance_id>1234</BAG_insurance_id>

               <name>sanacur (Testversicherer)</name>

               <description>Servicecenter</description>

               <phone>012 345 67 89</phone>

               <e_mail>info@sanacur.ch</e_mail>

               <name1>Irgendeine Versicherung</name1>

               <name2/>

               <address>

                  <street>Strasse 1</street>

                  <postbox>Postfach. 1234</postbox>

                  <zip>8099</zip>

                  <city>Zürich</city>

                  <countrycode>CH</countrycode>

               </address>

               <dateofimport>2010-03-03T18:29:59.783</dateofimport>

            </insurance>

            <basicData>

               <card_id>80756012340000000527</card_id>

               <assured_id>52</assured_id>

               <unique_id>7569999999472</unique_id>

               <familyname>Devon</familyname>

               <givenname>Ann</givenname>

               <birthdate>1987-02-14T00:00:00</birthdate>

               <gender>female</gender>

               <address>

                  <street>Sonnenpark 20b</street>

                  <postbox/>

                  <zip>8051</zip>

                  <city>Zürich</city>

                  <countrycode>CH</countrycode>

               </address>

            </basicData>

            <KVG>

               <basic_insurance>

                  <Code>1</Code>

                  <Text>Deckung OKP gems KVG</Text>

               </basic_insurance>

               <basic_insurance_model>

                  <Code>1</Code>

                  <Text>Standard-Modell gemäss KVG</Text>

               </basic_insurance_model>

               <basic_insurance_description/>

               <basic_insurance_region>ZH</basic_insurance_region>

               <basic_insurance_accident>

                  <Code>0</Code>

                  <Text>Keine Unfalldeckung gemäss KVG</Text>

               </basic_insurance_accident>

               <basic_insurance_data_locked_insured>false

               </basic_insurance_data_locked_insured>

               <basic_insurance_benefit_delay>false</basic_insurance_benefit_delay>

               <basic_insurance_product>

                  <Code>1</Code>

                  <Text>Testprodukt OKP 1</Text>

               </basic_insurance_product>

            </KVG>

            <drugs>

               <drugs_Hors_Liste>

                  <Code>0</Code>

                  <Text>Keine Deckung für Medikamente gemäss Hors Liste</Text>

               </drugs_Hors_Liste>

               <drugs_Hors_Liste_accident>

                  <Code>1</Code>

                  <Text>Unfalldeckung für Medikamente gemäss Hors Liste</Text>

               </drugs_Hors_Liste_accident>

               <drugs_complementary>

                  <Code>0</Code>

                  <Text>Keine Deckung für Medikamente Komplementärmedizin</Text>

               </drugs_complementary>

               <drugs_complementary_accident>

                  <Code>0</Code>

                  <Text>Keine Unfalldeckung für Medikamente Komplementärmedizin</Text>

               </drugs_complementary_accident>

               <drugs_benefit_delay>false</drugs_benefit_delay>

            </drugs>

            <hospital>

               <hospital_unit>

                  <Code>3</Code>

                  <Text>Private Spitalabteilung VVG</Text>

               </hospital_unit>

               <hospital_model>

                  <Code>30</Code>

                  <Text>Einzelzimmer mit freier Arztwahl</Text>

               </hospital_model>

               <hospital_accident>

                  <Code>0</Code>

                  <Text>Keine Unfalldeckung für Spitalversicherung gemäss VVG</Text>

               </hospital_accident>

               <hospital_benefit_delay>false</hospital_benefit_delay>

            </hospital>

            <vvg_product>

               <Code>1</Code>

               <Text>Prod VVG 1</Text>

            </vvg_product>

            <treatment_date>2013-08-13T00:00:00</treatment_date>

         </patient>

         <ZAS>

                      <official_familynames>Devon-Miller</official_familynames>

            <official_givennames>Annemaria</official_givennames >

            <official_birthdate>1987-02-14T00:00:00</official_birthdate>

            <official_gender>female</official_gender>

         </ZAS>

         <canton>

            <isZsrInBlacklistActive>true</isZsrInBlacklistActive>

            <blacklist>

               <canton_name>SH</canton_name>

               <validFrom>2014-01-01T00:00:00</validFrom>

               <validUntil>2014-01-20T00:00:00</validUntil>

            </blacklist >

            <blacklist>

               <canton_name>TI</canton_name>

               <validFrom>2014-01-05T00:00:00</validFrom>

            </blacklist >

         </canton>

      </VeKa_Response>

   </soap:Body>

</soap:Envelope>





1.4 Web service responses (return values)

All responses that are currently generated are listed below. This list is not fixed; new responses will be added as necessary.

Ok = 0

The query was executed successfully.

NoMatch = 1

No matches

ToMuchMatches = 2

No unique match: please use the 20-digit insurance card number to find a unique match.

NoEnoughInformationForQuery = 4

The request structure has not been filled in correctly (mandatory fields left empty, fields not filled in correctly).

UserDoesntMatchCertificate = 5

The user and certificate do not match.

UserPasswordNotFound = 6

The user ID and password are not correct.

NoCertificate = 7

Login without valid certificate (intercepted by web server)

UserLocked = 8

The user is blocked.

ZSRNotForProvider = 9

The requesting paying agent does not have permission for the certificate.

BAGNrLocked = 10

A match was found, but the ZSR or provider does not have permission from the insurer.

NoFurtherRightsForQuery= 11

No match was found with the current rights.

WrongCity= 12

A match was found, but the town/city entered does not match the one recorded by the insurance card centre.

ZSRNotForUser = 13

The user does not have permission for the requested ZSR number (provider).

CardNotValid = 14

The requested card number was found, but the card is no longer valid (new card issued, card blocked or insurance cancelled).

NewCardInInsurance = 15

The requested card number is no longer active, but an active card number with the same insurer was found.

OtherInsurance = 16

The requested card number is no longer active, but an active card number with another insurer was found.

UnknownError = 999

Unknown error, please see return message (usually a program error)




2 Detailed description of nodes

2.1 Introduction

Since each insurer is responsible for its own data, it is possible that certain information may not be available to certain service providers or may not be supplied by the insurer. Where this is the case, the corresponding nodes are hidden, and this is reflected in the response from the server.

2.2 General data types

Expand
titletypeGLN


Description

Restriction

Contains EAN-number.

String: (20[0-9]{11}|76[0-9]{11})



Expand
titletypeBAG_id


Description

Restriction

Contains FOPH-number.

Integer von 1 bis 9999



Expand
titletypeCard_id


Description

Restriction

Contains card-number.

String, (80756[0-9]{15}|80438[0-9]{15})



Expand
titletypeString2


Description

Restriction

Contains a character string.

String max. length 2 characters



Expand
titletypeString20


Description

Restriction

Contains a character string.

String max. length 20 characters



Expand
titletypeString40


Description

Restriction

Contains a character string.

String max. length 40 characters



Expand
titletypeString100


Description

Restriction

Contains a character string.

String max. length 100 characters



Expand
titletypeUnique_id (Sozialversicherungsnummer)


Description

Restriction

Contains a social security number.

String, (756[0-9]{10})



Expand
titletypeZSR


Description

Restriction

Contains a paying agent register number.

String, ([A-Z][0-9]{6})



Expand
titletypeLanguage


Description

Restriction

Contains the query language.

String(1), (D/F/I)



Expand
titletypeGender


Description

Restriction

Contains the gender.

String, Enumeration (male/female)






2. 3 request of insurance card

2.3.1 Insurance card request structure

Image Added

Description

Element

Description

requestDate

In this tag the request date is hand over to the client.

questioners

See element «questioners» (typeQRY_questioners)

biller

See element «biller» (typeQRY_biller)

provider

See element «provider» (typeQRY_provider)

insurance

See element «insurance» (typeQRY_insurance)

patient

See element «patient» (typeQRY_patient)



Expand
title2.3.1.1 The element «questioners» (typeQRY_questioners)


Image Added


Element

Description

questioners

Request submitted by: provided by insurance card entre

user

User: provided by insurance card centre

password

Password: provided by insurance card centre

language

Response language (D for German, F for French, I for Italian)



Expand
title2.3.1.2 The element «biller» (typeQRY_biller)


Image Added


Element

Description

ean_party

EAN

ZSR

ZSR

invoice_id

Invoice number

invoice_date

Invoice date



Expand
title2.3.1.3 The element «provider» (typeQRY_provider)


Image Added


Element

Description

ean_party

EAN

ZSR

ZSR



Expand
title2.3.1.4 The element «insurance» (typeQRY_insurance)


Image Added


Element

Description

ean_party

EAN

BAG_insurance_id

FOPH number

name

Name



Expand
title2.3.1.5 The element «patient» (typeQRY_patient)


Image Added


Element

Description

card_id

Card number from insurance card centre

assured_id

Insurance number

unique_id

Social security number

familyname

Last name

givenname

First name

birthdate

Date of birth

gender

Gender

zip

Postcode of patient’s place of residence

treatment_date

Date treatment started





2. 4 Response of insurance card

2.4.1 Insurance card response structure

Element

Description

returnCode

See “Example of a complete SOAP request – Response structure”

returnMessage

See “Example of a complete SOAP request – Response structure”

requestDate

Date of server request

request_ID

Unique request number

version

Query module version

biller

See “biller” request structure (typeRES_biller)

provider

See “provider” request structure (typeRES_provider) 

patient

See 

  • “patient” request structure (typeRES_patient)
  • “patient/basicData” request structure (typeRES_basicData)
  • “patient/insurance” request structure (typeRES_insurance)
  • “patient/KVG” request structure (typeRES_basic_insurance_KVG)
  • “patient/drugs” request structure (typeRES_drugs)
  • “patient/hospital” request structure (typeRES_hospital)
  • “patient/vvg_zvs” request structure (typeRES_vvg_zvs)

ZAS

Official attributes of the returned OASI number See (typeRES_ZAS)

Restrictions:

  • These attributes are not returned if they are not covered by a contractual agreement.

These data are not provided for roaming requests.

canton


Reports from the canton on the requested OASI number; see (typeRES_canton)

Restrictions:

  • This node is only returned if the service provider has signed up to the LSP reporting process.

Further information is provided under https://www.lsp-online.ch or https://www.sasis.ch.


Expand
title2.4.1.1 Request structure «biller» (typeRES_biller)


Image Added


Element

Description

ean_party

EAN

ZSR

ZSR

invoice_id

Invoice number

invoice_date

Invoice date




Expand
title2.4.1.2 Request structure «version» (typeRES_version)


Image Added


Element

Description

version_No

2.0.0.0

version_date

Date of the version




Expand
title2.4.1.3 Request structure «provider» (typeRES_provider)


Image Added


Element

Description

ean_party

EAN

ZSR

ZSR

message

Each insurer can provide any insured person with reports or information in combination with the service provider or its partner type as defined in the SASIS paying agent register.




Expand
title2.4.1.4 Request structure «patient» (typeRES_patient)


Image Added


Element

Description

message_query

Server response for special situations concerning insurance on date in question

validFrom

Date from which cover applies

validUntil

Date until which cover applies

cardValidFrom

Start date printed on insurance card

cardValidUntil

End date printed on insurance card

language

Insured person’s language (D for German, F for French, I for Italian, E for English, R for Romansh)

insurance

Insurance: see (typeRES_insurance)

basicData

Master data: see (typeRES_basicData)

KVG

Basic insurance under Health Insurance Act (HIA): see (typeRES_basic_insurance_KVG)

drugs

Medicines: see (typeRES_drugs)

hospital

Supplementary hospital cover: see (typeRES_hospital)

vvg_zvs

Supplementary insurance under Insurance Contract Act (ICA) with special insurer: see (typeRES_vvg_zvs)

vvg_product

All ICA products insured person has with insurer

treatment_date

Treatment date




Expand
title2.4.1.5 Request structure «patient/basicData» (typeRES_basicData)


Image Added


Element

Description

message_query

Server response for special situations concerning insurance on date in question

card_id

Card number

assured_id

Insurance number

unique_id

Social security number

familyname

Last name

givenname

First name

birthdate

Date of birth

gender

Gender

Address

Patient's home address: see (typeRES_Address)

official_familynames (up to 31/12/2015)

Official last name(s) according to CCO

official_givennames (up to 31/12/2015)

Official first name(s) according to CCO

official_birthdate (up to 31/12/2015)

Official date of birth according to CCO

official_gender (up to 31/12/2015)

Official gender see (typeGender)




Expand
title2.4.1.6 Request structure «patient/insurance» (typeRES_insurance)


Image Added


Element

Description

ean_party

Insurer’s EAN

BAG_insurance_id

Insurer’s Federal Office of Public Health (FOPH) licence number

name

Insurer’s name

description

Contact: title

phone

Contact: phone number

e_mail

Contact: e-mail address

name1

Contact: name 1

name2

Contact: name 2

address

Contact: address: see (typeRES_Address)

dateofimport

Date of last import from insurer




Expand
title2.4.1.7 Request structure «patient/KVG» (typeRES_basic_insurance_KVG)


Image Added


Element

Description

message_query

Server response for special situations concerning insurance on date in question

basic_insurance

Basic insurance: see (Basic Insurance GV)

basic_insurance_model

Basic insurance model: see (Basic insurance model GV-modell)

basic_insurance_description

Description of basic insurance

basic_insurance_region

Patient's home canton: see (canton of residence)

basic_insurance_accident

Basic insurance accident cover: see (Basic insurance accident cover GV-Unfall)

basic_insurance_data_locked_insured

The insured person has blocked the data for online queries.

basic_insurance_remark

Remarks on basic insurance

basic_insurance_benefit_delay

Tiers garant (yes/no)

basic_insurance_product

HIA products insured person has with insurer: see (Basic insurer's products GV-Prod)




Expand
title2.4.1.8 Request structure «patient/drugs“ (typeRES_drugs)


Image Added


Element

Description

message_query

Server response for special situations concerning insurance on date in question

drugs_Hors_Liste

Unlisted medicines: see (unlisted medicines Medi-HL)

drugs_Hors_Liste_accident

Unlisted medicines accident: see (unlisted medicines accident cover Medi-HL)

drugs_complementary

Complementary medicines: see (complementary medicines Medi-KM)

drugs_complementary_accident

Complementary medicines accident: see (complementary medicines accident cover Medi-KM-Unfall)

drugs_remark

Remarks on medicines

drugs_benefit_delay

Cover interruption




Expand
title2.4.1.9 Request structure «patient/hospital» (typeRES_hospital)


Image Added


Element

Description

message_query

Server response for special situations concerning insurance on date in question

hospital_unit

Hospital ward: see (hospital ward under ICA ABT)

hospital_model

Hospital model: see (hospital ward model under supplementary insurance ZV-modell)

hospital_accident

Hospital accident insurance: see (accident cover under supplementary insurance for hospital ward ZV-Unfall)

hospital_akutsomatik

Reimbursement/blocking of special acute care services: see (restriction on hospital cover ZV-Akut)

hospital_psychiatry

Reimbursement/blocking of special psychiatric services: see (restriction on hospital cover ZV-Psych)

hospital_list

Hospital list model: see (restrictions hospital cover  ZV-Liste) for list types

hospital_remark

Remarks on hospital

hospital_benefit_delay

Cover interruption




Expand
title2.4.1.10 Request structure «patient/vvg_zvs» (typeRES_vvg_zvs)


Image Added


 

Element

Description

ambulant_private

message_query

Server response for special situations concerning insurance on date in question

ambulant_private

Private outpatient

ambulant_private_accident

Private outpatient accident cover

ambulant_private_accident_add1

Private outpatient additional field 1 (online block)

ambulant_private_accident_add2

Private outpatient additional field 2

ambulant_private_accident_add3

Private outpatient additional field 3

ambulant_private_accident_add4

Private outpatient additional field 4

ambulant_private_remark1

Private outpatient remark 1

ambulant_private_remark2

Private outpatient remark 2

therapy_alternative

therapy_alternative

Alternative therapies

accident_therapy_alternative

Alternative therapies accident

accident_therapy_alternative_add1

Alternative therapies additional field 1 (online block)

accident_therapy_alternative_add2

Alternative therapies additional field 2

accident_therapy_alternative_add3

Alternative therapies additional field 3

accident_therapy_alternative_add4

Alternative therapies additional field 4

therapy_alternative_remark1

Alternative therapies remark 1

therapy_alternative_remark2

Alternative therapies remark 2

EUP

hospital_unit_eup

Hospital ward special insurance EUP

hospital_model_eup

Hospital model special insurance EUP

insurance_accident_eup

Accident cover special hospital insurance EUP

hospital_special_add1_eup

Additional hospital field 1 special insurance EUP

hospital_special_add2_eup

Additional hospital field 2 special insurance EUP

hospital_special_add3_eup

Additional hospital field 3 special insurance EUP

hospital_special_add4_eup

Additional field 4 EUP (online block)

remark1_eup

Special hospital insurance EUP remark 1

remark2_eup

Special hospital insurance EUP remark 2

KLV

basic_insurance_amb_klv

Basic outpatient insurance under Health Insurance Benefits Ordinance (HIBO) / ICA

basic_insurance_stat_klv

Basic inpatient insurance under HIBO / ICA

name_basic_insurance_klv

Name of basic insurance under HIBO / ICA

basic_insurance_accident_klv

Basic insurance accident cover under HIBO / ICA

basic_insurance_klv_add1

Basic insurance under HIBO additional field 1 special

basic_insurance_klv_add2

Basic insurance under HIBO additional field 2 special

basic_insurance_klv_add3

Basic insurance under HIBO additional field 3 special

basic_insurance_klv_add4

Basic insurance under HIBO additional field 4 (online block)

basic_insurance_klv_remark1

Basic insurance under HIBO remark 1

basic_insurance_klv_remark2

Basic insurance under HIBO remark 2

drugs_prevention

drugs_hors_liste_prevention

Unlisted medicines prevention

drugs_complementary_prevention

Complementary medicines prevention

Gatekeeper

ZSR

Gatekeeper’s ZSR number

name1

Gatekeeper’s last name

name2

Gatekeeper’s first name

Free_text

Free_text4

Free text 04

Free_text5

Free text 05

Free_text6

Free text 06

Free_text7

Free text 07

Free_text8

Free text 08

Free_text9

Free text 09

Free_text10

Free text 10




Expand
title2.4.1.11 Request structure «typeRES_Address»


Image Added


Element

Description

street

Street

postbox

postbox

zip

Post code

city

City

countrycode

Country




Expand
title2.4.1.12 Request structure «typeRES_masterdata»


Image Added


Element

Description

Code

Master data ID

Text

Master data value in response language: see (typeQRY_questioners)




Expand
title2.4.1.13 Request structure «typeRES_canton»


Image Added


Element

Description

isZsrInBlackListActive

Flag that indicates if the ZSR is mentioned in the blacklist

blacklist

Is a list of type typeRES_blacklist




Expand
title2.4.1.14 Request structure «typeRES_blacklist»


Image Added


Element

Description

canton_name

Official two-letter abbreviation of canton: see (Canton of residence)

remark

Canton’s remark

valid_from

Date on which OASI number was added to blacklist

valid_until

If this is empty, the OASI number is still on the list.




Expand
title2.4.1.15 Request structure «typeRES_ZAS»


Image Added


Element

Description

official_familynames

Official last name(s) according to CCO

official_givennames

Official first name(s) according to CCO

official_birthdate

Official date of birth according to CCO

official_gender

Official gender (see typeGender)





2. 5 Master date

2.5.1 Basic insurance (GV)

Expand
titlePermitted values for basic insurance under HIA


ID

Basic insurance under HIA

00

No compulsory health insurance cover under HIA

01

Compulsory health insurance cover under HIA

complete list


2.5.2 Basic insurance model (GV-MODELL)

Expand
titlePermitted values for basic insurance under HIA


ID

Type of basic insurance model under HIA

00

No basic insurance

01

Standard model under HIA

02

GP model under HIA

03

HMO model under HIA

04

List model under HIA

05

Telemedicine model under HIA

06

Pharmacy model

99

Special model under HIA (precise description in remark field)

complete list


2.5.3 Canton of residence (KANTON)

Expand
titlePermitted values for insured person’s canton of residence (premium canton)


ID

Bezeichnung Wohnkanton für KVG-Deckung

00

Keine Grundversicherung

AG

Aargau

AI

Appenzell Innerrhoden

AR

Appenzell Ausserrhoden

BE

Bern

BL

Basel-Landschaft

BS

Basel-Stadt

FR

Freiburg

GE

Genf

GL

Glarus

GR

Graubünden

JU

Jura

LU

Luzern

NE

Neuenburg

NW

Nidwalden

OW

Obwalden

SG

St. Gallen

SH

Schaffhausen

SO

Solothurn

SZ

Schwyz

TG

Thurgau

TI

Tessin

UR

Uri

VD

Waadt

VS

Wallis

ZG

Zug

ZH

Zürich

99

Ausland

FL

Fürstentum Liechtenstein

Full list as on car number plates, excluding FL


2.5.4 Basic insurance accident cover (GV-UNFALL)

Expand
titlePermitted values for accident cover under HIA:


ID

Basic insurance accident cover

00

No accident cover under HIA

01

Accident cover under HIA

Complete list


2.5.5 Unlisted medicines (MEDI-HL)

Expand
titlePermitted values for unlisted medicines under ICA:


ID

Unlisted medicines cover

00

No cover for unlisted medicines

01

Cover for unlisted medicines

02

Restricted cover for unlisted medicines

Complete list


2.5.6 Unlisted medicines accident cover (MEDI-HL_UNFALL)

Expand
titlePermitted values for accident cover for ICA medicines:


ID

Unlisted medicines accident cover

00

No accident cover for unlisted medicines

01

Accident cover for unlisted medicines

Complete list


2.5.7 Complementary medicines (MEDI-KM)

Expand
titlePermitted values for complementary medicines under ICA:


ID

Complementary medicines cover

00

No cover for complementary medicines

01

Cover for complementary medicines

02

Restricted cover for complementary medicines

Complete list


2.5.8 Complementary medicines accident cover KM (MEDI-KM-UNFALL)

Expand
titlePermitted values for complementary medicines under ICA


ID

Complementary medicines accident cover

00

No accident cover for complementary medicines

02

Restricted accident cover for complementary medicines

01

Accident cover for complementary medicines

Complete list


2.5.9 Hospital ward under ICA  (ABT)

Expand
titlePermitted values for hospital cover under ICA


ID

ICA hospital ward

00

No ICA hospital ward

01

General ward anywhere in Switzerland

02

Semi-private ward under ICA

03

Private ward under ICA

04

Fixed-sum insurance under ICA

05

Private ward worldwide under ICA

06

Private ward in Europe under ICA

Complete list


2.5.10 Hospital ward model under supplementary insurance (ZV-MODELL)

Expand
titlePermitted values for special hospital ward model


ID

Type of ICA hospital model (comfort and choice of doctor)

10

Multi-bed room with no free choice of doctor (ABT=01)

20

Two-bed room with free choice of doctor (ABT=02, 01)

30

Single room with free choice of doctor (ABT=03, 02, 01)

40

Choice of ward on admission (ABT=01, 04)

50

Two-bed room with no free choice of doctor (ABT=01)

60

Single room with no free choice of doctor (ABT=01)

70

Multi-bed room with free choice of doctor (ABT=01, 04)

00

No ICA hospital cover (ABT=00)

Complete list


2.5.11 Accident cover under supplementary insurance for hospital ward (ZV-UNFALL)

Expand
titlePermitted values for accident cover under hospital insurance:


ID

Hospital insurance accident cover

00

No accident cover as part of hospital insurance under ICA

01

Accident cover as part of hospital insurance under ICA

Complete list


2.5.12 Restriction on hospital cover (ZV-AKUT)

Expand
titlePermitted values for additional fields for inpatient hospital insurance in line with general restrictions under supplementary insurance conditions, general insurance conditions or ZB


ID

Acute care restriction (not including personal restrictions)

01

No acute care restriction under ICA

02

Acute care restriction under ICA (e.g. maternity)

00

No acute care cover under ICA

Complete list


2.5.13 Restrictions on hospital cover (ZV-PSYCH)

Expand
titlePermitted values for additional fields for inpatient hospital insurance in line with general restrictions under general and supplementary insurance conditions


ID

Psychiatric care restriction (not including personal restrictions)

01

No psychiatric care restriction under ICA

02

Psychiatric care restriction under ICA (limited amount and duration)

00

No psychiatric care cover under ICA

Complete list


2.5.14 Restrictions on hospital cover (ZV-LISTE)

Expand
titlePermitted values for additional fields for inpatient hospital insurance in line with general restrictions under general and supplementary insurance conditions‎


ID

Hospital list restriction (not including personal restrictions)

01

No hospital list restriction under ICA (public/private hospitals anywhere in Switzerland)

02

Hospital list restriction under ICA (insurer’s hospital list)

00

No hospital list cover under ICA

Complete list


2.5.15 Basic insurer's products (GV-PROD)

Expand
titleInsurer’s basic insurance products (GV-PROD)


ID

Basic insurance product name

01

Product X

02

Product Y


2.5.16 Supplementary insurer’s products (ZV-PROD)

Expand
titleInsurer’s supplementary insurance products (ZV-PROD)


ID

Supplementary insurance product name

01

Product X

02

Product Y