Implementation Guide
ePA Basisfunktionalitäten
Version 1.0.6-2 - release

## : EPA Basic Client - TTL Representation

Active as of 2025-05-12

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/epa/StructureDefinition/epa-capability-statement"^^xsd:anyURI ;
    fhir:link <https://gematik.de/fhir/epa/StructureDefinition/epa-capability-statement>     ] )
      ] ; #
      fhir:text [
    fhir:status [ fhir:v "extensions" ] ;
    fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement epa-basic-client</b></p><a name=\"epa-basic-client\"> </a><a name=\"hcepa-basic-client\"> </a><a name=\"epa-basic-client-de-DE\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-epa-capability-statement.html\">Capability Statement Profil für ePA FHIR Data Service</a></p></div><h2 id=\"title\">EPA Basic Client</h2><ul><li>Implementation Guide Version: 1.0.6-2 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2025-05-12 </li><li>Published by: gematik GmbH </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div></div>"^^rdf:XMLLiteral
      ] ; #
      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/epa/StructureDefinition/http-header-extenstion"^^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/epa/StructureDefinition/http-header-extenstion"^^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/epa/StructureDefinition/http-header-extenstion"^^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 "Request does not match schema"       ]     ] [
    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/epa/StructureDefinition/http-response-info-extenstion"^^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/epa/StructureDefinition/http-response-info-extenstion"^^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/epa/StructureDefinition/http-response-info-extenstion"^^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"       ]     ] [
    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/epa/StructureDefinition/http-response-info-extenstion"^^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/epa/StructureDefinition/http-response-info-extenstion"^^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"       ]     ] [
    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/epa/StructureDefinition/http-response-info-extenstion"^^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/epa/StructureDefinition/http-response-info-extenstion"^^xsd:anyURI ]
      ] ) ; #
      fhir:url [ fhir:v "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client"^^xsd:anyURI] ; #
      fhir:version [ fhir:v "1.0.6-2"] ; #
      fhir:name [ fhir:v "EPABasicClient"] ; #
      fhir:title [ fhir:v "EPA Basic Client"] ; #
      fhir:status [ fhir:v "active"] ; #
      fhir:date [ fhir:v "2025-05-12"^^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" ]
      ] ) . #