Implementation Guide
ePA Basisfunktionalitäten
Version 1.0.6 - release

: EPA Basic Server - JSON Representation

Active as of 2025-05-09

Raw json | Download

{
  "resourceType" : "CapabilityStatement",
  "id" : "epa-basic-server",
  "meta" : {
    "profile" : [
      🔗 "https://gematik.de/fhir/epa/StructureDefinition/epa-capability-statement"
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement epa-basic-server</b></p><a name=\"epa-basic-server\"> </a><a name=\"hcepa-basic-server\"> </a><a name=\"epa-basic-server-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 Server</h2><ul><li>Implementation Guide Version: 1.0.6 </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-09 </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>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div></div>"
  },
  "extension" : [
    {
      "extension" : [
        {
          "url" : "name",
          "valueString" : "X-Request-ID"
        },
        {
          "url" : "type",
          "valueString" : "string"
        },
        {
          "url" : "description",
          "valueString" : "UUID of the request message"
        },
        {
          "url" : "format",
          "valueString" : "uuid"
        },
        {
          "url" : "required",
          "valueBoolean" : true
        }
      ],
      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-header-extenstion"
    },
    {
      "extension" : [
        {
          "url" : "name",
          "valueString" : "x-insurantid"
        },
        {
          "url" : "type",
          "valueString" : "string"
        },
        {
          "url" : "description",
          "valueString" : "Health Record Identifier"
        },
        {
          "url" : "pattern",
          "valueString" : "^[A-Z]{1}\\d{9}$"
        },
        {
          "url" : "required",
          "valueBoolean" : true
        }
      ],
      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-header-extenstion"
    },
    {
      "extension" : [
        {
          "url" : "name",
          "valueString" : "x-useragent"
        },
        {
          "url" : "type",
          "valueString" : "string"
        },
        {
          "url" : "description",
          "valueString" : "user agent information"
        },
        {
          "url" : "pattern",
          "valueString" : "^[a-zA-Z0-9]{20}\\/[a-zA-Z0-9\\-\\.]{1,15}$"
        },
        {
          "url" : "required",
          "valueBoolean" : true
        }
      ],
      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-header-extenstion"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "403"
        },
        {
          "url" : "description",
          "valueString" : "Request does not match schema"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "invalAuth"
        }
      ],
      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "403"
        },
        {
          "url" : "description",
          "valueString" : "Requestor has no valid entitlement"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "notEntitled"
        }
      ],
      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "403"
        },
        {
          "url" : "description",
          "valueString" : "Requestor role is not in the list of allowed user groups"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "invalidOid"
        }
      ],
      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "403"
        },
        {
          "url" : "description",
          "valueString" : "Device registration does not exist"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "unregisteredDevice"
        }
      ],
      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "404"
        },
        {
          "url" : "description",
          "valueString" : "Health record is in state UNKNOWN or INITIALIZED"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "noHealthRecord"
        }
      ],
      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "409"
        },
        {
          "url" : "description",
          "valueString" : "Health record is in state SUSPENDED"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "statusMismatch"
        }
      ],
      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
    },
    {
      "extension" : [
        {
          "url" : "statusCode",
          "valueString" : "500"
        },
        {
          "url" : "description",
          "valueString" : "Any other error"
        },
        {
          "url" : "responseType",
          "valueString" : "application/json"
        },
        {
          "url" : "errorCode",
          "valueString" : "internalError"
        }
      ],
      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
    }
  ],
  "url" : "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-server",
  "version" : "1.0.6",
  "name" : "EPABasicServer",
  "title" : "EPA Basic Server",
  "status" : "active",
  "date" : "2025-05-09",
  "publisher" : "gematik GmbH",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.gematik.de"
        }
      ]
    }
  ],
  "description" : "Das Basis Capability Statement für einen FHIR Data Service in der ePA. Es beschreibt globale Header-Anforderungen und einheitliche HTTP Fehler Codes.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "DE"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+json"
  ],
  "rest" : [
    {
      "mode" : "server"
    }
  ]
}