{"swagger":"2.0","info":{"version":"1.0","title":"Sasis Register API v1.0","description":"This is the Sasis Register API documentation.","contact":{"name":"API Support","email":"support@sasis.ch"}},"basePath":"/ApiGateway","paths":{"/api/v1/careprovidercertification":{"post":{"tags":["CareProviderCertification"],"summary":"Creates or updates care provider certification periods and health services of one specific care provider. The request must always contain the full set historicised data.","operationId":"CreateOrUpdateCareProviderCertification","consumes":["application/json-patch+json","application/json","text/json","application/*+json"],"produces":["application/json"],"parameters":[{"name":"request","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/CareProviderCertificationRequest"}}],"responses":{"202":{"description":"Success. The provided data has been accepted and is scheduled to be applied asynchronously."},"400":{"description":"Bad Request","schema":{"type":"object","additionalProperties":{"uniqueItems":false,"type":"array","items":{"type":"string"}}}},"403":{"description":"Forbidden","schema":{"type":"object","additionalProperties":{"uniqueItems":false,"type":"array","items":{"type":"string"}}}},"401":{"description":"Unauthorized"}}}},"/api/v1/clearingnumbers":{"get":{"tags":["ClearingNumbers"],"summary":"Returns details for specific clearing numbers (ZSR/RCC/CPR). The returned data is to be specified as a list of plain clearing numbers as parameters.","operationId":"GetClearingNumbers","consumes":[],"produces":["application/json"],"parameters":[{"name":"clearingnumbers","in":"query","description":"A list of plain clearing numbers. <br />Validations:<ul><li>Max. 500 clearing numbers per request.</li></ul>","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi","default":null,"uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearingNumberDetailViewItem"}}},"400":{"description":"Bad Request","schema":{"type":"object","additionalProperties":{"uniqueItems":false,"type":"array","items":{"type":"string"}}}},"401":{"description":"Unauthorized"}}}},"/api/v1/employeenumbers":{"get":{"tags":["EmployeeNumbers"],"summary":"Returns details for specific employees. The returned data is to be specified as a list of plain employee numbers (K-Nummer / Numéro C / Numero di controllo) as parameters.","operationId":"GetEmployeeNumbers","consumes":[],"produces":["application/json"],"parameters":[{"name":"employeenumbers","in":"query","description":"A list of plain employee numbers. <br />Validations:<ul><li>Max. 500 employee numbers per request.</li></ul>","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi","default":null,"uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/EmployeeNumberDetailViewItem"}}},"400":{"description":"Bad Request","schema":{"type":"object","additionalProperties":{"uniqueItems":false,"type":"array","items":{"type":"string"}}}},"401":{"description":"Unauthorized"}}}},"/api/v1/healthservices/comments":{"get":{"tags":["HealthServices"],"summary":"Get all comments available on health services.","operationId":"GetHealthServiceComments","consumes":[],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthServiceCommentViewItem"}}},"401":{"description":"Unauthorized"}}}},"/api/v1/numbers":{"get":{"tags":["Numbers"],"summary":"Returns a paged list of clearing numbers (ZSR/RCC/CPR) and/or employee numbers (K-Nummer / Numéro C / Numero di controllo) by subscription search options.","operationId":"SearchNumbers","consumes":[],"produces":["application/json"],"parameters":[{"name":"searchoptions","in":"query","description":"The subscription search options. <br />Validations:<ul><li>Must be at least one of the listed search options.</li></ul>","required":true,"type":"array","items":{"type":"string","enum":["Okp","Ortho","Pharma","Lea","Comp","Fit","Asca","Spak","Aptn","Emr","EmFit","Qtop","Fsafe","FGuide","FGuideK"]},"collectionFormat":"multi","default":null,"uniqueItems":false},{"name":"offset","in":"query","description":"The number of entries used as offset to retrieve the next page. The next offset it must be calculated as sum of the previously used offset and the page size (limit).<br />Validations:<ul><li>-</li></ul>","required":true,"type":"integer","format":"int32","default":null},{"name":"limit","in":"query","description":"The maximal number of entries in the next returned page. Receiving a recordCount smaller than the limit indicates that the last page has been reached.<br />Validations:<ul><li>-</li></ul>","required":true,"type":"integer","format":"int32","default":null}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/StringBulkResponse"}},"401":{"description":"Unauthorized"}}}},"/api/v1/numbers/list":{"get":{"tags":["Numbers"],"summary":"Returns basic information about clearing and/or employee numbers. The returned data is to be specified as a list of plain clearing (ZSR/RCC/CPR) and/or employee numbers (K-Nummer / Numéro C / Numero di controllo) as parameters.","operationId":"GetNumberListViewItems","consumes":[],"produces":["application/json"],"parameters":[{"name":"numbers","in":"query","description":"A list of clearing (ZSR/RCC/CPR) and/or employee numbers (K-Nummer / Numéro C / Numero di controllo). <br />Validations:<ul><li>Max. 500 employee numbers per request.</li></ul>","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi","default":null,"uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/NumberListViewItem"}}},"400":{"description":"Bad Request","schema":{"type":"object","additionalProperties":{"uniqueItems":false,"type":"array","items":{"type":"string"}}}},"401":{"description":"Unauthorized"}}}},"/api/v1/processes/{proposalid}":{"get":{"tags":["Processes"],"summary":"Gets business process instance information by business process key","operationId":"GetProposal","consumes":[],"produces":["application/json"],"parameters":[{"name":"proposalid","in":"path","description":"The proposal id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ProposalProcessResponse"}},"401":{"description":"Unauthorized"}}}},"/api/v1/subscribers":{"get":{"tags":["Subscribers"],"summary":"Returns all available subscriber names.","operationId":"GetSubscribers","consumes":[],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Success","schema":{"uniqueItems":false,"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"}}}}},"definitions":{"CareProviderCertificationRequest":{"description":"The payload of a CareProviderCertification request.","required":["externalId","label"],"type":"object","properties":{"clearingNumber":{"description":"The clearing number (=ZSR-Nummer) identifying the care provider uniquely. <br />Validations:<ul><li>Clearing number check digit accoring to the documentation.</li></ul>","type":"string"},"externalId":{"description":"The identification of the care provider in the system of the API consumer. <br />Validations:<ul><li>Must contain numbers only.</li></ul>","type":"string"},"label":{"description":"Certification label.","enum":["ASCA","APTN","NVS_SPAK","ESKAMED_EMR"],"type":"string"},"careProviderHealthServices":{"description":"Health services for the care provider.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthServicePeriodRequest"}},"careProviderCertificationPeriods":{"description":"Certification periods for the care provider.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CertificationPeriodRequest"}},"subscriberHealthServices":{"description":"Health services per subscriber.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthServicePeriodSubscriberRequest"}},"subscriberCertificationPeriods":{"description":"Certification periods per subscriber.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CertificationPeriodSubscriberRequest"}}}},"HealthServicePeriodRequest":{"type":"object","properties":{"externalId":{"description":"The identification of the health service in the system of the API consumer. <br />Validations:<ul><li>Must contain numbers only.</li></ul>","type":"string"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' must be provided.","type":"string"}}},"CertificationPeriodRequest":{"type":"object","properties":{"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' must be provided.","type":"string"}}},"HealthServicePeriodSubscriberRequest":{"required":["subscriber"],"type":"object","properties":{"subscriber":{"description":"Identification of the subscriber according to the subscribers-Endpoint.","type":"string"},"externalId":{"description":"The identification of the health service in the system of the API consumer. <br />Validations:<ul><li>Must contain numbers only.</li></ul>","type":"string"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' must be provided.","type":"string"}}},"CertificationPeriodSubscriberRequest":{"type":"object","properties":{"subscriber":{"description":"Identification of the subscriber according to the subscribers-Endpoint.","type":"string"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' must be provided.","type":"string"}}},"ClearingNumberDetailViewItem":{"description":"A container for one specific clearing number and its context information.","type":"object","properties":{"syncDate":{"format":"date-time","description":"Contains the clearing number modification date.","type":"string"},"version":{"type":"string"},"clearingNumber":{"$ref":"#/definitions/ClearingNumber","description":"Contains a complete data set of a single clearing number (=Zahlstelle)."}}},"ClearingNumber":{"description":"The clearing number (=ZSR-Nummer) and its full context information. Every business of a care provider has a clearing number.","type":"object","properties":{"number":{"description":"The clearing number (=ZSR-Nummer) as plain text value.","type":"string"},"clearingNumberSuffix":{"$ref":"#/definitions/ClearingNumberSuffix","description":"The ClearingNumberSuffix (=StammKanton). This can be a swiss canton or any other regional entity."},"clearingNumberCompensations":{"description":"The list of clearing number compensation types (=Entschädigungscode) valid for this clearing number.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearingNumberCompensation"}},"clearingNumberLaws":{"description":"The list of clearing number law types (=Zulassung) applicable for this clearing number.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearingNumberLaw"}},"careProviderBusiness":{"$ref":"#/definitions/CareProviderBusiness","description":"The care provider business (=Zahlstelle) this clearing number belongs to."},"clearingNumberAccounts":{"description":"The account mapping details (=Konto). Despite multiple records for each moment in time only one active account exists.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearingNumberAccount"}},"clearingNumberDummy":{"$ref":"#/definitions/ClearingNumberDummy","description":"Marks the current clearing number as a special multi-purpose number, unrelated to any care provider."},"businessScope":{"$ref":"#/definitions/BusinessScope","description":"The business scope (=PartnerartObergruppe/-Untergruppe)."},"relatedClearingNumbers":{"description":"A mapping list of related clearing numbers. For every related clearing number, the type of relation is specified.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearingNumberRelation"}},"relatedEmployees":{"description":"A mapping list of employees of the care provider business, this clearing number belongs to.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/EmployeeRelation"}},"licenses":{"description":"A list of licenses (=Zulassung KVG/VVG/UVG) provided to this clearing number.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/License"}},"tariffSystems":{"description":"A mapping list of tariff systems (=Tarif-Verträge).","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearingNumberTariffSystem"}},"comments":{"description":"A list of comments regarding this clearing number.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearingNumberComment"}},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"ClearingNumberSuffix":{"description":"The clearing number suffix (=StammKanton). This can be a swiss canton or any other grouping entity.","type":"object","properties":{"name":{"description":"The region name","type":"string"},"canton":{"description":"When available the name of the swiss canton.","enum":["AG","AI","AR","BS","BL","BE","FR","GE","GL","GR","JU","LU","NE","NW","OW","SH","SZ","SO","SG","TG","TI","UR","VS","VD","ZG","ZH"],"type":"string"},"cantonTranslations":{"$ref":"#/definitions/Translation"},"suffixNumber":{"type":"string"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"ClearingNumberCompensation":{"description":"The mapping details for the clearing number compensation (Entschädigungscode).","type":"object","properties":{"clearingNumberCompensationType":{"description":"The clearing number compensation type.","enum":["UNKNOWN","AMB_T_GSTAT_TP","TIERS_GARANT","TIERS_PAYANT","CONTRACT_BASED_TIERS_PAYANT_OR_GARANT"],"type":"string"},"clearingNumberCompensationTypeTranslations":{"$ref":"#/definitions/Translation"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"ClearingNumberLaw":{"description":"The clearing number law (=Zulassung).","type":"object","properties":{"clearingNumberLawType":{"description":"The clearing number law type.","enum":["KVG_VVG","PARTIAL_KVG_VVG","VVG","UVG_MV_IV"],"type":"string"},"clearingNumberLawTypeTranslations":{"$ref":"#/definitions/Translation"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"CareProviderBusiness":{"description":"The care provider business (=Zahlstelle).","type":"object","properties":{"comment":{"description":"An optional comment value.","type":"string"},"isNotListedHospital":{"description":"The is not listed hospital flag (=Finanzierungsform)","type":"boolean"},"isInstitution36aKVG":{"description":"The KVG institution flag (=Einrichtung gemäss Art. 36a KVG)","type":"boolean"},"careProvider":{"$ref":"#/definitions/CareProvider","description":"The care provider (=Leistungserbringer) managing the business (=Zahlstelle)."},"careProviderBusinessParties":{"description":"The business party (=Personendaten). Despite multiple records for each moment in time only one active party exists.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CareProviderBusinessParty"}},"affiliatedCareProviderBusiness":{"$ref":"#/definitions/CareProviderBusiness","description":"Another busisness with a relation to this particular business."},"facilities":{"description":"A list of business facilities (=Einrichtung).","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CareProviderBusinessFacility"}},"healthServices":{"description":"A list of health services (=Zertifizierer Methoden) mapped to this particular business. For VVG businesses of complementary medicine only.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CareProviderHealthService"}},"affiliations":{"description":"A list of affiliations (=Mitgliedschaften) mapped to this particular business.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CareProviderAffiliation"}},"clearingNumbers":{"description":"A list of clearing numbers (=ZSR-Nummern).","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearingNumber"}},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"ClearingNumberAccount":{"description":"The mapping details for the clearing number bank account (=Konto).","type":"object","properties":{"account":{"$ref":"#/definitions/Account","description":"The bank account."},"hasPaymentOrderReferenceNumber":{"description":"Marks the current account mapping available for ESR payments.","type":"boolean"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"ClearingNumberDummy":{"description":"The clearing number dummy (=ZSR-Nummer).","type":"object","properties":{"name":{"description":"The clearing number dummy name.","type":"string"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"BusinessScope":{"description":"The business scope devided into parent business scope (=PartnerartObergruppe) and sub business scope (=PartnerartUntergruppe).","type":"object","properties":{"name":{"description":"The business scope's name.","type":"string"},"parentBusinessScope":{"$ref":"#/definitions/BusinessScope","description":"The optional parent business scope (=PartnerartObergruppe). Available for sub business scopes only (=PartnerartUntergruppe)."},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"ClearingNumberRelation":{"description":"The mapping details for the clearing number relation (=Zugeordnete Zahlstellen, Zusätzliche Zahlstellen).","type":"object","properties":{"clearingNumber":{"description":"The related clearing number.","type":"string"},"isPublished":{"description":"The is active flag.","type":"boolean"},"clearingNumberRelationType":{"description":"The relation type (=Beziehungsart).","enum":["CHANGE_OF_REGION","CHANGE_OF_PRIMARY_BUSINESS_SCOPE","MERGER","TERMINATION_OF_ACTIVITY","CHANGE_OF_ACTIVITY","CHANGE_OF_HANDS","SECOND_CLEARING_NUMBER_INCLUSIVE_SUSPENSIONS","CHANGE_OF_SECONDARY_BUSINESS_SCOPE","COMPLEMENTARY_CARE_PROVIDER_MERGER","FITNESS_CARE_PROVIDER_MERGER","INVALID_MAPPING","MULTIPLE_LOCATIONS","MAIN_CLEARING_NUMBER","UNKNOWN"],"type":"string"},"clearingNumberRelationTypeTranslations":{"$ref":"#/definitions/Translation"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"EmployeeRelation":{"description":"The mapping details for the employee mapping (=Arbeitnehmer/Angestellte).","type":"object","properties":{"employeeNumber":{"description":"The employee number (=KNummer).","type":"string"},"isPublished":{"description":"The is active flag.","type":"boolean"},"employmentType":{"description":"The employment type (=Anstellungstyp)","enum":["REGULAR","EXECUTIVE"],"type":"string"},"license":{"$ref":"#/definitions/License","description":"The canton based license (=Zulassung)."},"employmentTypeTranslations":{"$ref":"#/definitions/Translation"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"License":{"description":"The canton based license (=Zulassung) including restrictions for this license.","type":"object","properties":{"licenseState":{"description":"The licensing state.","enum":["PENDING","APPROVED","DECLINED"],"type":"string"},"licenseStateTranslations":{"$ref":"#/definitions/Translation"},"canton":{"description":"When available the name of the swiss canton.","enum":["AG","AI","AR","BS","BL","BE","FR","GE","GL","GR","JU","LU","NE","NW","OW","SH","SZ","SO","SG","TG","TI","UR","VS","VD","ZG","ZH"],"type":"string"},"cantonTranslations":{"$ref":"#/definitions/Translation"},"country":{"$ref":"#/definitions/Country","description":"The country."},"licenseRestrictions":{"description":"License restrictions (=Beschränkung, Sistierung, Sperrung, Ausstand).","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/LicenseRestriction"}},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"ClearingNumberTariffSystem":{"description":"The mapping details for the tarifs system (=Tarif-Verträge, Spitallaboratorium etc.).","type":"object","properties":{"tariffSystem":{"$ref":"#/definitions/TariffSystem","description":"The tarif system."},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"ClearingNumberComment":{"description":"The clearing number specific comment.","type":"object","properties":{"commentTranslations":{"$ref":"#/definitions/Translation","description":"Comment translations."},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"Translation":{"type":"object","properties":{"de":{"type":"string"},"fr":{"type":"string"},"it":{"type":"string"}}},"CareProvider":{"description":"The careprovider (=Leistungserbringer).","type":"object","properties":{"comment":{"description":"An optional comment value.","type":"string"},"careProviderParties":{"description":"The care provider party (=Personendaten). Despite multiple records for each moment in time only one active party exists.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CareProviderParty"}},"healthServices":{"description":"The care provider health service mappings (=Zertifizierer Methoden). For VVG care providers of complementary medicine only. When provided by external certifiers this list might contain multiple health service mappings for the same health service, but with diverging validity periods.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CareProviderHealthService"}},"qualifications":{"description":"The care provider qualification mappings (=Qualifikationen).","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CareProviderQualification"}},"affiliations":{"description":"The care provider affiliation mappings (=Mitgliedschaften)","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CareProviderAffiliation"}},"careProviderBusinesses":{"description":"The care provider businesses (=Zahlstellen). A care provider can manage multiple businesses.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/CareProviderBusiness"}},"employeeNumbers":{"description":"The care provider employee number (=KNummer). For all employed OKP care providers.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/EmployeeNumber"}},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"CareProviderBusinessParty":{"description":"The mapping details for a business party (=Personendaten). For each point in time only one active mapping should exist.","type":"object","properties":{"party":{"$ref":"#/definitions/PartyBusiness","description":"The party (=Zahlstellen-Adresse)"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"CareProviderBusinessFacility":{"description":"The mapping details for a business facilities (=Einrichtungen).","type":"object","properties":{"details":{"description":"Additional information for the assigned facility, e.g. bed count (=Anzahl Betten).","type":"string"},"facility":{"$ref":"#/definitions/Facility","description":"The facility (=Einrichtung)."},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"CareProviderHealthService":{"description":"The mapping details for care provider health services (=Zertifizierer Methoden).","type":"object","properties":{"healthService":{"$ref":"#/definitions/HealthService","description":"The health service (=Zertifzierer Methode)."},"healthServiceCantonMandate":{"$ref":"#/definitions/HealthServiceCantonMandate"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"CareProviderAffiliation":{"description":"The care provider affiliation.","type":"object","properties":{"externalId":{"description":"The care provider membership id (=Mitgliedernummer).","type":"string"},"affiliationBroker":{"description":"The affiliation broker. The institution providing the affiliation to the care provider.","enum":["TARIF_SUISSE","ASPI","PHYSIO_SWISS"],"type":"string"},"affiliationBrokerTranslations":{"$ref":"#/definitions/Translation"},"affiliation":{"$ref":"#/definitions/Affiliation","description":"The affiliation (=Verband etc.)."},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"Account":{"description":"The bank account.","type":"object","properties":{"ibanNumber":{"description":"The IBAN number.","type":"string"},"accountNumber":{"description":"The account number (=Kontonummer).","type":"string"},"party":{"$ref":"#/definitions/PartyBeneficiary","description":"Optionally contains the account holder (=Begünstigter) when not identical to the care provider (=Leistungserbringer)."},"bank":{"$ref":"#/definitions/Bank","description":"The account's bank."},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"Country":{"description":"The country (=Land).","type":"object","properties":{"name":{"description":"The country name.","type":"string"},"twoLetterCountryCode":{"description":"The ISO 3166-1 alpha-2 two letter country code.","type":"string"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"LicenseRestriction":{"description":"License restrictions (=Beschränkung, Sistierung, Sperrung, Ausstand).","type":"object","properties":{"licenseRestrictionType":{"description":"License restriction type (=Beschränkungstyp).","enum":["UNKNOWN","NINETY_DAY_REGULATION","REGION","ACTIVITY","SUSPENSION","ADMISSION_MUTATION_LOCK","OKP_EXCLUSION"],"type":"string"},"licenseRestrictionTypeTranslations":{"$ref":"#/definitions/Translation"},"licenseRestrictionReasonType":{"description":"License restriction reason type (=Beschränkungsgrund).","enum":["UNKNOWN","TERMINATION_OF_ACTIVITY","REVOCATION_OF_BA_B_LICENSE","CHANGE_OF_LOCATION","TERMINATION_BY_DEATH","CARE_PROVIDER_MERGER","CHANGE_OF_HANDS","OUT_OF_CONTRACT","CHANGE_OF_REGION","CHANGE_OF_BUSINESS_SCOPE","MISSING_CERTIFICATION","COMPLEMENTARY_CARE_PROVIDER_MERGER","UNPAYED_SERVICE_FEE"],"type":"string"},"licenseRestrictionReasonTypeTranslations":{"$ref":"#/definitions/Translation"},"reason":{"description":"Licsense restriction reason (=Beschränkungstext).","type":"string"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"TariffSystem":{"description":"The tarif system.","type":"object","properties":{"tariffSystemType":{"description":"The tariff system type.","enum":["LOA","NURSING_HOME_FLAT_RATE"],"type":"string"},"tariffSystemTypeTranslations":{"$ref":"#/definitions/Translation"},"name":{"description":"The tariff name.","type":"string"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"CareProviderParty":{"description":"The mapping details for a care provider party (=Personendaten). For each point in time only one active mapping should exist.","type":"object","properties":{"party":{"$ref":"#/definitions/PartyCareProvider","description":"The care provider party (=Privatadresse)."},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"CareProviderQualification":{"description":"The mapping details for care provider qualifications (=Qualifikationen).","type":"object","properties":{"country":{"$ref":"#/definitions/Country","description":"The country (=Land) where the qualification has been attained."},"qualification":{"$ref":"#/definitions/Qualification","description":"The qualification (=Qualifikation)."},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"EmployeeNumber":{"description":"The employee number (=KNummer).","type":"object","properties":{"number":{"description":"The employee number (=KNummer).","type":"string"},"careProvider":{"$ref":"#/definitions/CareProvider","description":"The care provider (=Leistungserbringer)."},"businessScope":{"$ref":"#/definitions/BusinessScope","description":"The business scope (=PartnerartObergruppe/-Untergruppe)."},"relatedEmployers":{"description":"A mapping list of employers.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/EmployerRelation"}},"licenses":{"description":"A list of licenses (=Zulassung KVG/VVG/UVG).","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/License"}},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"PartyBusiness":{"type":"object","properties":{"globalLocationNumber":{"type":"string"},"branch":{"type":"string"},"contact":{"$ref":"#/definitions/Contact","description":"The party contact details."},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"Facility":{"description":"The business facility (=Einrichtung).","type":"object","properties":{"facilityType":{"description":"The facility type.","enum":["HOSPITAL_LAB_TYPE","HOSPITAL_LAB_INFRASTRUCTURE","FITNESS_CLASSIFICATION","FITNESS_QUALITOP_FIT_SAFE","DOCTOR_FACILITY","HOSPITAL_FACILITY","NURSING_HOME_FACILITY","FITNESS_CARE_LEVEL"],"type":"string"},"facilityTypeTranslation":{"$ref":"#/definitions/Translation"},"name":{"description":"The facility name.","type":"string"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"HealthService":{"description":"The certifier health service (=Zertifizierer-Methode).","type":"object","properties":{"name":{"description":"The health service name.","type":"string"},"nameTranslations":{"$ref":"#/definitions/Translation","description":"Name translations"},"externalId":{"description":"The certifier / lea health service identifier.","type":"string"},"affiliation":{"$ref":"#/definitions/Affiliation","description":"The health service affiliation, e.g. EMR, ASCA etc."},"comments":{"description":"Health service comments","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/HealthServiceComment"}},"healthServiceGroup":{"$ref":"#/definitions/HealthServiceGroup","description":"Health service group (LEA Leistungsbereich, Leistungsgruppe)"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"HealthServiceCantonMandate":{"description":"The hospital health service canton mandat (=LeaDatModellKantonEinschraenkung).","type":"object","properties":{"canton":{"enum":["AG","AI","AR","BS","BL","BE","FR","GE","GL","GR","JU","LU","NE","NW","OW","SH","SZ","SO","SG","TG","TI","UR","VS","VD","ZG","ZH"],"type":"string"},"name":{"type":"string"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"Affiliation":{"description":"An affiliation in an organisation (=Mitgliedschaft).","type":"object","properties":{"name":{"description":"The affiliation name (=Verbandscode usf.). E.g. an organization code.","type":"string"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"PartyBeneficiary":{"type":"object","properties":{"globalLocationNumber":{"type":"string"},"firm":{"type":"string"},"branch":{"type":"string"},"abbreviation":{"type":"string"},"contact":{"$ref":"#/definitions/Contact","description":"The party contact details."},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"Bank":{"description":"The SIX bank details.","type":"object","properties":{"bankGroup":{"description":"The banks/financial institutions are divided into bank groups.","enum":["SNB","UBSAG","RESERVE","CREDIT_SUISSE_GROUP_AG_1","CREDIT_SUISSE_GROUP_AG_2","REGIONALBANKEN_RBA_HOLDING_AG","KANTONALBANKEN","RAIFFEISENBANKEN_EINZELINSTITUTE","POST_FINANCE"],"type":"string"},"bankGroupTranslation":{"$ref":"#/definitions/Translation"},"bankClearingType":{"description":"The bank type, e.g. head office, main branch or branch.","enum":["HEAD_QUARTERS","MAIN_BRANCH","BRANCH"],"type":"string"},"bankClearingTypeTranslations":{"$ref":"#/definitions/Translation"},"bankingClearingNumber":{"description":"Each bank/financial institution is identified by the BankingClearingNumber made up of 3 to 5 digits.","type":"string"},"bankingClearingNumberNew":{"description":"Any value here replaces the BankingClearingNumber.","type":"string"},"branchId":{"description":"Together with the BankingClearingNumber number the BranchId provides a conclusive key for each bank or financial institution record.","type":"string"},"sicNumber":{"description":"A 6-digit number only to be used by SIC and euroSIC participants.","type":"string"},"headquarterClearingNumber":{"description":"The BankingClearingNumber of the head office.","type":"string"},"shortName":{"description":"The short name of the bank or financial institution.","type":"string"},"name":{"description":"The name of the bank or financial institution","type":"string"},"postalAccountNumber":{"description":"The bank's or financial institution's postal account number.","type":"string"},"swift":{"description":"The SWIFT directory entry value.","type":"string"},"contact":{"$ref":"#/definitions/Contact","description":"The bank's or financial institution's contact details."},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"PartyCareProvider":{"type":"object","properties":{"legalFormType":{"enum":["UNKNOWN","SOLE_PROPRIETORSHIP","GENERAL_PARTNERSHIP","CORPORATION","LIMITED_LIABILITY_COMPANY","COOPERATIVE","ASSOCIATION","FOUNDATION","PUBLIC_SECTOR_INSTITUTION","BRANCH","LIMITED_PARTNERSHIP","FOREIGN_BRANCH","CORPORATION_WITH_UNLIMITED_PARTNERS","AFFILIATION","LIMITED_COMPANY","NON_PROFIT_LIMITED_LIABILITY_COMPANY"],"type":"string"},"legalFormTypeTranslations":{"$ref":"#/definitions/Translation"},"organizationIdentificationNumber":{"type":"string"},"contact":{"$ref":"#/definitions/Contact","description":"The party contact details."},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"Qualification":{"description":"The qualification (=Qualifikation).","type":"object","properties":{"qualificationType":{"description":"The qualification type.","enum":["DIPLOMA","CERTIFICATE","CONTINUING_EDUCATION_CERTIFICATE","EXPERTISE_AREA","SKILLS","ADMISSION","ADDITIONAL_CERTIFICATE","PROFICIENCY_TEST"],"type":"string"},"qualificationTypeTranslations":{"$ref":"#/definitions/Translation"},"name":{"description":"The qualification name.","type":"string"},"affiliation":{"$ref":"#/definitions/Affiliation","description":"The health service affiliation, e.g. FMH etc."},"businessScope":{"$ref":"#/definitions/BusinessScope","description":"The business scope (=PartnerartObergruppe/-Untergruppe)."},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"EmployerRelation":{"description":"The mapping details for the employer mapping (=Arbeitgeber).","type":"object","properties":{"clearingNumber":{"description":"The clearing number (=ZSR-Nummer).","type":"string"},"isPublished":{"description":"The is active flag.","type":"boolean"},"employmentType":{"description":"The employment type (=Anstellungstyp)","enum":["REGULAR","EXECUTIVE"],"type":"string"},"license":{"$ref":"#/definitions/License","description":"The canton based license (=Zulassung)."},"employmentTypeTranslations":{"$ref":"#/definitions/Translation"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"Contact":{"description":"The person's contact details.","type":"object","properties":{"language":{"description":"The language to be used when communicating with this person.","enum":["DE","FR","IT"],"type":"string"},"languageTranslations":{"$ref":"#/definitions/Translation"},"url":{"description":"A pointer to a relevant url, e.g. business homepage.","type":"string"},"postalAddress":{"$ref":"#/definitions/PostalAddress","description":"The postal address."},"phoneNumbers":{"description":"The phone numbers.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/PhoneNumber"}},"emailAddresses":{"description":"The email addresses.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"HealthServiceComment":{"description":"The health service specific comment.","type":"object","properties":{"commentTranslations":{"$ref":"#/definitions/Translation","description":"Comment translations."},"isExcluded":{"description":"Whether the health service is excluded.","type":"boolean"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"HealthServiceGroup":{"description":"The health service group (=LEA-Leistungsbereich/-Leistungsgruppe).","type":"object","properties":{"externalId":{"description":"Health service group external id (LEA-Leistungsbereich/-Leistungsgruppe abbreviation)","type":"string"},"parentExternalId":{"description":"The parent health service group external id (LEA-Leistungsbereich abbreviation)","type":"string"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"PostalAddress":{"description":"The postal address (=Postadresse).","type":"object","properties":{"postOfficeBoxText":{"description":"Post office box text.","type":"string"},"postOfficeBoxNumber":{"format":"int32","description":"Post office box number.","type":"integer"},"street":{"description":"The street with street number (=Strasse).","type":"string"},"addressAddition":{"description":"The address addition (=Adresszusatz).","type":"string"},"place":{"description":"The place/city (=Ort).","type":"string"},"postalCode":{"description":"The postal code, national and international (=PLZ).","type":"string"},"country":{"$ref":"#/definitions/Country","description":"The country."},"canton":{"description":"When available the name of the swiss canton.","enum":["AG","AI","AR","BS","BL","BE","FR","GE","GL","GR","JU","LU","NE","NW","OW","SH","SZ","SO","SG","TG","TI","UR","VS","VD","ZG","ZH"],"type":"string"},"cantonTranslations":{"$ref":"#/definitions/Translation"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"PhoneNumber":{"description":"The phone number.","type":"object","properties":{"phoneNumberType":{"description":"The phone number type.","enum":["LANDLINE","MOBILE","FAX"],"type":"string"},"phoneNumberTypeTranslations":{"$ref":"#/definitions/Translation"},"number":{"description":"The phone number, formatted as E.164.","type":"string"},"country":{"$ref":"#/definitions/Country","description":"The phone number country."},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"EmailAddress":{"description":"The email address.","type":"object","properties":{"email":{"description":"The email address.","type":"string"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"EmployeeNumberDetailViewItem":{"description":"A container for one specific employee number and its context information.","type":"object","properties":{"syncDate":{"format":"date-time","description":"Contains the employee number modification date.","type":"string"},"version":{"type":"string"},"employeeNumber":{"$ref":"#/definitions/EmployeeNumber","description":"Contains a complete data set of a single employee number (=KNummer)."}}},"HealthServiceCommentViewItem":{"description":"One specific comment entry on a health service.","type":"object","properties":{"healthServiceId":{"format":"int64","description":"The internal health service id.","type":"integer"},"healthServiceExternalId":{"description":"The identification of the health service in the system of the API consumer as provided with the CareProviderCertification endpoint.","type":"string"},"certifier":{"description":"The certifier name.","type":"string"},"healthServiceTranslations":{"$ref":"#/definitions/Translation","description":"The health service name in different languages."},"commentTranslations":{"$ref":"#/definitions/Translation","description":"The health service comment in different languages."},"isExcluded":{"description":"Marks a health service as excluded/unsupported by an insurer.","type":"boolean"},"startDate":{"format":"date-time","description":"Date of the validity start (=fachliches Startdatum). Time information will be ignored. Validity starts at the beginning of the specified day.","type":"string"},"endDate":{"format":"date-time","description":"Date of the validity end (=fachliches Enddatum). Time information will be ignored. Validity ends at the end of the specified day. If the period lasts indefinitely, the max date '9999-12-31 23:59:59.9999999' is used.","type":"string"},"id":{"format":"int64","description":"Unique identifier of the instance.","type":"integer"}}},"StringBulkResponse":{"description":"A response container for a list of string values.","type":"object","properties":{"tookInMs":{"format":"int32","description":"Request processing time in milliseconds.","type":"integer"},"totalCount":{"format":"int32","description":"Overall, paging-independently count of entries according to the specified parameters.","type":"integer"},"recordCount":{"format":"int32","description":"Number of records in the current page.","type":"integer","readOnly":true},"offset":{"format":"int32","description":"The applied offset value.","type":"integer"},"limit":{"format":"int32","description":"The applied limit value.","type":"integer"},"records":{"description":"The records of the current page.","uniqueItems":false,"type":"array","items":{"type":"string"}}}},"NumberListViewItem":{"description":"A response container for a list of consolidated basic number (clearing or employee number) information.","type":"object","properties":{"syncDate":{"format":"date-time","description":"Contains the employee number modification date.","type":"string"},"number":{"description":"The number (clearing or employee number) itself.","type":"string"},"globalLocationNumber":{"description":"Global location number (=EANNummer).","type":"string"},"organizationIdentificationNumber":{"description":"Organization identification number (=UID-Nummer/IDE/IDI).","type":"string"},"firm":{"description":"The firm (=Firma).","type":"string"},"branch":{"description":"The branch name (=Zweigstelle).","type":"string"},"givenName":{"description":"Given name / first name (=Vorname).","type":"string"},"callName":{"description":"Call name (=Rufname).","type":"string"},"familyName":{"description":"Family name / last name (=Nachname).","type":"string"},"originalName":{"description":"Orginal name (=Ledigenname).","type":"string"},"postalCode":{"description":"The postal code, national and international (=PLZ).","type":"string"},"place":{"description":"The place/city (=Ort).","type":"string"},"street":{"description":"The street with street number (=Strasse).","type":"string"},"phoneNumber":{"description":"An E.164 phone number.","type":"string"},"isValid":{"description":"Is true, if the instance was valid at the requested validityDate. If no specific validityDate was specified, then the current date (now) is evaluated (=fachliche Gültigkeit zum Zeitpunkt des übergebenen Stichdatums).","type":"boolean"},"detailViewItemUrl":{"description":"Resource URL to retrieve further details regarding this number.","type":"string"},"clearingNumberSuffixTwoLetterCantonCode":{"type":"string"},"clearingNumberSuffixTranslations":{"$ref":"#/definitions/Translation"}}},"ProposalProcessResponse":{"type":"object","properties":{"id":{"format":"int64","type":"integer"},"businessKey":{"type":"string"},"typeName":{"type":"string"},"version":{"type":"string"},"processInstanceId":{"type":"string"},"processState":{"type":"string"},"processInformation":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"proposalResponse":{"$ref":"#/definitions/ProposalResponse","description":"The proposal"},"errors":{"description":"The proposal errors","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ProposalError"}}}},"ProposalResponse":{"type":"object","properties":{}},"ProposalError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}}}},"securityDefinitions":{"Bearer":{"name":"Authorization","in":"header","type":"apiKey","description":"JWT Authorization header using the Bearer scheme. Example:\"Authorization:Bearer {token}\""}},"security":[{"Bearer":[]}]}

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

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

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

<div class="references">

</div>

        /// <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;
            }
        }

        /// <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;
            }
        }

        /// <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;
        }

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

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

<div class="references">

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

https://openid.net/connect/