Health Device Data Transfer
Version 1.0.0-rc2 - release

Specification of health data transfer from devices to DiGA (§ 374a SGB V)

Authorization Server Metadata Endpoint

Seiteninhalt:

Introduction

This document describes the /.well-known/oauth-authorization-server endpoint for retrieving the OAuth 2.0 Authorization Server Metadata. The metadata document provides information about the Authorization Server configuration, including supported endpoints, grant types, and security mechanisms. This endpoint is public and does not require authentication.

Endpoint

   
Endpoint /.well-known/oauth-authorization-server
HTTP Method GET
Description Provides an OAuth 2.0 Authorization Server Metadata Document with information about supported endpoints, grant types, scopes, and other capabilities.
Authentication None (public endpoint)
Returned Objects OAuth 2.0 Authorization Server Metadata Document (JSON) which MUST include at least the following attributes:
• scopes_supported (according to SMART Scope definitions)
• grant_types_supported = authorization_code
• pushed_authorization_request_endpoint
• require_pushed_authorization_requests = true
• token_endpoint
• token_endpoint_auth_methods_supported = tls_client_auth
• revocation_endpoint
• revocation_endpoint_auth_methods_supported = tls_client_auth
• code_challenge_methods_supported = S256
• tls_client_certificate_bound_access_tokens = false
• service_documentation (client registration info).
Specifications • MUST comply with RFC 8414.
• MUST declare Authorization Code as the supported grant type and PKCE S256 as the code challenge method.
• MUST declare Pushed Authorization Requests (PAR) and set require_pushed_authorization_requests to true.
• MUST declare Mutual-TLS client auth (tls_client_auth) for the token and revocation endpoints.
• MUST declare revocation endpoint and its auth methods.
• MUST publish supported SMART scopes (MIV-specific).
• MUST publish tls_client_certificate_bound_access_tokens: false (certificate-bound access tokens MUST NOT be used).
• SHOULD publish service_documentation (client registration information).
Error codes 500 (Internal Server Error)

Example

Request:

curl -X GET "https://himi.example.com/.well-known/oauth-authorization-server" \
     -H "Accept: application/json"

Response (example):

{
  "issuer": "https://himi.example.com",
  "authorization_endpoint": "https://himi.example.com/authorize",
  "token_endpoint": "https://himi.example.com/token",
  "revocation_endpoint": "https://himi.example.com/revoke",
  "pushed_authorization_request_endpoint": "https://himi.example.com/par",
  "response_types_supported": [
    "code"
  ],
  "grant_types_supported": [
    "authorization_code",
    "refresh_token"
  ],
  "code_challenge_methods_supported": [
    "S256"
  ],
  "token_endpoint_auth_methods_supported": [
    "tls_client_auth"
  ],
  "revocation_endpoint_auth_methods_supported": [
    "tls_client_auth"
  ],
  "require_pushed_authorization_requests": true,
  "request_parameter_supported": false,
  "tls_client_certificate_bound_access_tokens": false,
  "scopes_supported": [
    "patient/Observation.rs?code:in=https://gematik.de/fhir/hddt/ValueSet/hddt-miv-blood-glucose-measurement",
    "patient/Device.rs",
    "patient/DeviceMetric.rs"
  ],
  "service_documentation": "https://himi.example.com/docs/client-registration"
}