Implementierungsleitfaden E-Rechnung

R8: Manuelles Markieren von Rechnungen und Dokumenten

Die nachfolgende Interaktion ist relevant für den FD als Server, sowie für das eRg FdV als Client. Anwendungsfall AF_10160 MUSS durch den FD über die spezifizierte API umgesetzt werden. Die Vorgaben aus "Tabelle 24: Use Case Manuelles Markieren von Rechnungen und Dokumenten" des Feature-Dokumentes MÜSSEN eingehalten werden durch den FD.


HTTP-Methode	POST
Endpunkt	/DocumentReference/[id]/$process-flag

API-Zustand	HTTP-Status-Code
Erfolgsfall	`200 - OK`
Weitere Parameter in HTTP-Anfrage enthalten	`400 - Bad Request`
Syntax für Parameter ist nicht korrekt oder Kardinalitäten werden nicht eingehalten	`400 - Bad Request`
Kein valides Access-Token wird mitgesendet	`401 - Unauthorized`
Autorisierter Benutzer verfügt über keine ausreichende Berechtigung die Interaktion auszuführen	`403 - Forbidden`
Fehlende Berechtigung für den Rechnungsempfänger die Dokumentenmarkierung zu verändern	`404 - Not Found`
Operation wird auf nicht existierender DocumentReference-Ressource aufgerufen	`404 - Not Found`
Andere HTTP-Methode wird verwendet	`405 - Method Not Allowed`

Die Input- und Output-Parameter werden durch die OperationDefinition https://gematik.de/fhir/erg/OperationDefinition/ProcessFlag beschrieben.

Invocations

URL: [base]/DocumentReference/[id]/$process-flag

This operation changes content

Parameters (In)

Name	Cardinality	Type	Documentation
markierung	1..1	Coding	Name der Markierung
zeitpunkt	1..1	dateTime	Optionaler Zeitpunkt der Markierung
details	1..1	string	Optionale Details als Freitext zur Markierung
gelesen	1..1	boolean	Gelesen-Status falls Markierung vom Typ 'gelesen' ist
artDerArchivierung	1..1	Coding	Details zur Art der Archivierung falls Markierung vom Typ 'archiviert' ist

Return Values (Out)

Name	Cardinality	Type	Documentation
meta	1..1	Meta	Vollständiges Meta-Element des Rechnungsdokuments / des Anhangs inkl. Extension (siehe ERGDocumentReferenceMarkierung) zur Erfassung der Zusatzinformationen der Markierung

Beispiele

HTTP GET [fachdienst-endpunkt]/DocumentReference/[id]/$change-status

Parameters

id : BeispielParameterProcessFlagInput

parameter

name : markierung

value

system : https://gematik.de/fhir/erg/CodeSystem/erg-rechnung-markierung-cs

code : bezahlt

parameter

name : zeitpunkt

value : 2024-05-30T13:00:00.001+02:00

parameter

name : details

value : Bezahlt mit falschem Betreff

<Parameters xmlns="http://hl7.org/fhir">
    <id value="BeispielParameterProcessFlagInput" />
    <parameter>
        <name value="markierung" />
        <valueCoding>
            <system value="https://gematik.de/fhir/erg/CodeSystem/erg-rechnung-markierung-cs" />
            <code value="bezahlt" />
        </valueCoding>
    </parameter>
    <parameter>
        <name value="zeitpunkt" />
        <valueDateTime value="2024-05-30T13:00:00.001+02:00" />
    </parameter>
    <parameter>
        <name value="details" />
        <valueString value="Bezahlt mit falschem Betreff" />
    </parameter>
</Parameters>

{
    "resourceType": "Parameters",
    "id": "BeispielParameterProcessFlagInput",
    "parameter":  [
        {
            "name": "markierung",
            "valueCoding": {
                "system": "https://gematik.de/fhir/erg/CodeSystem/erg-rechnung-markierung-cs",
                "code": "bezahlt"
            }
        },
        {
            "name": "zeitpunkt",
            "valueDateTime": "2024-05-30T13:00:00.001+02:00"
        },
        {
            "name": "details",
            "valueString": "Bezahlt mit falschem Betreff"
        }
    ]
}

Parameters

Antwort des Fachdienstes im Erfolgsfall:

HTTP 200 OK

mit Body:

Parameters

id : BeispielParameterProcessFlagOutput

parameter

name : meta

value

extension

url : markierung

value

system : https://gematik.de/fhir/erg/CodeSystem/erg-rechnung-markierung-cs

code : bezahlt

extension

url : zeitpunkt

value : 2024-05-30T13:00:00.123+02:00

extension

url : details

value : Bezahlt mit falschem Betreff

url : https://gematik.de/fhir/erg/StructureDefinition/erg-documentreference-markierung

versionId : 2

lastUpdated : 2024-05-31T13:00:00.123+02:00

tag

system : https://gematik.de/fhir/erg/CodeSystem/erg-rechnungsstatus-cs

code : erledigt

<Parameters xmlns="http://hl7.org/fhir">
    <id value="BeispielParameterProcessFlagOutput" />
    <parameter>
        <name value="meta" />
        <valueMeta>
            <extension url="https://gematik.de/fhir/erg/StructureDefinition/erg-documentreference-markierung">
                <extension url="markierung">
                    <valueCoding>
                        <system value="https://gematik.de/fhir/erg/CodeSystem/erg-rechnung-markierung-cs" />
                        <code value="bezahlt" />
                    </valueCoding>
                </extension>
                <extension url="zeitpunkt">
                    <valueDateTime value="2024-05-30T13:00:00.123+02:00" />
                </extension>
                <extension url="details">
                    <valueString value="Bezahlt mit falschem Betreff" />
                </extension>
            </extension>
            <versionId value="2" />
            <lastUpdated value="2024-05-31T13:00:00.123+02:00" />
            <tag>
                <system value="https://gematik.de/fhir/erg/CodeSystem/erg-rechnungsstatus-cs" />
                <code value="erledigt" />
            </tag>
        </valueMeta>
    </parameter>
</Parameters>

{
    "resourceType": "Parameters",
    "id": "BeispielParameterProcessFlagOutput",
    "parameter":  [
        {
            "name": "meta",
            "valueMeta": {
                "versionId": "2",
                "lastUpdated": "2024-05-31T13:00:00.123+02:00",
                "tag":  [
                    {
                        "system": "https://gematik.de/fhir/erg/CodeSystem/erg-rechnungsstatus-cs",
                        "code": "erledigt"
                    }
                ],
                "extension":  [
                    {
                        "url": "https://gematik.de/fhir/erg/StructureDefinition/erg-documentreference-markierung",
                        "extension":  [
                            {
                                "url": "markierung",
                                "valueCoding": {
                                    "system": "https://gematik.de/fhir/erg/CodeSystem/erg-rechnung-markierung-cs",
                                    "code": "bezahlt"
                                }
                            },
                            {
                                "url": "zeitpunkt",
                                "valueDateTime": "2024-05-30T13:00:00.123+02:00"
                            },
                            {
                                "url": "details",
                                "valueString": "Bezahlt mit falschem Betreff"
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

Parameters

Verarbeitungsschritte im FD

Falls während eines Aufrufs der FD feststellt, dass das eRg FdV versucht eine Markierung hinzuzufügen die bereits existiert, so ist diese Markierung zu ignorieren. HTTP 200 - OK wird in diesem Fall zurückgegeben.
Der FD MUSS anhand der übergebenen Parameter die Extension 'ERGDocumentReferenceMarkierung' auf der DokumentReference erstellen und aktualisieren.