Skip to content

Latest commit

 

History

History
1262 lines (1186 loc) · 49.5 KB

erp_chargeItem.adoc

File metadata and controls

1262 lines (1186 loc) · 49.5 KB

E-Rezept API-Dokumentation für die PKV-Abrechnungsinformationen gematik logo

Profilierung

Für diesen Anwendungsfall wird die FHIR-Ressource "ChargeItem": http://hl7.org/fhir/chargeitem.html profiliert. Die Profile können als JSON- oder XML-Datei hier eingesehen werden: https://simplifier.net/erezept-patientenrechnung/gem-erpchrg-pr-chargeitem

Die für diese Anwendung wichtigen Attribute und Besonderheiten durch die Profilierung der Ressourcen werden in der folgenden Tabelle kurz zusammengefasst:

Name

Beschreibung

ChargeItem

extension.markingFlag

Boolsche Werte für den Versicherten zum Markieren, ob das ChargeItem bei Institutionen eingereicht wurde

identifier.PrescriptionId

ID des ChargeItems, zugleich Rezept-ID

identifier.AccessCode

Geheimnis zum Ändern des ChargeItems

status

Status des ChargeItems. Fester Wert auf "billable"

code

Pflichtfeld, welches nicht verwendet wird. Verwenden Sie das Codesystem http://terminology.hl7.org/CodeSystem/data-absent-reason#not-applicable.

subject

Versicherten-ID des PKV-Patienten

enterer

Telematik-ID der abgebenden LEI

enteredDate

Zeitstempel der Erstellung eines ChargeItem

supportingInformation

Referenz auf die drei Bestandteile der Abrechnungsinformationen (Verordnungs-, Abgabedatensatz und die Quittung)

In den folgenden Kapiteln wird erläutert, wann und wie die Befüllung dieser Attribute erfolgt.

Anwendungsfall PKV-Abrechnungsinformationen durch den abgebenden Leistungserbringer bereitstellen

Als Apotheker möchte ich dem Versicherten seine Abrechnungsinformationen bereitstellen. Die Abrechnungsinformationen werden über die FHIR-Ressource "ChargeItem" abgebildet. Das ChargeItem enthält Referenzen auf die dazugehörenden Datensätze (als Bundle abgebildet), Verordnungsdatensatz, Abgabedatensatz und die Quittung. Der Abgabedatensatz wird als Contained-Objekt in dem ChargeItem mitgegeben. Der E-Rezept-Fachdienst extrahiert dieses Binary, speichert es gesondert ab und erstellt eine Referenz in der ChargeItem-Resource. Das Attribut "ChargeItem.Code" ist nach dem FHIR-Standard ein Pflichtfeld, wird aber in diesem Kontext fachlich nicht benötigt. Deshalb wird hier ein Platzhalter-Codesystem angewendet.

Der Aufruf erfolgt als http-POST-Operation auf die Ressource /ChargeItem. Im http-Request-Header Authorization muss das während der Authentisierung erhaltene ACCESS_TOKEN übergeben werden. Als URL-Parameter ?secret=…​ muss das beim Abrufen des E-Rezepts ($accept) im Task generierte Secret für die Berechtigungsprüfung übergeben werden.

Request

URI

https://prescriptionserver.telematik/ChargeItem?task=200.086.824.605.539.20&secret=c36ca26502892b371d252c99b496e31505ff449aca9bc69e231c58148f6233cf
Mit dem Parameter task=…​ wird die Zuordnung zum Task des eingelösten Rezepts hergestellt.
Zum Nachweis als berechtigte Apotheke, die das E-Rezept gerade in Bearbeitung hält, muss im URL-Parameter secret das beim Abrufen generierte Secret übergeben werden.

Method

POST

HTTP Header

 
Content-Type: application/fhir+xml; charset=UTF-8
Authorization: Bearer eyJraWQ.ewogImL2pA10Qql22ddtutrvx4FsDlz.rHQjEmB1lLmpqn9J
ℹ️
 Mit dem ACCESS_TOKEN im Authorization-Header weist sich der Zugreifende als Apotheke aus, im Token ist die TelematikID und professionOID für die Rollenprüfung enthalten. Die Base64-Darstellung des Tokens ist stark gekürzt.
ℹ️
 Im http-Header des äußeren http-Requests an die VAU (POST /VAU) sind die Header X-erp-user: l (kleines L) und X-erp-resource: ChargeItem zu setzen.

Payload

 
<ChargeItem xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_ChargeItem|1.0" />
    </meta>
    <contained>
        <Binary>
            <id value="Abg123"/>
            <contentType value="application/pkcs7-mime" />
            <data value= "bWVycnkgY2hyaXN0bWFz"/>
        </Binary>
    </contained>
    <identifier>
        <system value="https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId" />
        <value value="200.086.824.605.539.20" />
    </identifier>
    <status value="billable" />
    <code>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/data-absent-reason" />
            <code value="not-applicable" />
        </coding>
    </code>
    <subject>
        <identifier>
            <system value="http://fhir.de/sid/gkv/kvid-10"/>
            <value value="X234567890" />
            <assigner>
                <display value="Name einer privaten Krankenversicherung" />
            </assigner>
        </identifier>
    </subject>
    <enterer>
        <identifier>
            <system value="https://gematik.de/fhir/sid/telematik-id" />
            <value value="3-15.2.1456789123.191" />
        </identifier>
    </enterer>
    <enteredDate value="2022-06-01T07:13:00+05:00"/>
    <supportingInformation>
        <reference value="#Abg123" />
        <display value="Binary" />
    </supportingInformation>
</ChargeItem>
ℹ️
 Der PKV-Abgabesatz in Binary.data ist aus Platzgründen stark gekürzt.
ℹ️
 In <id value="Abg123"/> befindet sich der Abgabgedatensatz als Contained-Bundle. Das Contained-Bundle wird später durch den Fachdienst als eigenständiges Bundle in "supportingInformation" referenziert.
ℹ️
 In <value value="X234567890"/> findet sich die Angabe eines PKV-Identifier.
ℹ️
 <reference value="Abg123"/> enthält die Referenz auf das Contained-Objekt. Das Symbol '' sagt dabei aus, dass es sich auf eine lokale Referenz innerhalb des Objektes bezieht.

Response

HTTP Status Code

201 Created

HTTP Header

Content-Type: application/fhir+xml;charset=utf-8

Payload

 
<ChargeItem xmlns="http://hl7.org/fhir">
    <id value="abc825bc-bc30-45f8-b109-1b343fff5c45" />
    <meta>
        <profile value="https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_ChargeItem|1.0" />
        <tag>
            <display value="Example of an ChargeItem." />
        </tag>
    </meta>
    <identifier>
        <system value="https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId" />
        <value value="200.086.824.605.539.20" />
    </identifier>
    <status value="billable" />
    <code>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/data-absent-reason" />
            <code value="not-applicable" />
        </coding>
    </code>
    <subject>
        <identifier>
            <system value="http://fhir.de/sid/gkv/kvid-10"/>
            <value value="X234567890" />
            <assigner>
                <display value="Name einer privaten Krankenversicherung" />
            </assigner>
        </identifier>
    </subject>
    <enterer>
        <identifier>
            <system value="https://gematik.de/fhir/sid/telematik-id" />
            <value value="3-15.2.1456789123.191" />
        </identifier>
    </enterer>
    <enteredDate value="2022-06-01T07:13:00+05:00"/>
    <supportingInformation>
        <reference value="Bundle/a5142020-7b59-4674-9b02-08f68c583610"/>
        <display value="http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle"/>
    </supportingInformation>
</ChargeItem>

Status Codes

Code

Type Success

201

Created
Die Anfrage wurde erfolgreich bearbeitet.

Code

Type Error

400

Bad Request
Die Anfrage-Nachricht war fehlerhaft aufgebaut. Mögliche Gründe: Fehlender URL-Parameter task; Die übermittelte ChargeItem-Ressource ist nicht schema-konform.; Der übermittelte PKV-Abgabedatensatz ist nicht schema-konform.; Die Signatur des PKV-Abgabedatensatzes konnte nicht erfolgreich validiert werden.; Der referenzierte Task entspricht nicht den zulässigen FlowTypes.

401

Unauthorized
Die Anfrage kann nicht ohne gültige Authentifizierung durchgeführt werden. Wie die Authentifizierung durchgeführt werden soll, wird im "WWW-Authenticate"-Header-Feld der Antwort übermittelt.

403

Forbidden
Die Anfrage wurde mangels Berechtigung des Clients nicht durchgeführt. Mögliche Gründe: Der authentifizierte Benutzer ist nicht berechtigt; Es liegt keine Einwilligung zum Speichern der Abrechnungsinformationen durch den Versicherten vor.; Fehlender URL-Parameter secret; Der in secret übermittelte Wert stimmt nicht mit dem Geheimnis in Task.secret überein.

405

Method Not Allowed
Die Anfrage darf nur mit anderen HTTP-Methoden (zum Beispiel GET statt POST) gestellt werden. Gültige Methoden für die betreffende Ressource werden im "Allow"-Header-Feld der Antwort übermittelt.

408

Request Timeout
Innerhalb der vom Server erlaubten Zeitspanne wurde keine vollständige Anfrage des Clients empfangen.

409

Conflict
Die Anfrage wurde unter falschen Annahmen gestellt. Es wurde kein entsprechendes Task-Objekt mit dem Status Task.status = completed gefunden.

429

Too Many Requests
Der Client hat zu viele Anfragen in einem bestimmten Zeitraum gesendet.

500

Server Errors
Unerwarteter Serverfehler

Anwendungsfall Abrechnungsinformationen abrufen

Als Apotheker möchte ich eine von mir erstellte Abrechnungsinformation abrufen, um sie bearbeiten zu können oder sie zu kontrollieren. Falls die Abrechnung eine Korrektur benötigt, kann der Versicherte um eine Änderung des PKV-Abgabedatensatzes bitten. Liegen die Daten im System nicht mehr vor, übermittelt der Versicherte der Apotheke den AccessCode zum Ändern mittels einer Nachricht über das E-Rezept-FdV oder durch Anzeige zum Abscannen im E-Rezept-FdV.

Rückgabewert ist ein Bundle, welches das ChargeItem und den Abgabedatensatz, mit seiner Signatur im CAdES-Enveloping-Format, beinhaltet.

Der Aufruf erfolgt als http-GET-Operation auf die Ressource /ChargeItem/'PrescriptionID'. Im Aufruf muss das während der Authentisierung erhaltene ACCESS_TOKEN im http-Request-Header Authorization übergeben werden, der Fachdienst filtert die ChargeItem-Einträge nach der im ACCESS_TOKEN enthaltenen KVNR des Versicherten.

Request

URI

Method

GET

HTTP Header

 
Authorization: Bearer eyJraWQ.ewogImL2pA10Qql22ddtutrvx4FsDlz.rHQjEmB1lLmpqn9J
ℹ️
 Mit dem ACCESS_TOKEN im Authorization-Header weist sich der Zugreifende als Versicherter aus, im Token ist seine Versichertennummer enthalten. Die Base64-Darstellung des Tokens ist stark gekürzt.

Payload

-

Response

HTTP Status Code

200 OK

HTTP Header

Content-Type: application/fhir+xml;charset=utf-8

Payload

 
<Bundle xmlns="http://hl7.org/fhir">
    <id value="Response-Apotheker-GETChargeItemById" />
    <meta>
        <lastUpdated value="2021-09-02T11:38:42.557+00:00" />
    </meta>
    <type value="searchset" />
    <total value="2" />
    <entry>
        <fullUrl value="https://prescriptionserver.telematik/ChargeItem/abc825bc-bc30-45f8-b109-1b343fff5c45" />
        <resource>
            <ChargeItem>
                <id value="Apotheker-ChargeItem-abc825bc-bc30-45f8-b109-1b343fff5c45" />
                <meta>
                    <profile value="https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_ChargeItem|1.0" />
                </meta>
                <extension url="https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_EX_MarkingFlag">
                    <extension url="insuranceProvider">
                        <valueBoolean value="false" />
                    </extension>
                    <extension url="subsidy">
                        <valueBoolean value="false" />
                    </extension>
                    <extension url="taxOffice">
                        <valueBoolean value="false" />
                    </extension>
                </extension>
                <identifier>
                    <system value="https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId" />
                    <value value="200.086.824.605.539.20" />
                </identifier>
                <status value="billable" />
                <code>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/data-absent-reason" />
                        <code value="not-applicable" />
                    </coding>
                </code>
                <subject>
                    <identifier>
                        <system value="http://fhir.de/sid/pkv/kvid-10" />
                        <value value="X234567890" />
                    </identifier>
                </subject>
                <enterer>
                    <identifier>
                        <system value="https://gematik.de/fhir/sid/telematik-id" />
                        <value value="3-SMC-B-Testkarte-883110000095957" />
                    </identifier>
                </enterer>
                <enteredDate value="2021-06-01T07:13:00+05:00" />
                <supportingInformation>
                    <reference value="Bundle/f548dde3-a319-486b-8624-6176ff41ad90" />
                    <display value="http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle" />
                </supportingInformation>
            </ChargeItem>
        </resource>
    </entry>
    <entry>
        <fullUrl value="https://prescriptionserver.telematik/Bundle/f548dde3-a319-486b-8624-6176ff41ad90" />
        <resource>
            <Bundle>
                <id value="f548dde3-a319-486b-8624-6176ff41ad90" />
                <meta>
                    <profile value="http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle|1.1" />
                    <tag>
                        <display value="Beispiel RezeptAbgabedatenPKV Bundle (FAM + Noctu + Rezept&#228;nderung)" />
                    </tag>
                </meta>
                <identifier>
                    <system value="https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId" />
                    <value value="200.086.824.605.539.20" />
                </identifier>
                <type value="document" />
                <timestamp value="2022-03-25T23:40:00Z" />
                <entry>
                    <fullUrl value="urn:uuid:4dc5f425-b9b6-4e39-9166-42668ead6c86" />
                    <resource>
                        <Composition>
                           ...
                        </Composition>
                    </resource>
                </entry>
                <entry>
                    <fullUrl value="urn:uuid:1fa57d53-812b-4cab-a42e-94a12481108a" />
                    <resource>
                        <Organization>
                           ...
                        </Organization>
                    </resource>
                </entry>
                <entry>
                    <fullUrl value="urn:uuid:37a647b8-cb89-491a-af0f-f9bffc2b386c" />
                    <resource>
                        <MedicationDispense>
                            ...
                        </MedicationDispense>
                    </resource>
                </entry>
                <entry>
                    <fullUrl value="urn:uuid:8a99bfa5-f7aa-4741-99d8-f1abbd301ae1" />
                    <resource>
                        <Invoice>
                          ...
                        </Invoice>
                    </resource>
                </entry>
                <signature>
                    <type>
                        <system value="urn:iso-astm:E1762-95:2013" />
                        <code value="1.2.840.10065.1.12.1.1" />
                    </type>
                    <when value="2022-03-18T15:28:00+00:00" />
                    <who>
                        <reference value="https://pharmacy-konn/Device/1" />
                    </who>
                    <onBehalfOf>
                        <identifier>
                            <system value="https://gematik.de/fhir/sid/telematik-id" />
                            <value value="3-SMC-B-Testkarte-883110000129070" />
                        </identifier>
                    </onBehalfOf>
                    <sigFormat value="application/pkcs7-mime" />
                    <data value="dGhpcyBibG9iIGlzIHNuaXBwZWQ=" />
                </signature>
            </Bundle>
        </resource>
    </entry>
</Bundle>
ℹ️
 Aus Gründen der besseren Lesbarkeit ist das PKV-Abgabdedatenbundle hier nicht vollständig dargestellt und wurde mit …​ abgekürzt. Es kann aber vollständig unter https://simplifier.net/erezept-patientenrechnung/~resources?category=Example&exampletype=Bundle eingesehen werden.
ℹ️
 Das <signature> Element enthält die Signatur des Bundles über alle enthaltenen Objekte als Enveloping-CAdES-Signatur in Base64-Codierung.

Status Codes

Code

Type Success

200

OK
Die Anfrage wurde erfolgreich bearbeitet. Die angeforderte Ressource wird im ResponseBody bereitgestellt.

Code

Type Error

400

Bad Request
Die Anfrage-Nachricht war fehlerhaft aufgebaut.

401

Unauthorized
Die Anfrage kann nicht ohne gültige Authentifizierung durchgeführt werden. Wie die Authentifizierung durchgeführt werden soll, wird im "WWW-Authenticate"-Header-Feld der Antwort übermittelt.

403

Forbidden
Die Anfrage wurde mangels Berechtigung des Clients nicht durchgeführt, bspw. weil der authentifizierte Benutzer nicht berechtigt ist.

404

Not found
Die adressierte Ressource wurde nicht gefunden, die übergebene ID ist ungültig.

405

Method Not Allowed
Die Anfrage darf nur mit anderen HTTP-Methoden (zum Beispiel GET statt POST) gestellt werden. Gültige Methoden für die betreffende Ressource werden im "Allow"-Header-Feld der Antwort übermittelt.

408

Request Timeout
Innerhalb der vom Server erlaubten Zeitspanne wurde keine vollständige Anfrage des Clients empfangen.

410

Gone
Die angeforderte Ressource wird nicht länger bereitgestellt und wurde dauerhaft entfernt.

429

Too Many Requests
Der Client hat zu viele Anfragen in einem bestimmten Zeitraum gesendet.

500

Server Errors
Unerwarteter Serverfehler

Anwendungsfall PKV-Abgabedatensatz ändern

Als Apotheke möchte ich einen von mir erstellten PKV-Abgabedatensatz auf Wunsch des Versicherten ändern. Liegen die Daten im System nicht mehr vor, übermittelt der Versicherte der Apotheke den AccessCode zum Ändern mittels einer Nachricht über das E-Rezept-FdV oder durch Anzeige zum Abscannen im E-Rezept-FdV. Der zuvor im E-Rezept-Fachdienst gespeicherte PKV-Abgabedatensatz wird überschrieben. Es werden keine älteren Versionen im E-Rezept-Fachdienst gespeichert.

Der Aufruf erfolgt als http-PUT-Operation auf die Ressource /ChargeItem/'PrescriptionID'. Im Aufruf muss das während der Authentisierung erhaltene ACCESS_TOKEN im http-Request-Header Authorization übergeben werden.

Request

URI

Method

PUT

HTTP Header

 
Authorization: Bearer eyJraWQ.ewogImL2pA10Qql22ddtutrvx4FsDlz.rHQjEmB1lLmpqn9J
ℹ️
 Mit dem ACCESS_TOKEN im Authorization-Header weist sich der Zugreifende als Versicherter aus, im Token ist seine Versichertennummer enthalten. Die Base64-Darstellung des Tokens ist stark gekürzt.

Payload

 
<ChargeItem xmlns="http://hl7.org/fhir">
    <id value="abc825bc-bc30-45f8-b109-1b343fff5c45" />
    <meta>
        <profile value="https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_ChargeItem|1.0" />
    </meta>
    <contained>
        <Binary>
            <id value="Abg456"/>
            <contentType value="application/pkcs7-mime" />
            <data value= "bWVycnkgY2hyaXN0bWFz"/>
        </Binary>
    </contained>
    <identifier>
        <system value="https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId" />
        <value value="200.086.824.605.539.20" />
    </identifier>
    <status value="billable" />
    <code>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/data-absent-reason" />
            <code value="not-applicable" />
        </coding>
    </code>
    <subject>
        <identifier>
            <system value="http://fhir.de/sid/gkv/kvid-10"/>
            <value value="X234567890" />
            <assigner>
                <display value="Name einer privaten Krankenversicherung" />
            </assigner>
        </identifier>
    </subject>
    <enterer>
        <identifier>
            <system value="https://gematik.de/fhir/sid/telematik-id" />
            <value value="3-15.2.1456789123.191" />
        </identifier>
    </enterer>
    <enteredDate value="2022-06-01T07:13:00+05:00"/>
    <supportingInformation>
        <reference value="#Abg456"/>
        <display value="Binary"/>
    </supportingInformation>
</ChargeItem>
ℹ️
 In <id value="Abg456"/> fügt die abgebende LEI ihren geänderten Abgabedatensatz ein.

Response

HTTP Status Code

200 OK

HTTP Header

Content-Type: application/fhir+xml;charset=utf-8

Payload

 
<ChargeItem xmlns="http://hl7.org/fhir">
    <id value="abc825bc-bc30-45f8-b109-1b343fff5c45" />
    <meta>
        <profile value="https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_ChargeItem|1.0" />
        <tag>
            <display value="Example of an ChargeItem." />
        </tag>
    </meta>
    <identifier>
        <system value="https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId" />
        <value value="200.086.824.605.539.20" />
    </identifier>
    <status value="billable" />
    <code>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/data-absent-reason" />
            <code value="not-applicable" />
        </coding>
    </code>
    <subject>
        <identifier>
            <system value="http://fhir.de/sid/gkv/kvid-10"/>
            <value value="X234567890" />
            <assigner>
                <display value="Name einer privaten Krankenversicherung" />
            </assigner>
        </identifier>
    </subject>
    <enterer>
        <identifier>
            <system value="https://gematik.de/fhir/sid/telematik-id" />
            <value value="3-15.2.1456789123.191"/>
        </identifier>
    </enterer>
    <enteredDate value="2022-06-01T07:13:00+05:00"/>
    <supportingInformation>
        <reference value="Bundle/f8ea6d29-d38a-41f0-839f-5ed02c1b3e41"/>
        <display value="http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle"/>
    </supportingInformation>
</ChargeItem>

Code

Type Success

200

OK
Die Anfrage wurde erfolgreich bearbeitet. Die angeforderte Ressource wird im ResponseBody bereitgestellt.

Code

Type Error

400

Bad Request
Die Anfrage-Nachricht war fehlerhaft aufgebaut.

401

Unauthorized
Die Anfrage kann nicht ohne gültige Authentifizierung durchgeführt werden. Wie die Authentifizierung durchgeführt werden soll, wird im "WWW-Authenticate"-Header-Feld der Antwort übermittelt.

403

Forbidden
Die Anfrage wurde mangels Berechtigung des Clients nicht durchgeführt, bspw. weil der authentifizierte Benutzer nicht berechtigt ist oder weil keine Einwilligung vorliegt.

404

Not found
Die adressierte Ressource wurde nicht gefunden, die übergebene ID ist ungültig.

405

Method Not Allowed
Die Anfrage darf nur mit anderen HTTP-Methoden (zum Beispiel GET statt POST) gestellt werden. Gültige Methoden für die betreffende Ressource werden im "Allow"-Header-Feld der Antwort übermittelt.

408

Request Timeout
Innerhalb der vom Server erlaubten Zeitspanne wurde keine vollständige Anfrage des Clients empfangen.

410

Gone
Die angeforderte Ressource wird nicht länger bereitgestellt und wurde dauerhaft entfernt.

429

Too Many Requests
Der Client hat zu viele Anfragen in einem bestimmten Zeitraum gesendet.

500

Server Errors
Unerwarteter Serverfehler

Anwendungsfall Abrechnungsinformationen durch den Versicherten abrufen

Als Versicherter möchte ich auf meine Abrechnungsinformationen zugreifen und diese in der E-Rezept-App einsehen können. Sind die Abrechunngsinformationen nicht bekannt (z.B. beim Wechsel des Smartphones), können diese mit einem GET-Befehl abgerufen werden. Werden ein oder mehrere ChargeItems gefunden, erfolgt die Rückgabe als Liste aller gefundenen ChargeItems ohne die im ChargeItem enthaltenen Referenzen.

Der Aufruf erfolgt als http-GET-Operation auf die Ressource /ChargeItem.

Request

URI

Method

GET

HTTP Header

 
Authorization: Bearer eyJraWQ.ewogImL2pA10Qql22ddtutrvx4FsDlz.rHQjEmB1lLmpqn9J
ℹ️
 Mit dem ACCESS_TOKEN im Authorization-Header weist sich der Zugreifende als Versicherter aus, im Token ist seine Versichertennummer enthalten. Die Base64-Darstellung des Tokens ist stark gekürzt.

Payload

-

Response

HTTP Status Code

200 OK

HTTP Header

Content-Type: application/fhir+json;charset=utf-8

Payload

 
{
  "resourceType": "Bundle",
  "id": "200e3c55-b154-4335-a0ec-65addd39a3b6",
  "meta": {
    "lastUpdated": "2021-09-02T11:38:42.557+00:00"
  },
  "type": "searchset",
  "total": 2,
  "entry": [
    {
      "fullUrl": "http://hapi.fhir.org/baseR4/ChargeItem/abc825bc-bc30-45f8-b109-1b343fff5c45",
      "resource": {
        "resourceType": "ChargeItem",
        "id": "abc825bc-bc30-45f8-b109-1b343fff5c45",
        "meta": {
          "profile": [
            "https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_ChargeItem|1.0"
          ]
        },
        "status": "billable",
        "extension": [
          {
            "url": "https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_EX_MarkingFlag",
            "extension": [
              {
                "url": "insuranceProvider",
                "valueBoolean": false
              },
              {
                "url": "subsidy",
                "valueBoolean": false
              },
              {
                "url": "taxOffice",
                "valueBoolean": false
              }
            ]
          }
        ],
        "identifier": [
          {
            "system": "https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId",
            "value": "200.086.824.605.539.20"
          },
          {
            "system": "https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_AccessCode",
            "value": "777bea0e13cc9c42ceec14aec3ddee2263325dc2c6c699db115f58fe423607ea"
          }
        ],
        "code": {
          "coding": [
            {
              "code": "not-applicable",
              "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason"
            }
          ]
        },
        "subject": {
          "identifier": {
            "system": "http://fhir.de/sid/pkv/kvid-10",
            "value": "X234567890",
            "assigner": {
              "display": "Name einer privaten Krankenversicherung"
            }
          }
        },
        "enteredDate": "2021-06-01T07:13:00+05:00",
        "supportingInformation": [
          {
            "display": "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Bundle"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "http://hapi.fhir.org/baseR4/ChargeItem/der124bc-bc30-45f8-b109-4h474wer2h89",
      "resource": {
        "resourceType": "ChargeItem",
        "id": "der124bc-bc30-45f8-b109-4h474wer2h89",
        "meta": {
          "profile": [
            "https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_ChargeItem|1.0"
          ]
        },
        "status": "billable",
        "extension": [
          {
            "url": "https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_EX_MarkingFlag",
            "extension": [
              {
                "url": "insuranceProvider",
                "valueBoolean": false
              },
              {
                "url": "subsidy",
                "valueBoolean": false
              },
              {
                "url": "taxOffice",
                "valueBoolean": false
              }
            ]
          }
        ],
        "identifier": [
          {
            "system": "https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId",
            "value": "200.086.824.605.539.20"
          },
          {
            "system": "https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_AccessCode",
            "value": "888bea0e13cc9c42ceec14aec3ddee2263325dc2c6c699db115f58fe423607ea"
          }
        ],
        "code": {
          "coding": [
            {
              "code": "not-applicable",
              "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason"
            }
          ]
        },
        "subject": {
          "identifier": {
            "system": "http://fhir.de/sid/gkv/kvid-10",
            "value": "X234567890",
            "assigner": {
              "display": "Name einer privaten Krankenversicherung"
            }
          }
        },
        "enteredDate": "2021-06-01T07:13:00+05:00",
        "supportingInformation": [
          {
            "display": "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Bundle"
          }
        ]
      }
    }
  ]
}
ℹ️
 Die angegebenen Referenzen werden in diesem Request nicht mitgeliefert. Im folgenden Request der das Chargeitem nach der Id abfragt sind diese Informationen dagegen enthalten.
ℹ️
 .enterer ist in diesem Aufruf nicht enthalten, um die Performance im Fachdienst zu erhöhen.

Sind die ChargeItem-Instanzen in der App bekannt, kann direkt auf eine konkrete Instanz zugegriffen werden. Es wird das ChargeItem mit den referenzierten Bundles zurückgegeben.

Rückgabewert ist ein Bundle, welches das ChargeItem, den Verordnungsdatensatz, den Abgabedatensatz und die Quittung beinhaltet. An den drei Abrechnungsdatensätzen (Verordnungs-, Abgabedatensatz und an der Quittung hängt die Signatur im CAdES-Enveloping-Format).

Request

URI

Method

GET

HTTP Header

 
Authorization: Bearer eyJraWQ.ewogImL2pA10Qql22ddtutrvx4FsDlz.rHQjEmB1lLmpqn9J
ℹ️
 Mit dem ACCESS_TOKEN im Authorization-Header weist sich der Zugreifende als Versicherter aus, im Token ist seine Versichertennummer enthalten. Die Base64-Darstellung des Tokens ist stark gekürzt.

Payload

Response

HTTP Status Code

200 OK

HTTP Header

Content-Type: application/fhir+json;charset=utf-8

Payload

 
{
  "resourceType": "Bundle",
  "id": "Response-App-GETChargeItemById",
  "meta": {
    "lastUpdated": "2021-09-02T11:38:42.557+00:00"
  },
  "type": "searchset",
  "total": 4,
  "entry": [
    {
      "fullUrl": "https://prescriptionserver.telematik/ChargeItem/abc825bc-bc30-45f8-b109-1b343fff5c45",
      "resource": {
        "resourceType": "ChargeItem",
        "id": "App-ChargeItem-abc825bc-bc30-45f8-b109-1b343fff5c45",
        "meta": {
          "profile": [
            "https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_ChargeItem|1.0"
          ]
        },
        "extension": [
          {
            "url": "https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_EX_MarkingFlag",
            "extension": [
              {
                "url": "insuranceProvider",
                "valueBoolean": false
              },
              {
                "url": "subsidy",
                "valueBoolean": false
              },
              {
                "url": "taxOffice",
                "valueBoolean": false
              }
            ]
          }
        ],
        "identifier": [
          {
            "system": "https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId",
            "value": "200.086.824.605.539.20"
          },
          {
            "system": "https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_AccessCode",
            "value": "777bea0e13cc9c42ceec14aec3ddee2263325dc2c6c699db115f58fe423607ea"
          }
        ],
        "status": "billable",
        "code": {
          "coding": [
            {
              "code": "not-applicable",
              "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason"
            }
          ]
        },
        "subject": {
          "identifier": {
            "system": "http://fhir.de/sid/pkv/kvid-10",
            "value": "X234567890"
          }
        },
        "enterer": {
          "identifier": {
            "system": "https://gematik.de/fhir/sid/telematik-id",
            "value": "3-SMC-B-Testkarte-883110000095957"
          }
        },
        "enteredDate": "2021-06-01T07:13:00+05:00",
        "supportingInformation": [
          {
            "reference": "Bundle/414ca393-dde3-4082-9a3b-3752e629e4aa",
            "display": "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle"
          },
          {
            "reference": "Bundle/f548dde3-a319-486b-8624-6176ff41ad90",
            "display": "http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle"
          },
          {
            "reference": "Bundle/dffbfd6a-5712-4798-bdc8-07201eb77ab8",
            "display": "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Bundle"
          }
        ]
      }
    },
    {
      "fullUrl": "https://prescriptionserver.telematik/Bundle/414ca393-dde3-4082-9a3b-3752e629e4aa",
      "resource": {
        "resourceType": "Bundle",
        "id": "414ca393-dde3-4082-9a3b-3752e629e4aa",
        "meta": {
          "lastUpdated": "2022-05-20T08:30:00Z",
          "profile": [
            "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle|1.1.0"
          ]
        },
        "identifier": {
          "system": "https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId",
          "value": "200.086.824.605.539.20"
        },
        ...
    },
    {
      "fullUrl": "https://prescriptionserver.telematik/Bundle/f548dde3-a319-486b-8624-6176ff41ad90",
      "resource": {
        "resourceType": "Bundle",
        "id": "f548dde3-a319-486b-8624-6176ff41ad90",
        "meta": {
          "profile": [
            "http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle|1.1"
          ],
          "tag": [
            {
              "display": "Beispiel RezeptAbgabedatenPKV Bundle (FAM + Noctu + Rezept�nderung)"
            }
          ]
        },
        ...
    },
    {
      "fullUrl": "https://prescriptionserver.telematik/Bundle/dffbfd6a-5712-4798-bdc8-07201eb77ab8",
      "resource": {
        "resourceType": "Bundle",
        "id": "dffbfd6a-5712-4798-bdc8-07201eb77ab8",
        "meta": {
          "profile": [
            "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Bundle|1.2"
          ],
          "tag": [
            {
              "display": "Receipt Bundle 'Quittung' for completed dispensation of a prescription"
            }
          ]
        },
        "type": "document",
        "identifier": {
          "system": "https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId",
          "value": "200.086.824.605.539.20"
        },
        "timestamp": "2022-03-18T15:28:00+00:00",
        "entry": [
          {
            "fullUrl": "urn:uuid:c624cf47-e235-4624-af71-0a09dc9254dc",
            "resource": {
              "resourceType": "Composition",
              "id": "c624cf47-e235-4624-af71-0a09dc9254dc",
              "meta": {
                "profile": [
                  "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Composition|1.2"
                ]
              },
              "status": "final",
              "title": "Quittung",
              "extension": [
                {
                  "url": "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_EX_Beneficiary",
                  "valueIdentifier": {
                    "system": "https://gematik.de/fhir/sid/telematik-id",
                    "value": "3-SMC-B-Testkarte-883110000129070"
                  }
                }
              ],
              "type": {
                "coding": [
                  {
                    "code": "3",
                    "system": "https://gematik.de/fhir/erp/CodeSystem/GEM_ERP_CS_DocumentType",
                    "display": "Receipt"
                  }
                ]
              },
              "date": "2022-03-18T15:29:00+00:00",
              "author": [
                {
                  "reference": "https://erp.zentral.erp.splitdns.ti-dienste.de/Device/1"
                }
              ],
              "event": [
                {
                  "period": {
                    "start": "2022-03-18T15:28:00+00:00",
                    "end": "2022-03-18T15:29:00+00:00"
                  }
                }
              ],
              "section": [
                {
                  "entry": [
                    {
                      "reference": "Binary/PrescriptionDigest-200.086.824.605.539.20"
                    }
                  ]
                }
              ]
            }
          },
          {
            "fullUrl": "https://erp.zentral.erp.splitdns.ti-dienste.de/Device/1",
            "resource": {
              "resourceType": "Device",
              "id": "1",
              "meta": {
                "profile": [
                  "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Device|1.2"
                ]
              },
              "status": "active",
              "serialNumber": "1.4.0",
              "deviceName": [
                {
                  "name": "E-Rezept-Fachdienst",
                  "type": "user-friendly-name"
                }
              ],
              "version": [
                {
                  "value": "1.4.0"
                }
              ],
              "contact": [
                {
                  "system": "email",
                  "value": "[email protected]"
                }
              ]
            }
          },
          {
            "fullUrl": "https://erp.zentral.erp.splitdns.ti-dienste.de/Binary/PrescriptionDigest-200.086.824.605.539.20",
            "resource": {
              "resourceType": "Binary",
              "id": "PrescriptionDigest-200.086.824.605.539.20",
              "meta": {
                "profile": [
                  "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Digest|1.2"
                ]
              },
              "contentType": "application/octet-stream",
              "data": "tJg8c5ZtdhzEEhJ0ZpAsUVFx5dKuYgQFs5oKgthi17M="
            }
          }
        ],
        "signature": {
          "type": [
            {
              "code": "1.2.840.10065.1.12.1.1",
              "system": "urn:iso-astm:E1762-95:2013"
            }
          ],
          "when": "2022-03-18T15:28:00+00:00",
          "who": {
            "reference": "https://erp.zentral.erp.splitdns.ti-dienste.de/Device/1"
          },
          "sigFormat": "application/pkcs7-mime",
          "data": "dGhpcyBibG9iIGlzIHNuaXBwZWQ="
        }
      }
    }
  ]
}
ℹ️
 Das signature Element enthält die Signatur des Bundles über alle enthaltenen Objekte als Enveloping-CAdES-Signatur in Base64-Codierung.
ℹ️
 Aus Gründen der besseren Lesbarkeit ist das Bundle hier nicht vollständig dargestellt und wurde mit …​ abgekürzt. Es kann aber vollständig unter https://simplifier.net/erezept-patientenrechnung/~resources?category=Example&exampletype=Bundle eingesehen werden.

Code

Type Success

200

OK
Die Anfrage wurde erfolgreich bearbeitet. Die angeforderte Ressource wird im ResponseBody bereitgestellt.

Code

Type Error

400

Bad Request
Die Anfrage-Nachricht war fehlerhaft aufgebaut.

401

Unauthorized
Die Anfrage kann nicht ohne gültige Authentifizierung durchgeführt werden. Wie die Authentifizierung durchgeführt werden soll, wird im "WWW-Authenticate"-Header-Feld der Antwort übermittelt.

403

Forbidden
Die Anfrage wurde mangels Berechtigung des Clients nicht durchgeführt, bspw. weil der authentifizierte Benutzer nicht berechtigt ist.

404

Not found
Die adressierte Ressource wurde nicht gefunden, die übergebene ID ist ungültig.

405

Method Not Allowed
Die Anfrage darf nur mit anderen HTTP-Methoden (zum Beispiel GET statt POST) gestellt werden. Gültige Methoden für die betreffende Ressource werden im "Allow"-Header-Feld der Antwort übermittelt.

408

Request Timeout
Innerhalb der vom Server erlaubten Zeitspanne wurde keine vollständige Anfrage des Clients empfangen.

410

Gone
Die angeforderte Ressource wird nicht länger bereitgestellt und wurde dauerhaft entfernt.

429

Too Many Requests
Der Client hat zu viele Anfragen in einem bestimmten Zeitraum gesendet.

500

Server Errors
Unerwarteter Serverfehler

Anwendungsfall Abrechnungsinformationen durch den Versicherten ändern

Als Versicherter möchte ich vorhandene Abrechnungsinformationen ändern, indem ich markiere, ob ich meine Abrechnungsdaten bei Abrechnungsstellen eingereicht habe.

Der Aufruf erfolgt als http-PATCH-Operation auf die Ressource /ChargeItem.

Request

URI

Method

PATCH

HTTP Header

 
Authorization: Bearer eyJraWQ.ewogImL2pA10Qql22ddtutrvx4FsDlz.rHQjEmB1lLmpqn9J
Content-Type: application/fhir+json; charset=utf-8
ℹ️
 Mit dem ACCESS_TOKEN im Authorization-Header weist sich der Zugreifende als Versicherter aus, im Token ist seine Versichertennummer enthalten. Die Base64-Darstellung des Tokens ist stark gekürzt.

Payload

 
{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "operation",
      "part": [
        {
          "name": "type",
          "valueCode": "add"
        },
        {
          "name": "path",
          "valueString": "ChargeItem.extension('https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_EX_MarkingFlag').extension('taxOffice')"
        },
        {
          "name": "name",
          "valueString": "valueBoolean"
        },
        {
          "name": "value",
          "valueBoolean": true
        }
      ]
    },
    {
      "name": "operation",
      "part": [
        {
          "name": "type",
          "valueCode": "add"
        },
        {
          "name": "path",
           "valueString": "ChargeItem.extension('https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_EX_MarkingFlag').extension('insuranceProvider')"
        },
        {
          "name": "name",
          "valueString": "valueBoolean"
        },
        {
          "name": "value",
          "valueBoolean": false
        }
      ]
    }
  ]
}
ℹ️
 In "valueString": "ChargeItem.extension('https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_EX_MarkingFlag').extension('taxOffice')" ist der Pfadanfang, an dem das zu ändernde Attribut hängt definiert.
ℹ️
 Im "valueString": "ChargeItem.extension('https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_EX_MarkingFlag').extension('insuranceProvider')" Element, welches geändert werden soll.

Response

HTTP Status Code

200 OK

HTTP Header

Content-Type: application/fhir+json;charset=utf-8

Payload

 
{
  "resourceType": "ChargeItem",
  "id": "2872799",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2022-04-05T11:36:19.491+00:00",
    "source": "#V4se2kvNDlSKuefe",
    "profile": [ "https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_PR_ChargeItem|1.0" ]
  },
  "extension": [ {
    "url": "https://gematik.de/fhir/erpchrg/StructureDefinition/GEM_ERPCHRG_EX_MarkingFlag",
    "extension": [ {
      "url": "insuranceProvider",
      "valueBoolean": true
    }, {
      "url": "subsidy",
      "valueBoolean": false
    }, {
      "url": "taxOffice",
      "valueBoolean": true
    } ]
  } ],
  "identifier": [ {
    "system": "https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_PrescriptionId",
    "value": "200.086.824.605.539.20"
  }, {
    "system": "https://gematik.de/fhir/erp/NamingSystem/GEM_ERP_NS_AccessCode",
    "value": "555bjf73jr8d9si2ceec14aec3ddee2263325dc2c6c699db115f58fe423607ea"
  } ],
  "status": "billable",
  "code": {
    "coding": [ {
      "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
      "code": "not-applicable"
    } ]
  },
  "subject": {
    "identifier": {
      "system": "http://fhir.de/sid/pkv/kvid-10",
      "value": "X234567890"
    }
  },
  "enterer": {
    "identifier": {
      "system": "https://gematik.de/fhir/sid/telematik-id",
      "value": "3-SMC-B-Testkarte-883110000095957"
    }
  },
  "enteredDate": "2021-06-01T07:13:00+05:00",
  "supportingInformation": [ {
    "reference": "Bundle/0428d416-149e-48a4-977c-394887b3d85c",
    "display": "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Bundle"
  },
  {
    "reference": "Bundle/72bd741c-7ad8-41d8-97c3-9aabbdd0f5b4",
    "display": "http://fhir.abda.de/eRezeptAbgabedaten/StructureDefinition/DAV-PKV-PR-ERP-AbgabedatenBundle"
  },
  {
    "reference": "Bundle/2fbc0103-1d1b-4be6-8ed8-6faf87bcc09b",
    "display": "https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_Bundle"
  } ]
}

Code

Type Success

200

OK
Die Anfrage wurde erfolgreich bearbeitet.

Code

Type Error

400

Bad Request
Die Anfrage-Nachricht war fehlerhaft aufgebaut.

401

Unauthorized
Die Anfrage kann nicht ohne gültige Authentifizierung durchgeführt werden. Wie die Authentifizierung durchgeführt werden soll, wird im "WWW-Authenticate"-Header-Feld der Antwort übermittelt.

403

Forbidden
Die Anfrage wurde mangels Berechtigung des Clients nicht durchgeführt, bspw. weil der authentifizierte Benutzer nicht berechtigt ist.

404

Not found
Die adressierte Ressource wurde nicht gefunden, die übergebene ID ist ungültig.

405

Method Not Allowed
Die Anfrage darf nur mit anderen HTTP-Methoden (zum Beispiel GET statt POST) gestellt werden. Gültige Methoden für die betreffende Ressource werden im "Allow"-Header-Feld der Antwort übermittelt.

429

Too Many Requests
Der Client hat zu viele Anfragen in einem bestimmten Zeitraum gesendet.

500

Server Errors
Unerwarteter Serverfehler

Anwendungsfall Löschen der Abrechnungsinformationen durch den Versicherten

Als Versicherter möchte ich eine durch die Apotheke eingestellte Abrechnungsinformation löschen. Das Löschen erfolgt unwiederbringlich.

Der Aufruf erfolgt als http-DELETE-Operation auf die Ressource /ChargeItem. Im Aufruf muss das während der Authentisierung erhaltene ACCESS_TOKEN im http-Request-Header Authorization übergeben werden, der Fachdienst filtert die Consent-Einträge nach der im ACCESS_TOKEN enthaltenen KVNR des Versicherten.

Request

URI

Method

DELETE

HTTP Header

 
Authorization: Bearer eyJraWQ.ewogImL2pA10Qql22ddtutrvx4FsDlz.rHQjEmB1lLmpqn9J
X-AccessCode: 777bea0e13cc9c42ceec14aec3ddee2263325dc2c6c699db115f58fe423607ea
ℹ️
 Mit dem ACCESS_TOKEN im Authorization-Header weist sich der Zugreifende als Versicherter aus, im Token ist seine Versichertennummer enthalten. Die Base64-Darstellung des Tokens ist stark gekürzt.

Payload

Response

HTTP Status Code

204 No Content

HTTP Header

-

Payload

-

Code

Type Success

204

No Content
Die Anfrage wurde erfolgreich bearbeitet. Die Response enthält jedoch keine Daten.

Code

Type Error

400

Bad Request
Die Anfrage-Nachricht war fehlerhaft aufgebaut.

401

Unauthorized
Die Anfrage kann nicht ohne gültige Authentifizierung durchgeführt werden. Wie die Authentifizierung durchgeführt werden soll, wird im "WWW-Authenticate"-Header-Feld der Antwort übermittelt.

403

Forbidden
Die Anfrage wurde mangels Berechtigung des Clients nicht durchgeführt, bspw. weil der authentifizierte Benutzer nicht berechtigt ist.

404

Not found
Die adressierte Ressource wurde nicht gefunden, die übergebene ID ist ungültig.

405

Method Not Allowed
Die Anfrage darf nur mit anderen HTTP-Methoden (zum Beispiel GET statt POST) gestellt werden. Gültige Methoden für die betreffende Ressource werden im "Allow"-Header-Feld der Antwort übermittelt.

429

Too Many Requests
Der Client hat zu viele Anfragen in einem bestimmten Zeitraum gesendet.

500

Server Errors
Unerwarteter Serverfehler