Implementation Guide
ePA Basisfunktionalitäten
Version 1.2.0-ballot.1 - draft

: EPA Basic Client - TTL Representation

Draft as of 2025-08-01

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:CapabilityStatement ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "epa-basic-client"] ; # 
  fhir:meta [
    ( fhir:profile [
fhir:v "https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"^^xsd:anyURI ;
fhir:link <https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement>     ] )
  ] ; # 
  fhir:extension ( [
    ( fhir:extension [
fhir:url [ fhir:v "name"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "X-Request-ID"       ]     ] [
fhir:url [ fhir:v "type"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "string"       ]     ] [
fhir:url [ fhir:v "description"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "UUID of the request message"       ]     ] [
fhir:url [ fhir:v "format"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "uuid"       ]     ] [
fhir:url [ fhir:v "required"^^xsd:anyURI ] ;
fhir:value [
a fhir:boolean ;
fhir:v false       ]     ] ) ;
fhir:url [ fhir:v "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"^^xsd:anyURI ]
  ] [
    ( fhir:extension [
fhir:url [ fhir:v "name"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "x-insurantid"       ]     ] [
fhir:url [ fhir:v "type"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "string"       ]     ] [
fhir:url [ fhir:v "description"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "Health Record Identifier"       ]     ] [
fhir:url [ fhir:v "pattern"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "^[A-Z]{1}\\d{9}$"       ]     ] [
fhir:url [ fhir:v "required"^^xsd:anyURI ] ;
fhir:value [
a fhir:boolean ;
fhir:v true       ]     ] ) ;
fhir:url [ fhir:v "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"^^xsd:anyURI ]
  ] [
    ( fhir:extension [
fhir:url [ fhir:v "name"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "x-useragent"       ]     ] [
fhir:url [ fhir:v "type"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "string"       ]     ] [
fhir:url [ fhir:v "description"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "user agent information"       ]     ] [
fhir:url [ fhir:v "pattern"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "^[a-zA-Z0-9]{20}\\/[a-zA-Z0-9\\-\\.]{1,15}$"       ]     ] [
fhir:url [ fhir:v "required"^^xsd:anyURI ] ;
fhir:value [
a fhir:boolean ;
fhir:v true       ]     ] ) ;
fhir:url [ fhir:v "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"^^xsd:anyURI ]
  ] [
    ( fhir:extension [
fhir:url [ fhir:v "statusCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "403"       ]     ] [
fhir:url [ fhir:v "description"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "Requestor not authorized (no user session with valid ID-Token available)"       ]     ] [
fhir:url [ fhir:v "responseType"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "application/json"       ]     ] [
fhir:url [ fhir:v "errorCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "invalAuth"       ]     ] ) ;
fhir:url [ fhir:v "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"^^xsd:anyURI ]
  ] [
    ( fhir:extension [
fhir:url [ fhir:v "statusCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "403"       ]     ] [
fhir:url [ fhir:v "description"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "Requestor has no valid entitlement"       ]     ] [
fhir:url [ fhir:v "responseType"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "application/json"       ]     ] [
fhir:url [ fhir:v "errorCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "notEntitled"       ]     ] ) ;
fhir:url [ fhir:v "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"^^xsd:anyURI ]
  ] [
    ( fhir:extension [
fhir:url [ fhir:v "statusCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "403"       ]     ] [
fhir:url [ fhir:v "description"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "Requestor role is not in the list of allowed user groups"       ]     ] [
fhir:url [ fhir:v "responseType"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "application/json"       ]     ] [
fhir:url [ fhir:v "errorCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "invalidOid"       ]     ] ) ;
fhir:url [ fhir:v "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"^^xsd:anyURI ]
  ] [
    ( fhir:extension [
fhir:url [ fhir:v "statusCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "403"       ]     ] [
fhir:url [ fhir:v "description"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "Device registration does not exist (if requestor role is oid_versicherter only)"       ]     ] [
fhir:url [ fhir:v "responseType"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "application/json"       ]     ] [
fhir:url [ fhir:v "errorCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "unregisteredDevice"       ]     ] ) ;
fhir:url [ fhir:v "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"^^xsd:anyURI ]
  ] [
    ( fhir:extension [
fhir:url [ fhir:v "statusCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "404"       ]     ] [
fhir:url [ fhir:v "description"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "Health record is in state UNKNOWN or INITIALIZED"       ]     ] [
fhir:url [ fhir:v "responseType"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "application/json"       ]     ] [
fhir:url [ fhir:v "errorCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "noHealthRecord"       ]     ] ) ;
fhir:url [ fhir:v "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"^^xsd:anyURI ]
  ] [
    ( fhir:extension [
fhir:url [ fhir:v "statusCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "409"       ]     ] [
fhir:url [ fhir:v "description"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "Health record is in state SUSPENDED or MAINTENANCE"       ]     ] [
fhir:url [ fhir:v "responseType"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "application/json"       ]     ] [
fhir:url [ fhir:v "errorCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "statusMismatch"       ]     ] ) ;
fhir:url [ fhir:v "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"^^xsd:anyURI ]
  ] [
    ( fhir:extension [
fhir:url [ fhir:v "statusCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "500"       ]     ] [
fhir:url [ fhir:v "description"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "Any other error"       ]     ] [
fhir:url [ fhir:v "responseType"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "application/json"       ]     ] [
fhir:url [ fhir:v "errorCode"^^xsd:anyURI ] ;
fhir:value [
a fhir:string ;
fhir:v "internalError"       ]     ] ) ;
fhir:url [ fhir:v "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"^^xsd:anyURI ]
  ] ) ; # 
  fhir:url [ fhir:v "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "1.2.0-ballot.1"] ; # 
  fhir:name [ fhir:v "EPABasicClient"] ; # 
  fhir:title [ fhir:v "EPA Basic Client"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:date [ fhir:v "2025-08-01"^^xsd:date] ; # 
  fhir:publisher [ fhir:v "gematik GmbH"] ; # 
  fhir:contact ( [
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://www.gematik.de" ]     ] )
  ] ) ; # 
  fhir:description [ fhir:v "Dieses Capability Statement beschreibt die Anforderungen an Clients, die den FHIR Data Service der ePA verwenden. Es legt fest, welche HTTP-Header obligatorisch sind und welche einheitlichen Fehlercodes im Fehlerfall zu erwarten sind."] ; # 
  fhir:jurisdiction ( [
    ( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "DE" ]     ] )
  ] ) ; # 
  fhir:kind [ fhir:v "requirements"] ; # 
  fhir:fhirVersion [ fhir:v "4.0.1"] ; # 
  fhir:format ( [ fhir:v "application/fhir+json"] ) ; # 
  fhir:rest ( [
fhir:mode [ fhir:v "client" ]
  ] ) . #