R8: Manuelles Markieren von Rechnungen und Dokumenten

Die nachfolgende Interaktion ist relevant für den FD als Server, sowie für das DiPag 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/dipag/OperationDefinition/ProcessFlag beschrieben.

Invocations

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

This operation changes content

Parameters (In)

NameCardinalityTypeDocumentation
markierung1..1Coding

Name der Markierung

zeitpunkt1..1dateTime

Optionaler Zeitpunkt der Markierung

details1..1string

Optionale Details als Freitext zur Markierung

gelesen1..1boolean

Gelesen-Status falls Markierung vom Typ 'gelesen' ist

artDerArchivierung1..1Coding

Details zur Art der Archivierung falls Markierung vom Typ 'archiviert' ist

Return Values (Out)

NameCardinalityTypeDocumentation
meta1..1Meta

Vollständiges Meta-Element des Rechnungsdokuments / des Anhangs inkl. Extension (siehe DiPagDocumentReferenceMarkierung) zur Erfassung der Zusatzinformationen der Markierung

Beispiele

HTTP GET [fachdienst-endpunkt]/DocumentReference/[id]/$process-flag
Parameters
<Parameters xmlns="http://hl7.org/fhir">
<id value="BeispielParameterProcessFlagInput" />
<parameter>
<name value="markierung" />
<valueCoding>
<system value="https://gematik.de/fhir/dipag/CodeSystem/dipag-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/dipag/CodeSystem/dipag-rechnung-markierung-cs",
"code": "bezahlt"
}
},
{
"name": "zeitpunkt",
"valueDateTime": "2024-05-30T13:00:00.001+02:00"
},
{
"name": "details",
"valueString": "Bezahlt mit falschem Betreff"
}
]
}
BeispielParameterProcessFlagInput

Antwort des Fachdienstes im Erfolgsfall:

HTTP 200 OK

mit Body:

Parameters
<Parameters xmlns="http://hl7.org/fhir">
<id value="BeispielParameterProcessFlagOutput" />
<parameter>
<name value="meta" />
<valueMeta>
<extension url="https://gematik.de/fhir/dipag/StructureDefinition/dipag-documentreference-markierung">
<extension url="markierung">
<valueCoding>
<system value="https://gematik.de/fhir/dipag/CodeSystem/dipag-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/dipag/CodeSystem/dipag-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/dipag/CodeSystem/dipag-rechnungsstatus-cs",
"code": "erledigt"
}
],
"extension": [
{
"url": "https://gematik.de/fhir/dipag/StructureDefinition/dipag-documentreference-markierung",
"extension": [
{
"url": "markierung",
"valueCoding": {
"system": "https://gematik.de/fhir/dipag/CodeSystem/dipag-rechnung-markierung-cs",
"code": "bezahlt"
}
},
{
"url": "zeitpunkt",
"valueDateTime": "2024-05-30T13:00:00.123+02:00"
},
{
"url": "details",
"valueString": "Bezahlt mit falschem Betreff"
}
]
}
]
}
}
]
}
BeispielParameterProcessFlagOutput

Verarbeitungsschritte im FD

  • Falls während eines Aufrufs der FD feststellt, dass das DiPag 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 'DiPagDocumentReferenceMarkierung' auf der DokumentReference erstellen und aktualisieren.