FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/epa-basic-client

Packagede.gematik.epa
TypeCapabilityStatement
Idepa-basic-client
FHIR VersionR4
Sourcehttps://gematik.de/fhir/epa/https://simplifier.net/resolve?scope=de.gematik.epa@1.1.5&canonical=https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client
URLhttps://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client
Version1.1.5
Statusactive
Date2025-05-28
NameEPABasicClient
TitleEPA Basic Client
Realmde
DescriptionDieses 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.
Kindrequirements

Resources that use this resource

CapabilityStatement
epa-mhd-document-consumerEPA MHD Service (Document Consumer - Client)
epa-medication-service-clientEPA Capability Statement für Clients des ePA Medication Service
epa-audit-event-clientCapability Statement für Clients des ePA Audit Event Service
epa-patient-clientCapability Statement für Clients des ePA Patient Service

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement epa-basic-client

EPA Basic Client

  • Implementation Guide Version: 1.1.5
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json
  • Supported Patch Formats:
  • Published on: 2025-05-28
  • Published by: gematik GmbH

Note to Implementers: FHIR Capabilities

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.

FHIR RESTful Capabilities

Mode: client

Summary of System-wide Interactions

Source

{
  "resourceType": "CapabilityStatement",
  "id": "epa-basic-client",
  "meta": {
    "profile": [
      "https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "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": false
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "extension": [
        {
          "url": "name",
          "valueString": "x-insurantid"
        },
        {
          "url": "type",
          "valueString": "string"
        },
        {
          "url": "description",
          "valueString": "Health Record Identifier"
        },
        {
          "url": "pattern",
          "valueString": "^[A-Z]{1}\\d{9}[%content%]quot;
        },
        {
          "url": "required",
          "valueBoolean": true
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "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}[%content%]quot;
        },
        {
          "url": "required",
          "valueBoolean": true
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "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/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "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/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "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/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "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/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "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/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "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/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "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/ti/StructureDefinition/extension-http-response-info"
    }
  ],
  "url": "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client",
  "version": "1.1.5",
  "name": "EPABasicClient",
  "title": "EPA Basic Client",
  "status": "active",
  "date": "2025-05-28",
  "publisher": "gematik GmbH",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.gematik.de"
        }
      ]
    }
  ],
  "description": "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.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "DE"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "client"
    }
  ]
}