TIFlow - Abrechnungsinformationen
Version 2.0.0-ballot.1 - ci-build

Query API: Communication

Diese Seite basiert auf der gleichnamigen Schnittstelle in der Core-Spezifikation und beschreibt den Einstieg in die Communication-Query-Schnittstelle.

Die Query API für Communication beschreibt das Einstellen von Nachrichten im Rahmen der PKV‑Abrechnung (z. B. Änderungsanfragen der Abrechnungsinformation).

Nachricht

Nachrichten werden als Communication‑Ressourcen an den E‑Rezept‑Fachdienst gesendet. Die verwendeten Profile richten sich nach der Kommunikationsbeziehung (Versicherter - Apotheke).

Die Interaktion mit Nachrichten als FHIR-Ressource Communication wird über die folgenden HTTP-Methoden ermöglicht:

HTTP-Methode Ergebnis der Anfrage
GET Nachrichten abrufen
POST Nachricht einstellen
DELETE Nachricht löschen

Anforderungen an die Schnittstelle

Resource API

Anfragen an die Communication-Ressource können über die RESTful API mittels HTTP GET-Anfragen durchgeführt werden. Dabei können spezifische Suchparameter genutzt werden, um die Anfragen zu verfeinern. Zum Beispiel:

  • Für den Versicherten noch nicht vom TI-Flow-Fachdienst abgerufene Communications: ?recipient=<kvnr>&received=NULL

API Beschreibung

			{"resourceType":"CapabilityStatement","id":"ti-flow-fachdienst-server-erpchrg","meta":{"profile":["https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"]},"extension":[{"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-base-url","valueString":"https://tiflow.de"}],"url":"https://gematik.de/fhir/tiflow-chargeitem/CapabilityStatement/ti-flow-fachdienst-server-erpchrg","version":"2.0.0-ballot.1","title":"ERPCHRG CapabilityStatement für den E-Rezept-Fachdienst","status":"active","date":"2028-04-01","publisher":"gematik GmbH","contact":[{"name":"gematik GmbH","telecom":[{"system":"url","value":"https://gematik.de"},{"system":"email","value":"erp-umsetzung@gematik.de"}]}],"description":"CapabilityStatement für den E-Rezept-Fachdienst (PKV-Abrechnungsinformationen)","jurisdiction":[{"coding":[{"system":"urn:iso:std:iso:3166","code":"DE","display":"Germany"}]}],"kind":"requirements","imports":["https://gematik.de/fhir/workflow/core/CapabilityStatement/erp-fachdienst-server"],"_imports":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}]}],"fhirVersion":"4.0.1","format":["application/fhir+json","application/fhir+xml"],"rest":[{"mode":"server","resource":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}],"type":"ChargeItem","supportedProfile":["https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_ChargeItem"],"_supportedProfile":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}]}],"interaction":[{"extension":[{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Invalid request format"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_BAD_FORMAT"}],"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"},{"extension":[{"url":"statusCode","valueString":"408"},{"url":"description","valueString":"Request timeout"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_TIMEOUT"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"500"},{"url":"description","valueString":"Internal server error"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_INTERNAL_ERROR"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"200"},{"url":"description","valueString":"Successful operation"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Unknown search parameter"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_PARAM_UNKNOWN"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Invalid query parameter(s)"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_BAD_SYNTAX"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"404"},{"url":"description","valueString":"Unknown resource type"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_UNKNOWN_TYPE"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"}],"code":"search-type"},{"extension":[{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Invalid request format"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_BAD_FORMAT"}],"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"},{"extension":[{"url":"statusCode","valueString":"408"},{"url":"description","valueString":"Request timeout"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_TIMEOUT"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"500"},{"url":"description","valueString":"Internal server error"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_INTERNAL_ERROR"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"200"},{"url":"description","valueString":"Successful operation"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"404"},{"url":"description","valueString":"Unknown resource type"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_UNKNOWN_TYPE"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"404"},{"url":"description","valueString":"Resource is not known"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_RESOURCE_ID_FAIL"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"410"},{"url":"description","valueString":"Resource was deleted"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_DELETED"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"}],"code":"read"}],"versioning":"versioned-update","readHistory":true,"searchParam":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}],"name":"_lastUpdated","definition":"http://hl7.org/fhir/SearchParameter/Resource-lastUpdated","type":"date","documentation":"Resource.meta.lastUpdated - Unterstützt die Suche nach dem zuletzt aktualisierten Datum"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}],"name":"entered-date","definition":"http://hl7.org/fhir/SearchParameter/ChargeItem-entered-date","type":"date","documentation":"ChargeItem.enteredDate - Unterstützt die Suche nach dem Eingangsdatum; default sort if _sort is not provided"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}],"name":"_sort","type":"string","documentation":"Unterstützt das Sortieren nach unterstützten ChargeItem-Suchkriterien"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}],"name":"_count","type":"number","documentation":"Maximale Anzahl zurückgegebener Einträge pro Seite; maximum value is 50"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}],"name":"__offset","type":"number","documentation":"Nullbasierter Offset des ersten zurückgegebenen Eintrags; default is 0"}]},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}],"type":"Consent","supportedProfile":["https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_Consent"],"_supportedProfile":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}]}],"interaction":[{"extension":[{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Invalid request format"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_BAD_FORMAT"}],"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"},{"extension":[{"url":"statusCode","valueString":"408"},{"url":"description","valueString":"Request timeout"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_TIMEOUT"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"500"},{"url":"description","valueString":"Internal server error"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_INTERNAL_ERROR"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"200"},{"url":"description","valueString":"Successful operation"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Unknown search parameter"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_PARAM_UNKNOWN"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Invalid query parameter(s)"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_BAD_SYNTAX"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"404"},{"url":"description","valueString":"Unknown resource type"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_UNKNOWN_TYPE"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"}],"code":"search-type"},{"extension":[{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Invalid request format"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_BAD_FORMAT"}],"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"},{"extension":[{"url":"statusCode","valueString":"408"},{"url":"description","valueString":"Request timeout"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_TIMEOUT"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"500"},{"url":"description","valueString":"Internal server error"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_INTERNAL_ERROR"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"200"},{"url":"description","valueString":"Successful operation"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"404"},{"url":"description","valueString":"Unknown resource type"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_UNKNOWN_TYPE"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"404"},{"url":"description","valueString":"Resource is not known"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_RESOURCE_ID_FAIL"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"410"},{"url":"description","valueString":"Resource was deleted"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_DELETED"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"}],"code":"read"}],"versioning":"versioned-update","readHistory":true,"searchParam":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}],"name":"category","definition":"http://hl7.org/fhir/SearchParameter/Consent-category","type":"token","documentation":"Consent.category - Unterstützt die Suche nach der Art der Einwilligung"}]},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}],"type":"Communication","supportedProfile":["https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_Communication_ChargChangeReq","https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_Communication_ChargChangeReply"],"_supportedProfile":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}]},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"}]}],"interaction":[{"extension":[{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Invalid request format"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_BAD_FORMAT"}],"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"},{"extension":[{"url":"statusCode","valueString":"408"},{"url":"description","valueString":"Request timeout"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_TIMEOUT"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"500"},{"url":"description","valueString":"Internal server error"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_INTERNAL_ERROR"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"200"},{"url":"description","valueString":"Successful operation"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Unknown search parameter"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_PARAM_UNKNOWN"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Invalid query parameter(s)"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_BAD_SYNTAX"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"404"},{"url":"description","valueString":"Unknown resource type"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_UNKNOWN_TYPE"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"}],"code":"search-type"},{"extension":[{"extension":[{"url":"statusCode","valueString":"400"},{"url":"description","valueString":"Invalid request format"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_BAD_FORMAT"}],"url":"http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation","valueCode":"SHALL"},{"extension":[{"url":"statusCode","valueString":"408"},{"url":"description","valueString":"Request timeout"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_TIMEOUT"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"500"},{"url":"description","valueString":"Internal server error"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_INTERNAL_ERROR"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"200"},{"url":"description","valueString":"Successful operation"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"404"},{"url":"description","valueString":"Unknown resource type"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_UNKNOWN_TYPE"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"404"},{"url":"description","valueString":"Resource is not known"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_RESOURCE_ID_FAIL"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"},{"extension":[{"url":"statusCode","valueString":"410"},{"url":"description","valueString":"Resource was deleted"},{"url":"responseType","valueString":"TIFlowOperationOutcome"},{"url":"errorCode","valueString":"MSG_DELETED"}],"url":"https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"}],"code":"read"}],"versioning":"versioned-update","readHistory":true}]}]}
		

<Bundle xmlns="http://hl7.org/fhir">
  <id value="ExampleERPCHRGCommunicationSearchset"/>
  <type value="searchset"/>
  <total value="1"/>
  <link>
    <relation value="self"/>
    <url value="https://erp-ref.example.org/Communication?received=NULL"/>
  </link>
  <entry>
    <fullUrl
             value="https://erp-ref.example.org/Communication/Communication_ChargChangeRequest"/>
    <resource>
      <Communication>
        <id value="b4cf7f71-3ade-40ab-97a9-929f95af29f2"/>
        <meta>
          <profile
                   value="https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_Communication_ChargChangeReq"/>
          <tag>
            <display
                     value="Communication message sent by patient to pharmacy to request the change of an existing ChargeItem by providing the AccessCode"/>
          </tag>
        </meta>
        <basedOn>
          <reference
                     value="ChargeItem/a51520ec-0899-404f-bb97-fe7d461f90a8?ac=777bea0e13cc9c42ceec14aec3ddee2263325dc2c6c699db115f58fe423607ea"/>
        </basedOn>
        <status value="unknown"/>
        <sent value="2028-10-01T15:29:00.434+00:00"/>
        <recipient>
          <identifier>
            <system value="https://gematik.de/fhir/sid/telematik-id"/>
            <value value="3-2-APO-XanthippeVeilchenblau01"/>
          </identifier>
        </recipient>
        <sender>
          <identifier>
            <system value="http://fhir.de/sid/gkv/kvid-10"/>
            <value value="P987654321"/>
          </identifier>
        </sender>
        <payload>
          <contentString
                         value="Bitte meinen Namen in Günther ändern, Waltraud ist falsch."/>
        </payload>
      </Communication>
    </resource>
    <search>
      <mode value="match"/>
    </search>
  </entry>
</Bundle>

Sicherheitsanforderungen

Generelle Sicherheitsanforderungen werden hier festgehalten.