Wartungsfenster am Mittwoch, 14. Oktober 2026 von 18:00 bis 22:00 Uhr. Confluence wird in diesem Zeitraum mehrfach nicht zur Verfügung stehen.

Page History

Versions Compared

Old Version 45

changes.mady.by.user Jasmin Andres

Saved on Mar 16, 2022

compared with

New Version Current

changes.mady.by.user Funda Türker

Saved on Jul 01, 2026

Key

This line was added.
This line was removed.
Formatting was changed.

The ZSR Webservice is the public API to connect customer specific solutions to the SASIS care provider register in a well structured an secured manner.

The reader of this documentation will find the API description in detail as well as further information about the access and authorization mechanisms.

Sv translation

language	de

Target audience

This documentation is intended for developers and system integrators which enable customer systems for interaction with the ZSR Webservice.

Summary

Panel

title	Content

Table of Contents

Introduction

The ZSR Webservice provides a possibility to connect enterprise systems to SASIS internal data structures to maintain and interrogate care providers and their clearing numbers.

The ZSR Webservice is designed to replace existing file based data exchange with a high performance and secure online interface. The API itself is REST based and supports tenant specific requests which is handled based on the authentication of the API client.

The main functionality is:

Interrogation of clearing number (ZSR/RCC/CPR number) or employee number (K-Nummer/Numéro C/Numero di controllo) overviews and details.
Interrogation of comments on health services.
Interrogation of filtered clearing numbers and/or employee numbers based on subscription search options.
Maintenance of care provider certification periods (mainly used by health service certifiers).

HTML
<div class="references">

Panel

title	Links

https://www.zsrnext.ch/ApiGateway/swagger/index.html

https://openid.net/connect/

https://oauth.net/2/

HTML
</div>

ZSR Webservice Specification

Open API Specification

Status codes

The SASIS Regis uses standard http status codes.

The following status codes will generally be used by the API:

Status CodeDescription200Success202Accepted; Request is valid and business process could be triggered successfully.400Bad Request; The request data is invalid.401Unauthorized; The caller does not have sufficient privileges to perform the call.403Forbidden; The server is refusing the action.500Internal Server Error; Any unexpected internal failure.

Referenced Algorithms

Clearing number check digit

Panel
The clearing number has the following structure: A leading char as check digit A four digit sequential number A two digit number circle / canton number The leading char of the clearing number is created and validated as follows: Each number is multiplied with its position (calculate from the right end). All products are summarized into one sum. Modulo 26 of the sum denotes the char in the alphabet (result 0 results in char 'Z'). Example L248519: `(91)+(12)+(53)+(84)+(45)+(26) = 90` `90 mod 26 = 12` `12th char in the alphabet = L`

Panel

The clearing number has the following structure:

A leading char as check digit
A four digit sequential number
A two digit number circle / canton number

The leading char of the clearing number is created and validated as follows:

Each number is multiplied with its position (calculate from the right end).
All products are summarized into one sum.
Modulo 26 of the sum denotes the char in the alphabet (result 0 results in char 'Z').

Example L248519:
(9*1)+(1*2)+(5*3)+(8*4)+(4*5)+(2*6) = 90
90 mod 26 = 12
12th char in the alphabet = L

UID ECH0097 check digit

Panel
The ECH0097 enterprise identification number (Unternehmensidentifikationsnummer UID, Numéro d’identification des entreprises IDE, Numero d’identificazione delle imprese IDI) has the following structure: ISO-Alpha-3 Code (ISO 3166-1) of Switzerland (CHE) 8 digit pseudo random number check digit The check digit is created and validated as follows: Each digit of the pseudo-random number is multiplied with a predefined multiplier: 54327654 All products are summarized into one sum. 11 minus Modulo 11 of the sum defines the check digit. Example CHE-114.617.288: `(15)+(14)+(43)+(62)+(17)+(76)+(25)+(84) = 124` `124 mod 11 = 3` `11 - 3 = 8`

Panel

The ECH0097 enterprise identification number (Unternehmensidentifikationsnummer UID, Numéro d’identification des entreprises IDE, Numero d’identificazione delle imprese IDI) has the following structure:

ISO-Alpha-3 Code (ISO 3166-1) of Switzerland (CHE)
8 digit pseudo random number
check digit

The check digit is created and validated as follows:

Each digit of the pseudo-random number is multiplied with a predefined multiplier: 54327654
All products are summarized into one sum.
11 minus Modulo 11 of the sum defines the check digit.

Example CHE-114.617.288:
(1*5)+(1*4)+(4*3)+(6*2)+(1*7)+(7*6)+(2*5)+(8*4) = 124
124 mod 11 = 3
11 - 3 = 8

Authentication / Autorisation

The authentication is based on OpenID Connect, an identity layer on top of OAuth 2.0 and its corresponding flows/grants. For application integration, the resource owner password flow using the OAuth 2.0 password grant is to be used.

The SASIS IAM infrastructure acts a OpenID provider / authorization server.

draw.io DiagrambordertrueviewerToolbartruefitWindowfalsediagramNameapi_access_sequencesimpleViewerfalsewidth600diagramWidth676revision2

The API Client requests the token endpoint from the auth server.
The token endpoint is returned to the API Client.
Request an access token from the auth server by providing the following post request parameters:
1. grant_type: set to 'password'
2. client_id: provided individually by SASIS
3. client_secret: provided individually by SASIS
4. username: provided individually by SASIS
5. password: provided individually by SASIS
6. scope: set constantly to 'openid profile email offline_access roles c1s_profile cpr'
The access token as well as the refresh token is returned to the API Client.
The specific API resource is called providing the access token in as bearer in the Authorization http header:
'Authorization: Bearer <access token>'
The API responds to the request.
Once the access token expired, the previously received refresh token is used to request a new access token from the auth server by providing the following parameters:
1. grant_type: set to 'refresh_token'
2. client_id: provided individually by SASIS
3. client_secret: provided individually by SASIS
4. scope: set constantly to 'openid profile email offline_access roles c1s_profile cpr'
5. refresh_token: The refresh token received with the last access token.
A new access token as well as a new refresh token is returned to the API Client.
The specific API resource is called providing the new access token in as bearer in the Authorization http header:
'Authorization: Bearer <access token>'
The API responds to the request.

Links

ApiGateway/swagger/index.html

ApiGateway/swagger/1/swagger.json

Swagger Editor - editor.swagger.io

OpenID Connect - openid.net

OAuth - oauth.net

JSON Web Tokens - jwt.io

ReDoc - redocly.github.io

W3 Status Code Definition - w3.org

Service Level Agreement IT Services santéservices DE

Service Level Agreement IT Services santéservices FR

Service Level Agreement IT Services santéservices IT

ZSR Produktübersicht

Release Notes

Kontakt

HTML
</div>

^{Integration des Webservices}

Welche Daten können über den ZSR-Webservice bezogen werden?

Welche Daten abgefragt werden können ist also abhängig von den Modulen die der Kunde abonniert hat. Siehe Abo-Optionen

Werden sistierte (inaktive) Nummern über den ZSR Webservice ausgeliefert?

ZSR Webservice liefert sistierte ZSR- wie auch K-Nummer aus, sofern die Sistierung nicht länger als 10 Jahre zurückliegt.

Ein sistierter Leistungserbringer, bzw. Angestellter kann wie folgt identifiziert werden: Zum Abfragezeitpunkt besteht keine gültige validityPeriod.

Werden gelöschte Nummern über den Webservice geliefert?

Nummern werden gelöscht, wenn diese irrtümlicherweise erteilt wurden und nie fachlich gültig waren oder wenn diese vor mehr als 10 Jahren sistiert wurden (siehe sistierte Nummern).

Integratoren wird folgendes Vorgehen empfohlen, um gelöschte Nummern zu erkennen:

Laden aller Nummern über den Endpoint Numbers ohne Wert in modifiedFrom und Offset 0 und Limit 150'000. Die Liste enthält alle publizierten Nummern abzüglich der gelöschten Nummern.
Vergleich des Outputs mit den im eigenen System geführten Nummern. Alle Nummer, die im eigenen System vorhanden nicht aber im Output enthalten sind, müssen als gelöscht verarbeitet werden.

Warum erhalte ich keine Response auf eine angefragte Nummer?

Wenn eine Nummer abgefragt wird und keine Werte geliefert werden, ist die Nummer:

nicht bei santéservices ag vorhanden.
storniert, weil sie irrtümlich erstellt wurde. Das heisst, sie war fachlich nie gültig.
archiviert. Spätestens 10 Jahre nach Inaktivsetzung wird eine Nummer archiviert.

Wie sieht das Datenmodell beim ZSR Webservice aus?

Die wichtigsten Entitäten sind:

CareProvider - Leistungserbringer
CareProviderBusiness - Standort
ClearingNumber - ZSR-Nummer
EmployeeNumber - K-Nummer

Hauptentitäten einer ClearingNumber (Zahlstelle):

number (ZSR-Nummer)
correspondenceParty (Korrespondenzadresse)
clearingNumberSuffix (Nummernkreis = letzte beiden Ziffern einer ZSR-Nummer)
account (Konto)
clearingNumberLaws (Zulassung)
careProvider (Leistungserbringer)
- careProviderParties (Adressen)
- qualifications (Qualifikationen)
- employeeNumbers (K-Nummer)
careProviderBusinesses (Zahlstellen-Standorte)
- careProviderBusinessParties (Adressen)
- facilities (Einrichtung)
- healthServices (Methoden)
- affiliations (Mitgliedschaften)
businessScope (PaOG/PaUG)
businessActivity (Haupttätigkeit Ärztin/Arzt)
relatedClearingNumbers (zugeordnete Zahlstellen/Zusätzliche Zahlstellen)
relatedEmployees (Arbeitnehmer/Angestellte)
licenses (Kantonale Bewilligung)
admissions (Kantonale Zulassung)
validityPeriods (Gültigkeit der Nummer)

Hinweise:
Es handelt sich um eine stark vereinfachte Darstellung - für Details siehe Swagger-Schema.

Mit welchem Response-Format gibt der ZSR-Webservice Antwort?

Die Daten werden in JSON Format geliefert (XML wird nicht unterstützt).

Können Referenzdaten (=Stammdaten) separat geladen werden?

Stammdaten/Basisdaten zu ZSR-/K-Nummern Werten (Methoden, Qualifikationen, Banken, usf.) müssen grundsätzlich nicht separat geladen werden. Alle notwendigen Daten werden direkt in der Detail-Response zur einzelnen Nummer mitgeliefert.

Bei Bedarf können Stammdaten/Basisdaten dennoch separat wie folgt eingelesen werden:

Alle Enum-Werte (z.B. Gender, Canton u.a.) werden bereits im swagger.json (JSON) vollständig ausgewiesen. Mit Hilfe des SwaggerEditors oder anderer Tools lassen sich Referenz-Klassen des ZSR-Webservice samt der dazugehörigen Enum-Werte automatisch generieren.
Nicht als Enum-Werte im swagger.json ausgewiesen, aber über einen dedizierten ZSR-Webservice Endpoint abrufbar sind folgende Werte:
- Affiliations (Verbandscodes)
- BusinessActivities
- BusinessScopes (PAOG/PAUG)
- CareProviderCertification
- ClearingNumberSuffixes (Nummernkreise)
- Countries (Länder)
- Distribution Types
- Facilities (Standorteigenschaften)
- FunctionalUnits
- HealthServices (Methoden)
- Qualifications (Qualifikationen)

Die eindeutige Identifikation der Stammdaten ist über das Element "key" (string) möglich. Siehe Werden technische Id's geliefert?
Beispiel: "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Wo finde ich die technische Dokumentation des Webservice?

Es steht eine Open API Specification zur Verfügung.

Nebst Swagger kann beispielsweise ReDoc zur Darstellung OpenAPI Specification genutzt werden.

Swagger: Das Swagger UI ermöglicht, Einzelabfragen zu testen. Die Darstellung mittels Swagger ist jedoch bezüglich Property-Darstellung von mehrfach vererbten Entitäten nicht abschliessend, d.h. es werden nicht alle Properties von Entitäten in Swagger-UI angezeigt,
Redocly: Als alternatives GUI wird Redocly zusätzlich zu Swagger-UI zur Verfügung gestellt. Entitäten von json werden hier immer mit allen Properties dargestellt. Die Ansicht des json kann unter /ApiGateway/docs aufgerufen werden: Live-System: https://zsrnext.ch/ApiGateway/docs

Gibt es eine Versionierung des ZSR-Webservice?

Der ZSR-Webservice liegt in der Version v1.x vor. Alle Änderungen am Webservice werden bis auf Weiteres nicht über neue Versionen im Parallelbetrieb umgesetzt, sondern alle Anpassungen erfolgen direkt auf der Version v1.x. Jegliche Änderungen werden jedoch rechtzeitig als Release-Notes publiziert und per Stage-System zur Verfügung gestellt. Es gelten die Service Level Agreement SLA.

Steht den Kunden eine Integrationsumgebung zur Verfügung?

Für die Integration des ZSR-Webservices sowie für vorgängiges Testing von neuen Webservice-Versionen steht unter int.zsrnext.ch/ eine Integrationsplattform bereit.
Der Datenstand der Integrationsplattform wird wöchentlich jeden Mittwoch Morgen mit einer Kopie von Live aktualisiert. Aufgrund der Datenaktualisierung sowie Wartungsarbeiten ist auf der Integrationsplattform jeden Mittwoch von 06:00 bis 12:00 mit Unterbrüchen zu rechnen.

Wie lauten die aktuellen IT-SLA der santéservices ag

Für den Webservice kommt das Service Level Agreement SLA der santéservices IT Services zur Anwendung.

^{Anfragen und Support}

Wo kann der Zugang zum ZSR-Webservice beantragt werden?

Bitte nehmen Sie Kontakt mit uns auf um den Zugang zum ZSR-Webservice zu beantragen.

An wen kann man sich bei Supportanfragen zum ZSR-Webservice wenden?

Bitte nehmen Sie Kontakt mit uns auf.

^{Authentifizierung und Absetzen von Abfragen}

Wie kann auf den ZSR-Webservice zugegriffen werden?

Bitte nehmen Sie Kontakt mit uns auf um den Zugang zum ZSR-Webservice zu beantragen.

Wie erfolgt die Authentifizierung?

Die Authentifizierung basiert auf OpenID Connect bzw. OAuth 2.0 unter Verwendung von password grant.

draw.io Diagram

border	true
viewerToolbar	true

fitWindow	false
diagramName	api_access_sequence
simpleViewer	false
width	600
diagramWidth	676
revision	2

The API Client requests the token endpoint from the auth server.
The token endpoint is returned to the API Client.
Request an access token from the auth server by providing the following post request parameters:
1. grant_type: set to 'password'
2. client_id: provided individually by santéservices
3. client_secret: provided individually by santéservices
4. username: provided individually by santéservices
5. password: provided individually by santéservices
6. scope: set constantly to 'openid profile email offline_access roles c1s_profile cpr'
The access token as well as the refresh token is returned to the API Client.
The specific API resource is called providing the access token in as bearer in the Authorization http header:
'Authorization: Bearer <access token>'
The API responds to the request.
Once the access token expired, the previously received refresh token is used to request a new access token from the auth server by providing the following parameters:
1. grant_type: set to 'refresh_token'
2. client_id: provided individually by santéservices
3. client_secret: provided individually by santéservices
4. scope: set constantly to 'openid profile email offline_access roles c1s_profile cpr'
5. refresh_token: The refresh token received with the last access token.
A new access token as well as a new refresh token is returned to the API Client.
The specific API resource is called providing the new access token in as bearer in the Authorization http header:
'Authorization: Bearer <access token>'
The API responds to the request.

Access token

The access token response contains additional information:

Code Block

language	java
title	Access token response

{
  "access_token": "MTQ0NjOkZmQ5OTM5NDE9ZTZjNGZmZjI3",
  "refresh_token": "GEbRxBNZmQOTM0NjOkZ5NDE9ZedjnXbL",
  "token_type": "bearer",
  "expires_in": 300,
  "scope": "openid profile email offline_access roles c1s_profile cpr"
}

The token itself is a JWT and can therefore be decoded on the JWT website.

The expires_in field defines the validity period of the token in seconds. Afterwards, a new token must be retrieved.

Code samples

A complete c# sample shows how to access one specific API resource (numbers):

HTML
<div class="references">

CprApiAccessSample.zip

HTML
</div>

Authentication in other languages follows the same procedure.

The following code snippets explain the procedure on a step-by-step basis:

Code Block

language	c#
theme	Confluence
title	1./2. Retrieve the auth servers token endpoint
collapse	true

        /// <summary>
        /// Loads the IAM configuration.
        /// </summary>
        private async Task<DiscoveryResponse> GetDiscoveryDocumentAsync(CancellationToken ct)
        {
            using (var client = new HttpClient())
            {

Access token

The access token response contains additional information:

Code Block

language	java
title	Access token response

{
  "access_token": "MTQ0NjOkZmQ5OTM5NDE9ZTZjNGZmZjI3",
  "refresh_token": "GEbRxBNZmQOTM0NjOkZ5NDE9ZedjnXbL",
  "token_type": "bearer",
  "expires_in": 300,
  "scope": "openid profile email offline_access roles c1s_profile cpr"
}

The token itself is a JWT and can therefore be decoded on the JWT website.

The expires_in field defines the validity period of the token in seconds. Afterwards, a new token must be retrieved.

Code samples

A complete c# sample shows how to access one specific API resource (numbers):

HTML
<div class="references">

CprApiAccessSample.zip

HTML
</div>

Authentication in other languages follows the same procedure.

The following code snippets explain the procedure on a step-by-step basis:

Code Block

language	c#
theme	Confluence
title	1./2. Retrieve the auth servers token endpoint
collapse	true

        /// <summary>
        /// Loads the IAM configuration.
        /// </summary>
        private async Task<DiscoveryResponse> GetDiscoveryDocumentAsync(CancellationToken ct)
        {
            using (var client = new HttpClient())
            {
                var discoveryResponse = await client.GetDiscoveryDocumentAsync(new DiscoveryDocumentRequest
                {
                    Address = "[AuthorityUrl]"
                }, ct).ConfigureAwait(false);

                ifvar (discoveryResponse.IsError) = await client.GetDiscoveryDocumentAsync(new DiscoveryDocumentRequest
                {
    throw new Exception(discoveryResponse.Error);

              Address  return discoveryResponse;
= "[AuthorityUrl]"
                }, ct).ConfigureAwait(false);

          }      if (discoveryResponse.IsError)
                    throw new Exception(discoveryResponse.Error);

                return discoveryResponse;
            }
        }

Code Block

language	c#
theme	Confluence
title	3./4. Request access and refresh token
collapse	true

        /// <summary>
        /// Gets a new token response with a username and password.
        /// </summary>
        private async Task<TokenResponse> RequestTokenAsync(CancellationToken ct)
        {
            using (var client = new HttpClient())
            {
                var discoveryResponse = await GetDiscoveryDocumentAsync(ct).ConfigureAwait(false);

                var tokenResponse = await client.RequestPasswordTokenAsync(new PasswordTokenRequest
                {
                    ClientId = "[ClientId]",
                    ClientSecret = "[ClientSecret]",
                    UserName = "[UserName]",
                    Password = "[Password]",
                    Address = discoveryResponse.TokenEndpoint,
                    GrantType = OidcConstants.GrantTypes.Password,
                    Scope = string.Join(" ", _scopes),
                }, ct).ConfigureAwait(false);

                if (tokenResponse.IsError)
                    throw new Exception(tokenResponse.Error);

                return tokenResponse;
            }
        }

Code Block

language	c#
theme	Confluence
title	7./8. Token refresh strategy based validity of cached token response and request new access token
collapse	true

        /// <summary>
        /// Gets the access token by either requesting a new token or by using the refresh token of an already existing token.
        /// </summary>
        private async Task<string> GetAccessTokenAsync(CancellationToken ct)
        {
            if (_tokenResponse == null)
            {
                // Creates a new token response
                _tokenResponse = await RequestTokenAsync(ct).ConfigureAwait(false);
            }
            else
            {
                var jwtSecurityTokenHandler = new JwtSecurityTokenHandler();

                // Parses JWT access token
                var jwtSecurityToken = jwtSecurityTokenHandler.ReadToken(_tokenResponse.AccessToken) as JwtSecurityToken;

                // The access token might be valid now, but expired the very next millisecond.
                // Thus, add a reasonable reserve in minutes for the validity time comparison below.
                var comparisionCorrectionInMinutes = 1;

                // Compares the access token life time with the current time, modified by the comparison correction value.
                if (jwtSecurityToken.ValidTo < DateTime.UtcNow.AddMinutes(comparisionCorrectionInMinutes))
                {
                    // Updates the existing token response
                    _tokenResponse = await RefreshTokenAsync(_tokenResponse.RefreshToken, ct).ConfigureAwait(false);
                }
            }

            return _tokenResponse.AccessToken;
        }

        /// <summary>
        /// Gets an updated token response by using a refresh token.
        /// </summary>
        private async Task<TokenResponse> RefreshTokenAsync(string refreshToken, CancellationToken ct)
        {
            using (var client = new HttpClient())
            {
                var discoveryResponse = await GetDiscoveryDocumentAsync(ct).ConfigureAwait(false);

                var tokenResponse = await client.RequestTokenAsync(new TokenRequest
                {
                    ClientId = "[ClientId]",
                    ClientSecret = "[ClientSecret]",
                    Address = discoveryResponse.TokenEndpoint,
                    ClientCredentialStyle = ClientCredentialStyle.AuthorizationHeader,
                    GrantType = OidcConstants.GrantTypes.RefreshToken,
                    Parameters =
                    {
                        { "refresh_token", refreshToken },
                        { "scope", string.Join(" ", _scopes) }
                    }
                });

                if (tokenResponse.IsError)
                    throw new Exception(tokenResponse.Error);

                return tokenResponse;
            }
        }

Code Block

language	c#
theme	Confluence
title	5./6./9./10. API resource call using the access token in the Authorization http header
collapse	true

        /// <summary>
        /// A simple CPR API number search request.
        /// </summary>
        private async Task<BulkResponse> CprApiSampleRequestAsync(string accessToken, CancellationToken ct)
        {
            BulkResponse bulkResponse = new BulkResponse();

            using (var client = new HttpClient())
            {
                client.SetBearerToken(accessToken);

                var response = await client.GetAsync($"https://[CprBaseUrl]/ApiGateway/api/v1/numbers?searchOptions=Okp&offset=0&limit=10", ct).ConfigureAwait(false);

                if (!response.IsSuccessStatusCode)
                    throw new Exception("There was a problem with the request");

                string content = await response.Content.ReadAsStringAsync();

                if (content != null && content.Length > 0)
                {
                    bulkResponse = JsonConvert.DeserializeObject<BulkResponse>(content);
                }
            }

            return bulkResponse;
        }

Code Block

language	c#
theme	Confluence
title	Plain API Call (putting everything together)
collapse	true

        var accessToken = await GetAccessTokenAsync(ct).ConfigureAwait(false);

        var cprApiResponse = await CprApiSampleRequestAsync(accessToken, ct).ConfigureAwait(false);

Connection Settings

SettingTest Environment StageCurrentTest Environment StageExtraTest Environment StageNextLive EnvironmentAuthorityUrlhttps://openid.santesuisse.ch https://openid.santesuisse.ch https://openid.santesuisse.ch https://openid.santesuisse.chCprBaseUrlhttps://stagecurrent.zsrnext.ch/

https://stageextra.zsrnext.ch/

https://stagenext.zsrnext.ch/https://www.zsrnext.chClientId1)1)1)1)ClientSecret1)1)1)1)UserName1)1)1)1)Password1)1)1)1)

1) To be provided individually by SASIS. Please contact: support@sasis.ch

.Content.ReadAsStringAsync();

                if (content != null && content.Length > 0)
                {
                    bulkResponse = JsonConvert.DeserializeObject<BulkResponse>(content);
                }
            }

            return bulkResponse;
        }

Code Block

language	c#
theme	Confluence
title	Plain API Call (putting everything together)
collapse	true

        var accessToken = await GetAccessTokenAsync(ct).ConfigureAwait(false);

        var cprApiResponse = await CprApiSampleRequestAsync(accessToken, ct).ConfigureAwait(false);

Welche Limiten bestehen auf Batchabfragen?

Als Batchabfragen gelten Abfragen mit mehr als 50 Requests pro Minute und Kunde.

Abfragen aus Batch-Prozessen auf Online-Dienste der santéservices ag dürfen ausschliesslich zwischen 22.00 und 4.00 Uhr durchgeführt werden.
Die Online-Dienste der santéservices ag sind mit einer Begrenzung versehen, welche die Anfragen ab einer Überschreitung von 1000 Abfragen pro Minute und Kunde zurückweist (http Statuscode 503).

Siehe auch Service Level Agreement SLAder santéservices ag Services.

Weshalb kann ich nur 500 Nummern bei der Detailansicht beziehen?

Abfragen an die Endpoints ClearingNumbers und EmployeeNumbers sind aus Performance Gründen auf 500 Nummern limitiert. Der Abfrage-Prozess ist so zu planen, das jeweils maximal 500 Nummern in einem Request enthalten sind.

Welche Statuscodes werden vom Webservice zurückgegeben?

Der Webservice verwendet http status codes. Folgende Codes können zurückgegeben werden:

Status Code	Description
200	Success
202	Accepted; Request is valid and business process could be triggered successfully.
400	Bad Request; The request data is invalid.
401	Unauthorized; The caller does not have sufficient privileges to perform the call.
403	Forbidden; The server is refusing the action.
500	Internal Server Error; Any unexpected internal failure.

Wie können 503er-Fehler verhindert/vermieden werden?

Wird der Webservice mit zu vielen parallelen Abfragen überlastet, werden 503er-Fehler zurückgegeben. Um 503er-Fehler zu vermeiden, müssen die Anweisungen für das Laden der Nummernliste wie auch das Laden der Nummerndetails unbedingt beachtet werden (siehe auch Wie können Daten zu ZSR- und K-Nr. über den Webservice abgefragt werden?). Die Anzahl Requests kann weiter reduziert werden, indem beispielsweise nur Mutationen als Tagesscheiben abgefragt werden (siehe auch Wie können Mutationen abgefragt werden?). Nach dem Auftreten eines 503er-Fehlers sollte zudem ein Zeitpuffer von 5 Minuten bis zur nächsten Abfrage implementiert werden. Allenfalls ist auch zu prüfen, ob Webservice-Abfragen auf einen anderen, nächtlichen Zeitslot verlegt werden können

Wie können 400er-Fehler verhindert/vermieden werden?

Wenn der Client einen ungültigen Request an den Webservice sendet, wird ein 400er-Fehler zurückgegeben. Um 400er-Fehler zu vermeiden, müssen die Anweisungen für das Laden der Nummernliste wie auch das Laden der Nummerndetails unbedingt beachtet werden (siehe auch Wie können Daten zu ZSR- und K-Nr. über den Webservice abgefragt werden?). Der Abfrage-Prozess ist so zu planen, das jeweils maximal 500 Nummern in einem Request enthalten sind. 400er-Fehler können ebenfalls auftreten wenn die Abfrage von einem Absender gesendet wird, der nicht in der Whitelist der WAF (Web Application Firewall) für den entsprechenden User konfiguriert wurde! Bitte nehmen sie in diesem Fall mit uns Kontakt auf und teilen sie uns die IP (oder den IP-Range) mit, von wo die Abfrage erfolgt.

^{Abfrage von ZSR- und K-Nummern}

Wie können Daten zu ZSR- und K-Nr. über den Webservice abgefragt werden?

Die Abfrage der Daten erfolgt in zwei Schritten.

Schritt 1 - Laden der Nummernliste:

Abfrage aller gewünschten ZSR-/K-Nummern über den Endpoint "Numbers". Angewendete Filterkriterien und die Benutzer-Berechtigungen beeinflussen das Suchresultat. Der Endpoint "Numbers" liefert sämtliche ZSR-/K-Nummern aus, die den Filterkriterien entsprechen und auf welche der Kunde berechtigt ist. Nicht geliefert werden ZSR-/K-Nummern die länger als 10 Jahre sistiert sind.

Filterkriterien:

filterOptions: Begrenzt die Anzahl zurückgegebener Nummern auf bestimmte Kategorie(n)/Zertifizierer. Verfügbare Module analog der Abo-Optionen.
numberTypes: Bestimmt den zurückgegebenen Nummerntyp (ZSR-/K-Nummer).
offset: Paging-Wert, der eine Anzahl von Nummern überspringt. In der Regel kann hier 0 übergeben werden.
limit: Paging-Wert, der die Anzahl zurückgegebener Nummern begrenzt. Damit mit einem Request alle Nummern auf einmal geladen werden können, darf hier ein relativ hoher Wert mitgegeben werden, z.B. 200'000.
modifiedFrom: Das "Modified-Stichdatum", s. Abfrage von Mutationen (DIFF).

Schritt 2 - Laden der Nummerndetails:

Mit dem Resultat von Schritt 1 ist für jeweils 500 Nummern ein Request über den jeweiligen Detail-Endpoint abzusetzen.

Endpoints:

für ZSR-Nummern: Endpoint "ClearingNumbers"
für K-Nummern: Eindpoint "EmployeeNumbers"

Die Response der Detail-Endpoints beinhaltet die kompletten Nummern-Details, auf die der User berechtigt ist. Auf gehäufte, parallele Einzelrequest ist aus performancegründen unbedingt zu verzichten.

Kann ich nach bestimmten Eigenschaften einer ZSR- oder K-Nummer suchen?

Erweiterte Suchanfragen mit Filterkriterien auf Feldebene, beispielsweise nach Name oder Postleitzahl, werden über den ZSR-Webservice nicht angeboten. Für erweiterte Suchanfragen steht die ZSR-Vollversion zur Verfügung.

Wie wird der ClearingNumbers Endpoint verwendet?

Der Endpoint ClearingNumbers liefert Details zu ZSR-Nummern zurück.

Siehe Wie können Daten zu ZSR- und K-Nr. über den Webservice abgefragt werden?

Wie wird der EmployeeNumbers Endpoint verwendet?

Der Endpoint EmployeeNumbers liefert Details zu K-Nummern zurück.

Siehe Wie können Daten zu ZSR- und K-Nr. über den Webservice abgefragt werden?

Wie können gelöschte Eigenschaftswerte identifiziert werden?

Wenn ein Eigenschaftswerte einer ZSR-Nummer einmal geliefert wurde (mit einer bestimmten ID bzw. ZSR-/K-Nummer) und zu einem späteren Zeitpunkt nicht mehr in der Response enthalten ist, dann handelt es sich um einen gelöschten/stornierten Wert.

Wie können Mutationen abgefragt werden?

Über den Endpoint "Numbers" kann als Parameter ein "Modified-Stichdatum" festgelegt werden. In der Response enthalten sind dann nur Nummern, die seit diesem Datum modifiziert wurden. Solche Modifikationen können fachlicher Natur sein, aber auch nur rein technische Werte der Nummer betreffen.

Länger als 10 Jahre sistierte und stornierte Nummern werden über den Numbers-Endpoint nicht geliefert. Um herausfinden zu können, welche Nummern betroffen sind, müssen zuerst alle aktiven Nummern über den Numbers-Endpoint geladen werden. Fehlen Nummern in diesem Resultat, die im Client-System jedoch noch aktiv geführt werden, sind diese im Client-System zu beenden bzw. zu löschen.

Nach dem Laden aller modifizierten Nummern können die Details zu diesen Nummern wie üblich über die Detail-Endpoints abgefragt werden. Die Response dieser Endpoints liefert immer alle verfügbaren Daten zu einer ZSR-/K-Nummer und nicht nur die effektiv geänderten Werte.

Mutationen können vom Client-System z.B. mittels Vergleich des JSON-Resultats der letzten Abfrage mit dem JSON-Resultat der neuen Abfrage verarbeitet werden. Hierzu gäbe es folgende Fälle zu beachten:

Element mit techn. ID x besteht im Client-System und wird im JSON-Resultat geliefert: Es ist zu prüfen, ob sich ein für das Client-System relevanter Feldwert des Elements geändert hat.
Element mit techn. ID y besteht im Client-System und wird im JSON-Resultat nicht geliefert: Alle Feldwerte des Elements gelten als storniert und müssen entfernt werden.
Element mit techn. ID z besteht nicht im Client-System und wird im JSON-Resultat geliefert: Alle Feldwerte des Elements sind neu und müssen eingelesen werden.

Die Integration des Webservice sollte immer so erfolgen, dass diese unabhängig von der Anzahl der gemeldeten Mutationen funktioniert, z.B. sollen selbst gewählte Thresholds nicht zum Abbruch des Daten-Imports führen.

Können auch nur geänderte ZSR-/K-Nummern geladen werden?

Ja, das Filterkriterium "modifiedFrom" erlaubt die Abfrage von Mutationen per Stichdatum. Siehe auch Wie können Mutationen abgefragt werden?

Wie sind Mutationen zu verarbeiten?

Element mit techn. ID x besteht im Client-System und wird im JSON-Resultat geliefert: Es ist zu prüfen, ob sich ein für das Client-System relevanter Feldwert des Elements geändert hat.
Element mit techn. ID y besteht im Client-System und wird im JSON-Resultat nicht geliefert: Alle Feldwerte des Elements gelten als storniert und müssen entfernt werden.
Element mit techn. ID z besteht nicht im Client-System und wird im JSON-Resultat geliefert: Alle Feldwerte des Elements sind neu und müssen eingelesen werden.

Es gibt somit zwei Varianten wie eine Veränderung eines bestehenden Wertes geliefert werden kann:

Variante 1: mit fachlicher Historisierung → bei jeder Mutation des Feldwertes wird ein Element mit neuer technischer ID angelegt.
Variante 2: noch ohne fachliche Historisierung → ein Feldwert ändert sich, die technische ID bleibt gleich.

Im Endausbau des Webservice wird nur noch Variante 1 zur Anwendung kommen. Aktuell muss die Integration so erfolgen, dass die Client-Systeme mit beiden Varianten umgehen können.

^{Interpretation der Daten}

Wie werden ZSR-Nummern Beziehungen im Webservice geliefert?

ClearingNumber.relatedClearingNumbers enthält durch die santéservices manuell geführte Beziehungen zu ZSR-Nummern. Diese werden nur noch so lange geführt, bis vom Leistungserbringer bestätigte Daten vorliegen.
CareProvider.ClearingNumbers enthält vom Leistungserbringer bestätigte Beziehungen zu ZSR-Nummern.
CareProvider.EmployeeNumbers enthält vom Leistungserbringer bestätigte Beziehungen zu K-Nummern. (hierbei handelt es sich NICHT um Angestelltenverhältnisse).

Um die Gesamtheit der ZSR-Nummern Beziehungen zu erhalten, müssen somit sowohl ClearingNumber.relatedClearingNumbers wie auch CareProvider.ClearingNumbers berücksichtigt werden.

Expand

title	Beispiele

Code Block

title	ClearingNumber.relatedClearingNumbers

    "relatedClearingNumbers": [
        {
          "clearingNumber": "B222222",
          "clearingNumberRelationType": "CHANGE_OF_HANDS",
          "clearingNumberRelationTypeTranslations": {
            "de": "Besitzerwechsel",
            "fr": "Changement de propriétaire",
            "it": "Cambiamento di proprietario"
          },
          "id": 520754
        }
      ]

Code Block

title	CareProvider.ClearingNumbers

"clearingNumbers": [
          {
            "number": "N111111"
          }
        ]

Code Block

title	CareProvider.EmployeeNumbers

 "employeeNumbers": [
          {
            "number": "999999K"
          }
        ]

Hinweis: Eine Beziehungsart wird nicht geführt und kann daher nicht ausgeliefert werden für CareProvider.ClearingNumbers und CareProvider.EmployeeNumbers.

Wie werden Angestelltenverhältnisse im Webservice geliefert?

Angestelltenverhältnisse werden unter clearingNumber.relatedEmployees geliefert.

Nach welcher Logik werden die Qualifikationen zugeordnet?

qualificationTitleType

Wir weisen aus, ob es sich um eine eidgenössische oder durch MEBEKO anerkannte Qualifikation handelt. Diese Differenzierung ist möglich bei Diplomen (qualificationGroupeTyp "DIPLOMA") oder Weiterbildungstitel (qualificationGroupType "POSTGRADUATE_TITLE"). Bei den privatrechtlichen Weiterbildungstitel (qualificationGroupeTyp "PRIVATE_LAW_POSTGRADUATE_TITLE") handelt es sich immer um eidgenössische Titel. Wir führen aktuell "UNKNOWN".

Mögliche Werte:

RECOGINZED_MEBEKO (Anerkennung MEBEKO)
FEDERAL (Eidgenössiche Titel)

qualificationGroupType

Analoge Struktur gemäss MedReg. Unterteilung der Qualifikationen in die Typen Diplom, Weiterbildungstitel und privatrechtliche Weiterbildungstitel.

Mögliche Werte:

DIPLOMA (Diplom)
POSTGRADUATE_TITLE (Weiterbildungstitel)
PRIVATE_LAW_POSTGRADUATE_TITLE (Privatrechtliche Weiterbildungstitel)

qualificationType

Im Unterschied zum qualificationGroupeTyp werden die privatrechtlichen Weiterbildungstitel (PRIVATE_LAW_POSTGRADUATE_TITLE) differenziert ausgewiesen in Fähigkeitsausweis (SIWF_CERTIFICATE) und Schwerpunkt (SIWF_SPECIALIZATION).

Mögliche Werte:

DIPLOMA (Diplom)
FMH_POSTGRADUATE_TITLE (Facharzttitel FMH)
SIWF_CERTIFICATE (Fähigkeitsausweis)
SIWF_SPECIALIZATION (Schwerpunkt (SIWF)

Zusammenfassend entsprechen für im Medreg geführte Partnerartobergruppen (Doctor, Pharmacist, Chiropractor, Dentist) der QualificationType dem Medreg "Privatrechtliche WB Typ", der QualificationTitleType dem Medreg Diplom-/Weiterbildungstyp und der QualificationGroupType der Medreg Unterteilung in Diplom, Weiterbildungstitel und privatrechtliche Weiterbildungstitel.

Für alle anderen OG's wird für QualificationGroupType und QualificationTitleType "Unknown" geführt. Bei QualificationType wird je nach OG noch zwischen Diploma, Certificate, Admission, LaboratoryPostgraduateTitle, LaboratorySpecialization, OrthopedicShoeTechnologyPostgraduateTitle unterschieden.

Welche Bedeutung haben die Daten «0001-01-01» bzw. «9999-12-31»?

Für fachliche Zeiträume liefert der ZSR-Webservice immer einen Wert für Start- und Ende-Datum, auch dort wo sich aus den Legacy-Daten oder aus anderen Gründen sinnvollerweise keine genauen Datumswerte bestimmen lassen.

Dafür werden je einen Platzhalterwert für das Start- und das Ende-Datum verwendet. Die Interpretation dieser Werte ist wie folgt:

«0001-01-01» ist ein Platzhalterwert für ein Startdatum und bedeutet, dass es kein bekanntes fachliches Anfangsdatum gibt (NULL).
«9999-12-31» ist ein Platzhalterwert für ein Endedatum und bedeutet, dass es kein bekanntes fachliches Enddatum gibt (NULL).

Ein fachlicher Wert mit fachlichem Startdatum «0001-01-01» und fachlichem Endedatum «9999-12-31» ist somit zu jedem Zeitpunkt gültig.

Werden technische Id's geliefert?

Element id

Die in der Detail-Response gelieferten IDs haben keinerlei fachliche Bedeutung und sollten nicht zur fachlichen Interpretation von Werten herbeigezogen werden. Sie dienen ausschliesslich der technischen Identifikation der gelieferten Daten bzw. können zur Handhabung von Mutationen (siehe Wie können Mutationen abgefragt werden? bzw. Wie sind Mutationen zu verarbeiten?) genutzt werden. Auf der technischen IDs sollte nie eine Logik codiert werden.

Für den Hauptrecord der ZSR-/K-Nummer wird ausserdem überhaupt keine technische ID geliefert. Eine Identifikation ist nur mittels ZSR-/K-Nummer möglich. Ein Ersatzwert zur vormaligen ZahlstellenId wird nicht ausgeliefert

Element key

"Stammdaten/Referenzdaten", z.B. wie Kanton, Land, Qualifikation usf., werden mit einer beständigen GUID als Identifikator ausgeliefert. Siehe auch Können Referenzdaten (=Stammdaten) separat geladen werden?

Die eindeutige Identifikation ist über das Element "key" (string) möglich bei folgenden Entitäten:

Affiliations
BusinessScopes
ClearingNumberSuffixes
Countries
Distribution Types
Facilities
FunctionalUnits
HealthServices
Qualifications

Beispiel: "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Wie können Dummy-Nummern identifiziert werden?

Die sogenannten Dummy-Nummern sind ein weiterhin verwendetes Legacy-Konstrukt, das weiterhin per ZSR-Webservice bezogen werden kann.

Sobald auf dem ClearingNumber Objekt ein Wert für das Property "clearingNumberDummy" geliefert wird, handelt es sich um eine Dummy-Nummer.

Beispiel-Struktur:

Code Block

language	js

{
	"clearingNumber": {
		"clearingNumberDummy": {
			"id": 912
			"name": "CH-Arzt",
		}
	}
}

Wie werden Partnerart-Obergruppe/Partnerart-Untergruppe im Webservice ausgewiesen?

Alle Leistungserbringer ausser Ärzte und Ärztinnen

Im Feld parentBusinessScope wird immer der Wert für die Partnerart-Obergruppe geliefert.
Im Feld businessScope wird
falls vorhanden der Wert der Partnerart-Untergruppe geliefert.
ansonsten wird der Wert der Partnerart-Obergruppe geliefert.

Ärzte und Ärztinnen
"Ärzte und Ärztinnen" werden in businessScope und businessActivity kategorisiert.

Die Werte für BusinessScopes/ParentBusinessScopes können Sie via Webservice über den Endpoint «BusinessScopes» abfragen: /api/v1/businessscopes.

Die Werte für businessActivity können Sie via Webservice über den Endpoint «BusinessActivities» abfragen: /api/v1/businessactivities.

^{Allgemeine Informationen zum Zahlstellenregister}

Wie setzt sich eine gültige ZSR-Nummer zusammen?

Die ZSR-Nummer setzt sich zusammen aus einem Prüfbuchstaben (1. Stelle), Laufnummer (Stellen 2-5) und dem Nummernkreis (Stellen 6-7).

Prüfbuchstabe 1
Laufnummer 4
Kantons-Identifikation 2
Beispiel: L248519
L = Prüfbuchstabe
2485 = Laufnummer
19 = Nummernkreis

Berechnung Prüfbuchstabe
Jeder Wert wird zuerst mit seiner Stellenposition multipliziert (letzte Zahl = Stellenposition 1).
Die Resultate werden anschliessend summiert.
Die Summe wird durch die Anzahl Buchstaben im Alphabet geteilt (Modulo 26).
Der Restbetrag ergibt die Stelle des Buchstabens im Alphabet

Beispiel: L248519

(9*1)+(1*2)+(5*3)+(8*4)+(4*5)+(2*6)=90
90/26=3.461...
90-(3*26)=12
12ter Buchstabe im Alphabet= L

Beispiel: Y274589

(9*1)+(8*2)+(5*3)+(4*4)+(7*5)+(2*6)=103
103/26=3.96...103-(26*3)=25
25ter Buchstabe im Alphabet = Y

Wie setzt sich eine gültige K-Nummer zusammen?

K-Nummern setzen sich zusammen aus einer Laufnummer (Stellen 1-6) und dem Buchstaben "K" (7.Stelle).

Sv translation

language	fr

Panel

title	Content

Table of Contents

HTML
<div class="references">

Panel

title	Links

ApiGateway/swagger/index.html

ApiGateway/swagger/1/swagger.json

Swagger Editor - editor.swagger.io

OpenID Connect - openid.net

OAuth - oauth.net

JSON Web Tokens - jwt.io

ReDoc - redocly.github.io

W3 Status Code Definition - w3.org

Service Level Agreement IT Services santéservices DE

Service Level Agreement IT Services santéservices FR

Service Level Agreement IT Services santéservices IT

Options d'abonnement

Release Notes

Contact

HTML
</div>

^{Web service integration}

Which data can be requested via the ZSR web service?

The modules to which the customer has subscribed thus determine which data can be requested. See Subscription options

Do inactive (suspended) numbers get delivered via the ZSR Webservice?

The ZSR Webservice delivers suspended ZSR numbers as well as K numbers, provided that the suspension occurred no more than 10 years ago.
A suspended service provider or employee can be identified as follows: at the time of the query, no valid validityPeriod exists.

Are deleted numbers delivered via the web service?

Numbers are deleted if they were issued in error and were never valid, or if they were suspended more than 10 years ago (see Suspended Numbers).

Integrators are advised to use the following procedure to identify deleted numbers:

Load all numbers via the Numbers endpoint with no value in `modifiedFrom`, an offset of 0, and a limit of 150,000. The list contains all published numbers minus the deleted numbers.
Compare the output with the numbers maintained in your own system. Any number present in your system but not included in the output must be treated as deleted.

Why do I not receive a response for a requested number?

If a number is queried and no values are returned, the number is:

not available at santéservices ag.
cancelled because it was created in error. This means it was never professionally valid.
archived. A number is archived 10 years after deactivation.

What does the data model of the ZSR Webservice look like?

The most important entities are:

CareProvider
CareProviderBusiness
ClearingNumber
EmployeeNumber

Main entities of a ClearingNumber (Clearing Number):

number
correspondenceParty (correspondence address)
clearingNumberSuffix (number range = last two digits of a ZSR number)
account (the bank account)
clearingNumberLaws
careProvider
- careProviderParties (addresses)
- qualifications
- employeeNumbers
careProviderBusinesses (business locations)
- careProviderBusinessParties (addresses)
- facilities
- healthServices (methods)
- affiliations (an affiliation in an organisation)
businessScope (the business scope devided into parent business scope and sub business scope)
businessActivity
relatedClearingNumbers
relatedEmployees
licenses
admissions
validityPeriods

Notes:
This is a highly simplified representation — for details, please refer to the Swagger schema.

Which response format does the ZSR web service use?

Data are delivered in JSON format (XML is not supported).

Can reference data (master data) be loaded separately?

Reference/master data for ZSR/K number values (methods, qualifications, banks etc.) do not have to be loaded separately. All required data are delivered directly in the detailed response for the individual number.

If needed, reference/master data can be entered separately as follows:

All enum values (e.g. gender, canton etc.) are already contained in full in swagger.json (JSON). The Swagger Editor or other tools can be used to generate ZSR web service reference classes automatically, complete with the corresponding enum values.
The following values are not contained in swagger.json as enum values, but they can be requested via a dedicated ZSR web service endpoint:
- Affiliations (association codes)
- BusinessActivities
- BusinessScopes (partner type groups/sub-groups)
- CareProviderCertification
- ClearingNumberSuffixes (number groups)
- Countries
- Distribution Types
- Facilities (location features)
- FunctionalUnits
- HealthServices (methods)
- Qualifications

Unique identification of the reference data is possible using the element “key” (string). See Are technical IDs delivered?

Example: "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Where can I find the technical API documentation?

An Open API Specification is available. In addition to Swagger, (for example) ReDoc can be used to display the open API specification.

Swagger:
The Swagger UI allows individual queries to be tested. However, the representation in Swagger is not exhaustive with regard to property display of multiply inherited entities, meaning not all properties of entities are displayed in the Swagger UI.

Redocly:
As an alternative GUI, Redocly is provided in addition to Swagger UI. JSON entities are always displayed with all properties. The JSON view can be accessed under /ApiGateway/docs:
Live system: https://zsrnext.ch/ApiGateway/docs

Is there a version history for the ZSR web service?

The ZSR web service is currently at version v1.x. For the time being, all changes to the ZSR web service will not be implemented via new versions in parallel operation but will instead be made directly in version v1.x. However, all changes will be published in release notes at the appropriate time and made available via the stage system. The Service Level Agreement SLAapply.

Is an integration environment available to customers?

An integration platform is available at int.zsrnext.ch/ for integrating the ZSR web service and for pre-testing new web service versions.
The integration platform's data status is updated weekly every Wednesday morning with a live copy. Due to data updates and maintenance work, interruptions to the integration platform are to be expected every Wednesday from 6:00 a.m. to 12:00 p.m.

What are the current santéservices ag IT SLAs?

The santéservices IT Service Level Agreement SLA applies to the web service.

^{Questions and support}

Where can I request access to the ZSR web service?

Please contact us to request access to the ZSR web service.

Who can provide support if I have an issue with the ZSR web service?

Please contact us.

^{Authentication and submitting requests}

How do I access the ZSR web service?

Please contact us to request access to the ZSR web service.

How does authentication work?

Authentication is based on OpenID Connect or OAuth 2.0 using password grant.

draw.io Diagram

border	true
viewerToolbar	true

fitWindow	false
diagramName	api_access_sequence
simpleViewer	false
width	600
diagramWidth	676
revision	2

The API Client requests the token endpoint from the auth server.
The token endpoint is returned to the API Client.
Request an access token from the auth server by providing the following post request parameters:
grant_type: set to 'password'
client_id: provided individually by santéservices
client_secret: provided individually by santéservices
username: provided individually by santéservices
password: provided individually by santéservices
scope: set constantly to 'openid profile email offline_access roles c1s_profile cpr'
The access token as well as the refresh token is returned to the API Client.
The specific API resource is called providing the access token in as bearer in the Authorization http header:
'Authorization: Bearer <access token>'
The API responds to the request.
Once the access token expired, the previously received refresh token is used to request a new access token from the auth server by providing the following parameters:
grant_type: set to 'refresh_token'
client_id: provided individually by santéservices
client_secret: provided individually by santéservices
scope: set constantly to 'openid profile email offline_access roles c1s_profile cpr'
refresh_token: The refresh token received with the last access token.
A new access token as well as a new refresh token is returned to the API Client.
The specific API resource is called providing the new access token in as bearer in the Authorization http header:
'Authorization: Bearer <access token>'
The API responds to the request.

Access token

The access token response contains additional information:

Code Block

language	java
title	Access token response

{
  "access_token": "MTQ0NjOkZmQ5OTM5NDE9ZTZjNGZmZjI3",
  "refresh_token": "GEbRxBNZmQOTM0NjOkZ5NDE9ZedjnXbL",
  "token_type": "bearer",
  "expires_in": 300,
  "scope": "openid profile email offline_access roles c1s_profile cpr"
}

The token itself is a JWT and can therefore be decoded on the JWT website.

The expires_in field defines the validity period of the token in seconds. Afterwards, a new token must be retrieved.

Code samples

A complete c# sample shows how to access one specific API resource (numbers):

HTML
<div class="references">

CprApiAccessSample.zip

HTML
</div>

Authentication in other languages follows the same procedure.

The following code snippets explain the procedure on a step-by-step basis:

Code Block

language	c#
theme	Confluence
title	1./2. Retrieve the auth servers token endpoint
collapse	true

        /// <summary>
        /// Loads the IAM configuration.
        /// </summary>
        private async Task<DiscoveryResponse> GetDiscoveryDocumentAsync(CancellationToken ct)
        {
            using (var client = new HttpClient())
            {
                var discoveryResponse = await client.GetDiscoveryDocumentAsync(new DiscoveryDocumentRequest
                {
                    Address = "[AuthorityUrl]"
                }, ct).ConfigureAwait(false);

                if (discoveryResponse.IsError)
                    throw new Exception(discoveryResponse.Error);

                return discoveryResponse;
            }
        }

Code Block

language	c#
theme	Confluence
title	3./4. Request access and refresh token
collapse	true

        /// <summary>
        /// Gets a new token response with a username and password.
        /// </summary>
        private async Task<TokenResponse> RequestTokenAsync(CancellationToken ct)
        {
            using (var client = new HttpClient())
            {
                var discoveryResponse = await GetDiscoveryDocumentAsync(ct).ConfigureAwait(false);

                var tokenResponse = await client.RequestPasswordTokenAsync(new PasswordTokenRequest
                {
                    ClientId = "[ClientId]",
                    ClientSecret = "[ClientSecret]",
                    UserName = "[UserName]",
                    Password = "[Password]",
                    Address = discoveryResponse.TokenEndpoint,
                    GrantType = OidcConstants.GrantTypes.Password,
                    Scope = string.Join(" ", _scopes),
                }, ct).ConfigureAwait(false);

                if (tokenResponse.IsError)
                    throw new Exception(tokenResponse.Error);

                return tokenResponse;
            }
        }

Code Block

language	c#
theme	Confluence
title	7./8. Token refresh strategy based validity of cached token response and request new access token
collapse	true

        /// <summary>
        /// Gets the access token by either requesting a new token or by using the refresh token of an already existing token.
        /// </summary>
        private async Task<string> GetAccessTokenAsync(CancellationToken ct)
        {
            if (_tokenResponse == null)
            {
                // Creates a new token response
                _tokenResponse = await RequestTokenAsync(ct).ConfigureAwait(false);
            }
            else
            {
                var jwtSecurityTokenHandler = new JwtSecurityTokenHandler();

                // Parses JWT access token
                var jwtSecurityToken = jwtSecurityTokenHandler.ReadToken(_tokenResponse.AccessToken) as JwtSecurityToken;

                // The access token might be valid now, but expired the very next millisecond.
                // Thus, add a reasonable reserve in minutes for the validity time comparison below.
                var comparisionCorrectionInMinutes = 1;

                // Compares the access token life time with the current time, modified by the comparison correction value.
                if (jwtSecurityToken.ValidTo < DateTime.UtcNow.AddMinutes(comparisionCorrectionInMinutes))
                {
                    // Updates the existing token response
                    _tokenResponse = await RefreshTokenAsync(_tokenResponse.RefreshToken, ct).ConfigureAwait(false);
                }
            }

            return _tokenResponse.AccessToken;
        }

        /// <summary>
        /// Gets an updated token response by using a refresh token.
        /// </summary>
        private async Task<TokenResponse> RefreshTokenAsync(string refreshToken, CancellationToken ct)
        {
            using (var client = new HttpClient())
            {
                var discoveryResponse = await GetDiscoveryDocumentAsync(ct).ConfigureAwait(false);

                var tokenResponse = await client.RequestTokenAsync(new TokenRequest
                {
                    ClientId = "[ClientId]",
                    ClientSecret = "[ClientSecret]",
                    Address = discoveryResponse.TokenEndpoint,
                    ClientCredentialStyle = ClientCredentialStyle.AuthorizationHeader,
                    GrantType = OidcConstants.GrantTypes.RefreshToken,
                    Parameters =
                    {
                        { "refresh_token", refreshToken },
                        { "scope", string.Join(" ", _scopes) }
                    }
                });

                if (tokenResponse.IsError)
                    throw new Exception(tokenResponse.Error);

                return tokenResponse;
            }
        }

Code Block

language	c#
theme	Confluence
title	5./6./9./10. API resource call using the access token in the Authorization http header
collapse	true

        /// <summary>
        /// A simple CPR API number search request.
        /// </summary>
        private async Task<BulkResponse> CprApiSampleRequestAsync(string accessToken, CancellationToken ct)
        {
            BulkResponse bulkResponse = new BulkResponse();

            using (var client = new HttpClient())
            {
                client.SetBearerToken(accessToken);

                var response = await client.GetAsync($"https://[CprBaseUrl]/ApiGateway/api/v1/numbers?searchOptions=Okp&offset=0&limit=10", ct).ConfigureAwait(false);

                if (!response.IsSuccessStatusCode)
                    throw new Exception("There was a problem with the request");

                string content = await response.Content.ReadAsStringAsync();

                if (content != null && content.Length > 0)
                {
                    bulkResponse = JsonConvert.DeserializeObject<BulkResponse>(content);
                }
            }

            return bulkResponse;
        }

Code Block

language	c#
theme	Confluence
title	Plain API Call (putting everything together)
collapse	true

        var accessToken = await GetAccessTokenAsync(ct).ConfigureAwait(false);

        var cprApiResponse = await CprApiSampleRequestAsync(accessToken, ct).ConfigureAwait(false);

What are the limits on batch requests?

Batch requests are defined as involving more than 50 requests per minute for a given customer.
Requests from batch processes on online services provided by santéservices ag may only be carried out between 10.00 pm and 4.00 am.
santéservices ag’s online services have limits in place that cause batches of more than 1,000 requests per minute for a given customer to be rejected (http status code 503).

See also the santéservices IT Service Level Agreement SLA.

Why can I only call up 500 numbers in the detail view?

Requests involving the endpoints ClearingNumbers and EmployeeNumbers are limited to 500 numbers for performance reasons. The request process must be planned such that no request contains more than 500 numbers.

Which status codes does the web service return?

The web service uses http status codes. The following codes may be returned:

Status Code	Description
200	Success
202	Accepted; Request is valid and business process could be triggered successfully.
400	Bad Request; The request data is invalid.
401	Unauthorized; The caller does not have sufficient privileges to perform the call.
403	Forbidden; The server is refusing the action.
500	Internal Server Error; Any unexpected internal failure.

How can 503 errors be avoided?

If the API is overloaded with large numbers of parallel requests, it returns 503 errors. To avoid these, it is very important to follow the instructions for loading the number list and the number details (see also How can data on ZSR and K numbers be requested via the web service?). The number of requests can be reduced further, for example, by requesting only changes via a daily change batch request (see also How can changes be requested?). When a 503 error occurs, it is advisable to wait five minutes before making another request. If possible, customers should check whether API requests can be deferred to a time slot during the night.

How can 400 errors be avoided?

When the client sends an invalid request to the API, it returns a 400 error. To avoid these, it is very important to follow the instructions for loading the number list and the number details (see also How can data on ZSR and K numbers be requested via the web service?). The request process must be planned such that no request contains more than 500 numbers.

400 errors may also occur if the query is sent from a sender that has not been configured in the WAF (Web Application Firewall) whitelist for the relevant user. In this case, please contact us and provide the IP address (or IP range) from which the query is being made.

^{ZSR and K number requests}

How can data on ZSR and K numbers be requested via the web service?

Data are requested in two steps.

Step 1 – Loading the number list:

Request all the required ZSR/K numbers via the Numbers endpoint. The filter criteria employed and user authorisations affect the search results. The Numbers endpoint delivers all ZSR/K numbers that match the filter criteria and for which the customer is authorised. It does not deliver ZSR/K numbers that have been suspended for more than ten years.

Filter criteria:

filterOptions: limits the numbers returned to specific categories/certifiers. The modules available are as for the subscription options.
numberTypes: sets the type of number returned (ZSR or K number).
offset: paging value that skips a set number of numbers. As a rule, this can be set to 0.
limit: paging value that limits how many numbers are returned. To ensure that all numbers can be loaded at once with a request, a relatively high value can be set here, e.g. 200,000.
modifiedFrom: the “modified from” date; see How can changes be requested?

Step 2 – Loading the number details:

The result from step 1 is used to make a request via the appropriate detail endpoint for 500 numbers at a time.

Endpoints:

For ZSR numbers: ClearingNumbers endpoint
For K numbers: EmployeeNumbers endpoint

The response from the detail endpoint contains the complete number details for which the user is authorised. For performance reasons, it is important to avoid making large numbers of parallel individual requests.

Can I search for specific properties of a ClearingNumber or EployeeNumbers?

Extended search queries with filter criteria at field level, e.g. by name and postcode, are not offered via the web service. The full version of ZSR is available for advanced search queries.

How is the ClearingNumbers endpoint used?

The ClearingNumbers endpoint delivers details of ZSR numbers.

See How can data on ZSR and K numbers be requested via the web service?

How is the EmployeeNumbers endpoint used?

The EmployeeNumbers endpoint delivers details of K numbers.

See How can data on ZSR and K numbers be requested via the web service?

According to which logic are qualifications assigned?

qualificationTitleType
We indicate whether a qualification is federal or recognised by MEBEKO. This differentiation is possible for diplomas (qualificationGroupType "DIPLOMA") or postgraduate titles (qualificationGroupType "POSTGRADUATE_TITLE"). Private-law postgraduate titles (qualificationGroupType "PRIVATE_LAW_POSTGRADUATE_TITLE") are always federal titles. We currently use "UNKNOWN".

Possible values:

RECOGNIZED_MEBEKO
FEDERAL

qualificationGroupType

Analogous structure according to MedReg. Division of qualifications into the types diploma, postgraduate title, and private-law postgraduate title.

Possible values:

DIPLOMA
POSTGRADUATE_TITLE
PRIVATE_LAW_POSTGRADUATE_TITLE

qualificationType
Unlike qualificationGroupType, private-law postgraduate titles (PRIVATE_LAW_POSTGRADUATE_TITLE) are differentiated into certificate of competence (SIWF_CERTIFICATE) and specialisation (SIWF_SPECIALIZATION).

Possible values:

DIPLOMA
FMH_POSTGRADUATE_TITLE
SIWF_CERTIFICATE
SIWF_SPECIALIZATION

Summary:
For partner type parent groups listed in MedReg (Doctor, Pharmacist, Chiropractor, Dentist), the QualificationType corresponds to the MedReg "Private-law postgraduate type", the QualificationTitleType corresponds to the MedReg diploma/postgraduate type, and the QualificationGroupType corresponds to the MedReg classification into diploma, postgraduate title, and private-law postgraduate title.

For all other parent groups, "Unknown" is used for QualificationGroupType and QualificationTitleType. For QualificationType, further distinctions are made depending on the parent group, such as Diploma, Certificate, Admission, LaboratoryPostgraduateTitle, LaboratorySpecialization, and OrthopedicShoeTechnologyPostgraduateTitle.

How can changes be requested?

A “modified from” date can be set as a parameter via the Numbers endpoint. The response then contains only numbers that have been changed since that date. Modifications can be specialist in nature or concern purely technical values. Numbers that have been suspended or cancelled for more than ten years are not delivered via the Numbers endpoint. To find out which numbers are affected, all active numbers must first be loaded via the Numbers endpoint. Any numbers that are still active in the client system but are not contained in the results should be cancelled or deleted from the client system.

Once all modified numbers have been loaded, their details can be requested in the usual way via the detail endpoints. The response from these endpoints always contains all available data on a ZSR/K number, not just the values that have been changed.
Changes can be processed from the client system, e.g. by comparing the JSON result from the last request with the JSON result from the new request. The following cases must be borne in mind:

An element with the technical ID x exists in the client system and is delivered in the JSON result: it is important to check whether a field value of the element that is relevant for the client system has changed.
An element with the technical ID y exists in the client system and is not delivered in the JSON result: all of the element’s field values are regarded as cancelled and must be removed.
An element with the technical ID z does not exist in the client system and is delivered in the JSON result: all of the element’s field values are new and must be entered.

The API should always be integrated such that it works regardless of the number of changes reported, i.e. threshold values set by the customer should not cause the data import to fail.

Is it possible to load only ZSR/K numbers that have been changed?

Yes. The filter criterion “modifiedFrom” makes it possible to request changes by date. See also How can changes be requested?

How are changes handled?

An element with the technical ID x exists in the client system and is delivered in the JSON result: it is important to check whether a field value of the element that is relevant for the client system has changed.
An element with the technical ID y exists in the client system and is not delivered in the JSON result: all of the element’s field values are regarded as cancelled and must be removed.
An element with the technical ID z does not exist in the client system and is delivered in the JSON result: all of the element’s field values are new and must be entered.

There are thus two different ways in which a change to an existing value can be delivered:

Option 1: with change history → an element with a new technical ID is created every time a field value is changed.
Option 2: without change history → the technical ID remains unchanged when a field value is changed.

The final version of the web service will only use Option 1. For the time being, however, integration must ensure that the client systems can handle both options.

^{Interpreting the data}

How are ZSR number relationships delivered in the web service?

relatedClearingNumberscontains ZSR number relationships recorded manually by santéservices. These are only kept on record until data confirmed by the service provider are available.
ClearingNumberscontains ZSR number relationships confirmed by the service provider.
EmployeeNumberscontains K number relationships confirmed by the service provider (these are NOT employee relationships).

To receive all ZSR number relationships, therefore, it is essential to take account of both ClearingNumber.relatedClearingNumbers and CareProvider.ClearingNumbers

Expand

title	Examples

Code Block

title	ClearingNumber.relatedClearingNumbers

    "relatedClearingNumbers": [
        {
          "clearingNumber": "B222222",
          "clearingNumberRelationType": "CHANGE_OF_HANDS",
          "clearingNumberRelationTypeTranslations": {
            "de": "Besitzerwechsel",
            "fr": "Changement de propriétaire",
            "it": "Cambiamento di proprietario"
          },
          "id": 520754
        }
      ]

Code Block

title	CareProvider.ClearingNumbers

"clearingNumbers": [
          {
            "number": "N111111"
          }
        ]

Code Block

title	CareProvider.EmployeeNumbers

 "employeeNumbers": [
          {
            "number": "999999K"
          }
        ]

Remarks: Relationship types are not recorded and can thus not be delivered for CareProvider.ClearingNumbers and CareProvider.EmployeeNumbers.

Employee relationships are delivered under clearingNumber.relatedEmployees or in the EmployeeNumbers endpoint under employeeNumber.relatedEmployers.

What do the data items “0001-01-01” and “9999-12-31” mean?

The ZSR web service always delivers a start date and an end date for time periods, even if it is not possible to determine the exact dates due to the legacy data or for other reasons.

Placeholder values for the start and end date are therefore used. These are to be interpreted as follows:

“0001-01-01” is a placeholder value for the start date and means that the actual start date is not known (NULL).
“9999-12-31” is a placeholder value for the end date and means that the actual end date is not known (NULL).

A time period with the start date “0001-01-01” and the end date “9999-12-31” is thus valid for any given point in time.

Are technical IDs delivered?

Element id

The IDs delivered in the detailed response have no specialist meaning and should not be used to interpret values. They are purely technical identifiers of the delivered data and can serve to process changes (see How can changes be requested? and How are changes handled?). No logic should ever be coded to technical IDs.

In addition, no technical IDs whatsoever are delivered for the main ZSR/K number record. Identification is only possible using the ZSR/K number itself. A replacement for the old paying agent ID is not delivered.

Element key

Master/reference data, e.g. canton, country, qualification etc., are delivered with a permanent GUID as identifier. See also Can reference data (master data) be loaded separately?

Unique identification is possible using the element “key” (string) for the following entities:

Affiliations
BusinessScopes
ClearingNumberSuffixes
Countries
Distribution Types
Facilities
FunctionalUnits
HealthServices
Qualifications

Example: "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

How can dummy numbers be identified?

So-called “dummy” numbers are a legacy construct. They are still in use and can be retrieved via the ZSR web service.

If a value for the property "clearingNumberDummy" is delivered on the ClearingNumber object, the number in question is a dummy number.

Example of structure:

Code Block

language	js

{
	"clearingNumber": {
		"clearingNumberDummy": {
			"id": 912
			"name": "CH-Arzt",
		}
	}
}

How are partner type groups/sub-groups displayed in the web service?

All service providers apart from doctors

The partner type group value is always delivered in the field “parentBusinessScope”.
The partner type sub-group value, if available, is delivered in the field “businessScope”.
Otherwise, the partner type group value is delivered.

Doctors
Doctors are categorised in terms of business scope and business activity.

The “businessScope”/”parentBusinessScope” values can be queried in the web service via the BusinessScopes endpoint: /api/v1/businessscopes.

The “businessActivity” values can be queried in the web service via the BusinessActivities endpoint: /api/v1/businessactivities.

^{General information on the paying agent register}

How is a valid number constructed?

The clearing number has the following structure:

A leading char as check digit
A four digit sequential number
A two digit number circle / canton number

The leading char of the clearing number is created and validated as follows:

Each number is multiplied with its position (calculate from the right end).
All products are summarized into one sum.
Modulo 26 of the sum denotes the char in the alphabet (result 0 results in char 'Z').

Example L248519:
(9*1)+(1*2)+(5*3)+(8*4)+(4*5)+(2*6) = 90
90 mod 26 = 12
12th char in the alphabet = L

How is a valid K number constructed?

K numbers consist of a six-digit serial number followed by the letter K

Sv translation

language	fr

Cet article n'est pas disponible en français

Sv translation

language	it

Overview

Content Tools

Powered by Atlassian Confluence 9.2.8

Printed by Atlassian Confluence 9.2.8

Report a bug

Atlassian News

Atlassian

Page tree

Page History

Versions Compared

Old Version 45

New Version Current

Key

Introduction

ZSR Webservice Specification

Referenced Algorithms

Clearing number check digit

UID ECH0097 check digit

Authentication / Autorisation

Integration des Webservices

Welche Daten können über den ZSR-Webservice bezogen werden?

Werden sistierte (inaktive) Nummern über den ZSR Webservice ausgeliefert?

Werden gelöschte Nummern über den Webservice geliefert?

Warum erhalte ich keine Response auf eine angefragte Nummer?

Wie sieht das Datenmodell beim ZSR Webservice aus?

Mit welchem Response-Format gibt der ZSR-Webservice Antwort?

Können Referenzdaten (=Stammdaten) separat geladen werden?

Wo finde ich die technische Dokumentation des Webservice?

Gibt es eine Versionierung des ZSR-Webservice?

Steht den Kunden eine Integrationsumgebung zur Verfügung?

Wie lauten die aktuellen IT-SLA der santéservices ag

Anfragen und Support

Wo kann der Zugang zum ZSR-Webservice beantragt werden?

An wen kann man sich bei Supportanfragen zum ZSR-Webservice wenden?

Authentifizierung und Absetzen von Abfragen

Wie kann auf den ZSR-Webservice zugegriffen werden?

Wie erfolgt die Authentifizierung?

Access token

Code samples

Connection Settings

Welche Limiten bestehen auf Batchabfragen?

Weshalb kann ich nur 500 Nummern bei der Detailansicht beziehen?

Welche Statuscodes werden vom Webservice zurückgegeben?

Wie können 503er-Fehler verhindert/vermieden werden?

Wie können 400er-Fehler verhindert/vermieden werden?

Abfrage von ZSR- und K-Nummern

Wie können Daten zu ZSR- und K-Nr. über den Webservice abgefragt werden?

Kann ich nach bestimmten Eigenschaften einer ZSR- oder K-Nummer suchen?

Wie wird der ClearingNumbers Endpoint verwendet?

Wie wird der EmployeeNumbers Endpoint verwendet?

Wie können gelöschte Eigenschaftswerte identifiziert werden?

Wie können Mutationen abgefragt werden?

Können auch nur geänderte ZSR-/K-Nummern geladen werden?

Wie sind Mutationen zu verarbeiten?

Interpretation der Daten

Wie werden ZSR-Nummern Beziehungen im Webservice geliefert?

Wie werden Angestelltenverhältnisse im Webservice geliefert?

Nach welcher Logik werden die Qualifikationen zugeordnet?

Welche Bedeutung haben die Daten «0001-01-01» bzw. «9999-12-31»?

Werden technische Id's geliefert?

Wie können Dummy-Nummern identifiziert werden?

Wie werden Partnerart-Obergruppe/Partnerart-Untergruppe im Webservice ausgewiesen?

Allgemeine Informationen zum Zahlstellenregister

Wie setzt sich eine gültige ZSR-Nummer zusammen?

Wie setzt sich eine gültige K-Nummer zusammen?

Web service integration

Which data can be requested via the ZSR web service?

Do inactive (suspended) numbers get delivered via the ZSR Webservice?

Are deleted numbers delivered via the web service?

Why do I not receive a response for a requested number?

What does the data model of the ZSR Webservice look like?

Which response format does the ZSR web service use?

Can reference data (master data) be loaded separately?

Where can I find the technical API documentation?

Is there a version history for the ZSR web service?

Is an integration environment available to customers?

What are the current santéservices ag IT SLAs?

Questions and support

Where can I request access to the ZSR web service?

Who can provide support if I have an issue with the ZSR web service?

Authentication and submitting requests

How do I access the ZSR web service?

How does authentication work?

What are the limits on batch requests?

Why can I only call up 500 numbers in the detail view?

Which status codes does the web service return?

How can 503 errors be avoided?

^{Integration des Webservices}

^{Anfragen und Support}

^{Authentifizierung und Absetzen von Abfragen}

^{Abfrage von ZSR- und K-Nummern}

^{Interpretation der Daten}

^{Allgemeine Informationen zum Zahlstellenregister}

^{Web service integration}

^{Questions and support}

^{Authentication and submitting requests}

^{ZSR and K number requests}

^{Interpreting the data}

^{General information on the paying agent register}