Implementation Guide
ePA Basisfunktionalitäten
Version 1.3.2 - release

: EPA Basic Client - TTL Representation

Active as of 2026-07-15

Raw ttl | Download


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

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

<http://hl7.org/fhir/CapabilityStatement/epa-basic-client> a fhir:CapabilityStatement ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "epa-basic-client"] ;
  fhir:Resource.meta [
     fhir:Meta.profile [
       fhir:value "https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement" ;
       fhir:index 0 ;
       fhir:link <https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement>
     ]
  ] ;
  fhir:DomainResource.extension [
     fhir:index 0 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "name" ] ;
       fhir:Extension.valueString [ fhir:value "X-Request-ID" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "type" ] ;
       fhir:Extension.valueString [ fhir:value "string" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "description" ] ;
       fhir:Extension.valueString [ fhir:value "UUID of the request message" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "format" ] ;
       fhir:Extension.valueString [ fhir:value "uuid" ]
     ], [
       fhir:index 4 ;
       fhir:Extension.url [ fhir:value "required" ] ;
       fhir:Extension.valueBoolean [ fhir:value "false"^^xsd:boolean ]
     ] ;
     fhir:Extension.url [ fhir:value "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header" ]
  ], [
     fhir:index 1 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "name" ] ;
       fhir:Extension.valueString [ fhir:value "x-insurantid" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "type" ] ;
       fhir:Extension.valueString [ fhir:value "string" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "description" ] ;
       fhir:Extension.valueString [ fhir:value "Health Record Identifier" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "pattern" ] ;
       fhir:Extension.valueString [ fhir:value "^[A-Z]{1}\\d{9}$" ]
     ], [
       fhir:index 4 ;
       fhir:Extension.url [ fhir:value "required" ] ;
       fhir:Extension.valueBoolean [ fhir:value "true"^^xsd:boolean ]
     ] ;
     fhir:Extension.url [ fhir:value "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header" ]
  ], [
     fhir:index 2 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "name" ] ;
       fhir:Extension.valueString [ fhir:value "x-useragent" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "type" ] ;
       fhir:Extension.valueString [ fhir:value "string" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "description" ] ;
       fhir:Extension.valueString [ fhir:value "user agent information" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "pattern" ] ;
       fhir:Extension.valueString [ fhir:value "^[a-zA-Z0-9]{20}\\/[a-zA-Z0-9\\-\\.]{1,15}$" ]
     ], [
       fhir:index 4 ;
       fhir:Extension.url [ fhir:value "required" ] ;
       fhir:Extension.valueBoolean [ fhir:value "true"^^xsd:boolean ]
     ] ;
     fhir:Extension.url [ fhir:value "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header" ]
  ], [
     fhir:index 3 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "statusCode" ] ;
       fhir:Extension.valueString [ fhir:value "403" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "description" ] ;
       fhir:Extension.valueString [ fhir:value "Requestor not authorized (no user session with valid ID-Token available)" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "responseType" ] ;
       fhir:Extension.valueString [ fhir:value "application/json" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "errorCode" ] ;
       fhir:Extension.valueString [ fhir:value "invalAuth" ]
     ] ;
     fhir:Extension.url [ fhir:value "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info" ]
  ], [
     fhir:index 4 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "statusCode" ] ;
       fhir:Extension.valueString [ fhir:value "403" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "description" ] ;
       fhir:Extension.valueString [ fhir:value "Requestor has no valid entitlement" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "responseType" ] ;
       fhir:Extension.valueString [ fhir:value "application/json" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "errorCode" ] ;
       fhir:Extension.valueString [ fhir:value "notEntitled" ]
     ] ;
     fhir:Extension.url [ fhir:value "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info" ]
  ], [
     fhir:index 5 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "statusCode" ] ;
       fhir:Extension.valueString [ fhir:value "403" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "description" ] ;
       fhir:Extension.valueString [ fhir:value "Requestor role is not in the list of allowed user groups" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "responseType" ] ;
       fhir:Extension.valueString [ fhir:value "application/json" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "errorCode" ] ;
       fhir:Extension.valueString [ fhir:value "invalidOid" ]
     ] ;
     fhir:Extension.url [ fhir:value "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info" ]
  ], [
     fhir:index 6 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "statusCode" ] ;
       fhir:Extension.valueString [ fhir:value "403" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "description" ] ;
       fhir:Extension.valueString [ fhir:value "Device registration does not exist (if requestor role is oid_versicherter only)" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "responseType" ] ;
       fhir:Extension.valueString [ fhir:value "application/json" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "errorCode" ] ;
       fhir:Extension.valueString [ fhir:value "unregisteredDevice" ]
     ] ;
     fhir:Extension.url [ fhir:value "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info" ]
  ], [
     fhir:index 7 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "statusCode" ] ;
       fhir:Extension.valueString [ fhir:value "404" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "description" ] ;
       fhir:Extension.valueString [ fhir:value "Health record is in state UNKNOWN or INITIALIZED" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "responseType" ] ;
       fhir:Extension.valueString [ fhir:value "application/json" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "errorCode" ] ;
       fhir:Extension.valueString [ fhir:value "noHealthRecord" ]
     ] ;
     fhir:Extension.url [ fhir:value "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info" ]
  ], [
     fhir:index 8 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "statusCode" ] ;
       fhir:Extension.valueString [ fhir:value "409" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "description" ] ;
       fhir:Extension.valueString [ fhir:value "Request conflicts with the current state of the health record" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "responseType" ] ;
       fhir:Extension.valueString [ fhir:value "application/json" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "errorCode" ] ;
       fhir:Extension.valueString [ fhir:value "statusMismatch" ]
     ] ;
     fhir:Extension.url [ fhir:value "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info" ]
  ], [
     fhir:index 9 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "statusCode" ] ;
       fhir:Extension.valueString [ fhir:value "500" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "description" ] ;
       fhir:Extension.valueString [ fhir:value "Any other error" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "responseType" ] ;
       fhir:Extension.valueString [ fhir:value "application/json" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "errorCode" ] ;
       fhir:Extension.valueString [ fhir:value "internalError" ]
     ] ;
     fhir:Extension.url [ fhir:value "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info" ]
  ] ;
  fhir:CapabilityStatement.url [ fhir:value "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client"] ;
  fhir:CapabilityStatement.version [ fhir:value "1.3.2"] ;
  fhir:CapabilityStatement.name [ fhir:value "EPABasicClient"] ;
  fhir:CapabilityStatement.title [ fhir:value "EPA Basic Client"] ;
  fhir:CapabilityStatement.status [ fhir:value "active"] ;
  fhir:CapabilityStatement.date [ fhir:value "2026-07-15"^^xsd:date] ;
  fhir:CapabilityStatement.publisher [ fhir:value "gematik GmbH"] ;
  fhir:CapabilityStatement.contact [
     fhir:index 0 ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "url" ] ;
       fhir:ContactPoint.value [ fhir:value "https://www.gematik.de" ]
     ]
  ] ;
  fhir:CapabilityStatement.description [ fhir:value "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:CapabilityStatement.jurisdiction [
     fhir:index 0 ;
     fhir:CodeableConcept.coding [
       fhir:index 0 ;
       fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ] ;
       fhir:Coding.code [ fhir:value "DE" ]
     ]
  ] ;
  fhir:CapabilityStatement.copyright [ fhir:value "gematik GmbH / Dieser Implementation Guide ist lizenziert unter [Apache License](./license.html), Version 2.0."] ;
  fhir:CapabilityStatement.kind [ fhir:value "requirements"] ;
  fhir:CapabilityStatement.fhirVersion [ fhir:value "4.0.1"] ;
  fhir:CapabilityStatement.format [
     fhir:value "application/fhir+json" ;
     fhir:index 0
  ] ;
  fhir:CapabilityStatement.rest [
     fhir:index 0 ;
     fhir:CapabilityStatement.rest.mode [ fhir:value "client" ]
  ] .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/CapabilityStatement/epa-basic-client.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/CapabilityStatement/epa-basic-client.ttl> .