Welcome to the gematik Developer Portal pilot. Currently featuring the VSDM 2.0 API, this portal gives you interactive documentation, a mock server, contract testing, and code generation β everything you need to integrate with the Telematikinfrastruktur. More APIs will follow based on your feedback.
From interactive API exploration to contract testing and automated quality gates β everything you need to build reliable TI integrations.
Explore the VSDM2 API with interactive documentation powered by SwaggerHub. Try endpoints directly in the browser, use the built-in mock server, and generate client code in your preferred language.
Validate your integrations against official gematik API contracts using Pact. Publish your consumer contracts to our PactFlow broker and get automated compatibility verification against the provider.
Behind the scenes, our automated API lifecycle pipeline ensures every published API meets strict quality standards β from FHIR source to validated OpenAPI specification.
This pilot currently features the VSDM 2.0 API. More APIs will be added based on your feedback. Here's how to get the most out of each tool.
The API Portal contains all API descriptions generated and validated by our toolchain. Currently it features the VSDM 2.0 pilot project. The portal provides:
The code generator has been tested for Java, C# and TypeScript. You can also integrate the openapi-generator into your own codebase to generate HTTP clients and model classes. This reduces manual implementation effort on the client side and ensures consistent API usage. If you experience issues or would like us to test additional languages, please let us know!
Every time a new VSDM2 FHIR specification is published, our CI/CD pipeline automatically generates an updated OpenAPI specification. Two variants are available:
The ZETA-Guard to Resource Server interface, including all HTTP headers required for access via the ZETA Guard. Use this for understanding the full TI 2.0 interface requirements and building API routing without the ZETA SDK.
View on API Portal βThe pure Client to ZETA-Guard interface without the ZETA overlay. Use this for preparing and validating payloads to be processed by the ZETA SDK.
View on API Portal βUse Pact, an open-source contract testing framework, to validate service interactions without relying on complex end-to-end tests. Recommended workflow:
See the Java example implementation and the VsdmClientServicePactTest in our TestHub for a consumer-side Pact test reference.
Contact us with your desired application name for the Pact Broker. We will provide you with two API tokens: a Read/Write token for your CI/CD pipelines and a Read-Only token for reports and dashboards.
CONTRACT_BROKER_URL=https://gematik.pactflow.io
APP_NAME=my-application-name
Upload your generated pact.json (Base64-encoded) using the following parameters.
The possible values for PROVIDER_APPLICATION_NAME are:
vsdm2-zeta-gematik-reference β VSDM2 with ZETA overlayvsdm2-gematik-reference β VSDM2 without ZETA overlayAPP_VERSION=v1.0.0 # use Semantic Versioning
APP_BRANCH=main # optional
APP_BUILD_URL=https://ci.example.org/build/123 # optional
PROVIDER_APPLICATION_NAME=vsdm2-zeta-gematik-reference
The generated pact.json file must be Base64-encoded before uploading:
PACT_B64=$(base64 -w 0 pact.json)
curl -X POST "$CONTRACT_BROKER_URL/contracts/publish" \
-H "Content-Type: application/json" \
-H "Accept: application/hal+json" \
-H "Authorization: Bearer <API_KEY_READ_WRITE>" \
-d '{
"pacticipantName": "'$APP_NAME'",
"pacticipantVersionNumber": "v1.0.0",
"branch": "main",
"contracts": [{
"consumerName": "'$APP_NAME'",
"providerName": "vsdm2-zeta-gematik-reference",
"content": "'$PACT_B64'",
"contentType": "application/json",
"specification": "pact"
}]
}'
We value your feedback! This portal is in its pilot phase. If you encounter issues, need additional language support for code generation, or have suggestions for improvement, please let us know.
From specifications to code examples β find all the resources you need in one place.
Explore our open source repositories organized by category β from reference implementations to testing tools.
Explore repositories βSpecifications, guidelines, concepts, profiles, implementation guides, and draft publications for the TI.
gemspec.gematik.de βFHIR profiles, packages, and project specifications hosted on Simplifier.net.
View on Simplifier βAccess the reference environment (RU) for testing your integrations.
Learn more βConnect with developers, ask questions, and share your experiences.
gemmunity.de βTechnical deep dives, engineering insights, and behind-the-scenes from gematik.
Read the blog βFind FHIR profiles, API documentation, and specifications for the projects relevant to the VSDM2.0 pilot project. Use this table to jump directly to the right place.
| Project | IG / API Docs | FHIR Profiles (Packages) | Specification |
|---|---|---|---|
| Versichertenstammdatenmanagement 2.0 (VSDM 2.0) | spec-VSDM2 (GitHub) | VSDM2 | gemSpec_VSDM_2 |
| Zero Trust Access (ZETA) | zeta (GitHub) | β | gemSpec ZETA |
| Proof of Patient Presence (PoPP)-Service | api-popp-service (GitHub) | β | gemSpec_PoPP_Service |
The gematik developer ecosystem extends across multiple platforms. Here's where to find what you need.
General information about gematik and the TI
Technical information and services for the TI
Interoperability navigator for digital medicine
Live status and monitoring of all TI services
Upcoming milestones and planned TI developments
Subscribe to the gematik newsletter for updates
Dive into the Developer Portal and start integrating with the Telematikinfrastruktur today. Access APIs, run contract tests, and ship with confidence.