Digitaler-Impfnachweis / certification-apis

API Documentation
Apache License 2.0
169 stars 46 forks source link

Certification API Documentation

This repository contains documentation about certification endpoints and related flows for authentication and authorization to be integrated with information systems of physicians, pharmacies and vaccination centers.

The interface specifications are aligned with the DGC schema specification published in version 1.3.2.

OpenAPI Specifications

Integration scenarios

The following table illustrates how the solution can be integrated into existing solutions:

Scenario Description
1. Medical Practitioner office Solution is integrated in the primary IT solution of the doctor. Solution is connected to the Telematik Infrastructure and leverages the SMC-B as primary authentication solution.
2. Vaccination Center Solution is integrated in the primary IT solution of the vaccination center. Solution is connected to the internet and leverages client-certificate authentication. Software solution is required to have a strong user authentication based on BSI req. like hardware-tokens and user credentials

Authentication

In order to use the mentioned APIs different authentication options exist.

Implementation

Please refer to Implementation for an extensive certificate schema description.

Additional Information

For implementors the official documentation of the Digital Green Certificate can be found on the EU eHealth Network page.

Print Templates

See the templates subdirectory for ready to use SVG templates.

Copyright

Copyright (C) 2021 IBM Deutschland GmbH 
Copyright (C) 2021 ubirch GmbH

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.