Operations

Metadaten

Canonicalhttp://gematik.de/fhir/oegd/stf/OperationDefinition/StfReceiveBundle
Statusactive

Inhalt

Invocations

URL: [base]/$receiveBundle

This operation changes content

Parameters (In)

NameCardinalityTypeDocumentation
resource1..1Bundle(StfExportBundle)

Das FHIR-Bundle, das validiert und verarbeitet werden soll.

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1Bundle

Das vom Server erzeugte Antwort-Bundle der Transaktion. Bei einem Fehler wird stattdessen ein OperationOutcome mit HTTP 422 zurueckgegeben.

Diese Operation validiert das eingehende Bundle, konvertiert es in ein FHIR-Transaktions-Bundle und führt es aus. Die Antwort ist das Ergebnis-Bundle der Transaktion. Schlägt die Transaktion fehl, wird ein OperationOutcome mit dem HTTP-Statuscode 422 (Unprocessable Entity) zurückgegeben.

Hinweis ICD-10: Bei allen im Bundle enthaltenen Todesursachen (Profil StfTodesursache) die einen ICD-10 Code enthalten, wird die Terminologie gegen ICD-10-WHO validiert. Da viele ausstellende Ärzte (o.a.) mit ICD-10-GM arbeiten und diese Codes in den Totenschein eintragen, kann es sein, dass die Validierung fehlschlägt. Aus dem Grund wird nur eine Warnung ausgegeben, keine Error. Eine Verschärfung der Anforderungen wäre wünschenswert, ist aber aufgrund der Quellenlage aktuell nicht realistisch.

<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="StfReceiveBundle" />
<url value="http://gematik.de/fhir/oegd/stf/OperationDefinition/StfReceiveBundle" />
<name value="STF ReceiveBundle" />
<title value="Empfangen und Verarbeiten eines STF FHIR-Bundles" />
<status value="active" />
<kind value="operation" />
<experimental value="false" />
<publisher value="ELFA Maßnahme Interoperabilität" />
<description value="Validiert das Eingangs-Bundle, protokolliert bzw. gibt das Validierungsergebnis aus, wandelt es in ein Transaktions-Bundle um und führt die Transaktion aus.\n\nDas mitgegebene Bundle muss eine Provenance Ressource enthalten, die alle Ressourcen im Bundle (Ausnahme sich selber) referenziert. Die Provenance Ressource muss dem Profil StfProvenance entsprechen." />
<affectsState value="true" />
<code value="receiveBundle" />
<comment value="Diese Operation validiert das eingehende Bundle, konvertiert es in ein FHIR-Transaktions-Bundle und führt es aus. Die Antwort ist das Ergebnis-Bundle der Transaktion. Schlägt die Transaktion fehl, wird ein OperationOutcome mit dem HTTP-Statuscode 422 (Unprocessable Entity) zurückgegeben.\n\n**Hinweis ICD-10:** Bei allen im Bundle enthaltenen Todesursachen (Profil StfTodesursache) die einen ICD-10 Code enthalten, wird die Terminologie gegen ICD-10-WHO validiert. Da viele ausstellende Ärzte (o.a.) mit ICD-10-GM arbeiten und diese Codes in den Totenschein eintragen, kann es sein, dass die Validierung fehlschlägt. Aus dem Grund wird nur eine Warnung ausgegeben, keine Error. Eine Verschärfung der Anforderungen wäre wünschenswert, ist aber aufgrund der Quellenlage aktuell nicht realistisch." />
<system value="true" />
<type value="false" />
<instance value="false" />
<name value="resource" />
<use value="in" />
<min value="1" />
<max value="1" />
<documentation value="Das FHIR-Bundle, das validiert und verarbeitet werden soll." />
<type value="Bundle" />
<targetProfile value="http://gematik.de/fhir/oegd/stf/StructureDefinition/StfExportBundle" />
</parameter>
<name value="return" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="Das vom Server erzeugte Antwort-Bundle der Transaktion. Bei einem Fehler wird stattdessen ein OperationOutcome mit HTTP 422 zurueckgegeben." />
<type value="Bundle" />
</parameter>
</OperationDefinition>
{
"resourceType": "OperationDefinition",
"id": "StfReceiveBundle",
"url": "http://gematik.de/fhir/oegd/stf/OperationDefinition/StfReceiveBundle",
"name": "STF ReceiveBundle",
"title": "Empfangen und Verarbeiten eines STF FHIR-Bundles",
"status": "active",
"kind": "operation",
"experimental": false,
"publisher": "ELFA Maßnahme Interoperabilität",
"description": "Validiert das Eingangs-Bundle, protokolliert bzw. gibt das Validierungsergebnis aus, wandelt es in ein Transaktions-Bundle um und führt die Transaktion aus.\n\nDas mitgegebene Bundle muss eine Provenance Ressource enthalten, die alle Ressourcen im Bundle (Ausnahme sich selber) referenziert. Die Provenance Ressource muss dem Profil StfProvenance entsprechen.",
"affectsState": true,
"code": "receiveBundle",
"comment": "Diese Operation validiert das eingehende Bundle, konvertiert es in ein FHIR-Transaktions-Bundle und führt es aus. Die Antwort ist das Ergebnis-Bundle der Transaktion. Schlägt die Transaktion fehl, wird ein OperationOutcome mit dem HTTP-Statuscode 422 (Unprocessable Entity) zurückgegeben.\n\n**Hinweis ICD-10:** Bei allen im Bundle enthaltenen Todesursachen (Profil StfTodesursache) die einen ICD-10 Code enthalten, wird die Terminologie gegen ICD-10-WHO validiert. Da viele ausstellende Ärzte (o.a.) mit ICD-10-GM arbeiten und diese Codes in den Totenschein eintragen, kann es sein, dass die Validierung fehlschlägt. Aus dem Grund wird nur eine Warnung ausgegeben, keine Error. Eine Verschärfung der Anforderungen wäre wünschenswert, ist aber aufgrund der Quellenlage aktuell nicht realistisch.",
"system": true,
"type": false,
"instance": false,
{
"name": "resource",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Das FHIR-Bundle, das validiert und verarbeitet werden soll.",
"type": "Bundle",
"http://gematik.de/fhir/oegd/stf/StructureDefinition/StfExportBundle"
]
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Das vom Server erzeugte Antwort-Bundle der Transaktion. Bei einem Fehler wird stattdessen ein OperationOutcome mit HTTP 422 zurueckgegeben.",
"type": "Bundle"
}
]
}

Metadaten

Canonicalhttp://gematik.de/fhir/oegd/stf/OperationDefinition/StfDeleteBundle
Statusactive

Inhalt

Invocations

URL: [base]/Provenance/[id]/$deleteBundle

This operation changes content

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1OperationOutcome

Die vom Server erzeugte Antwort der Löschoperation. Bei einem Fehler wird ein OperationOutcome mit HTTP-Statuscode 422 (Unprocessable Entity)zurückgegeben.

Die Operation löscht alle Ressourcen und gibt als Antwort pro gelöschter Ressource ein 410 Gone zurück. Schlägt die Löschung fehl, wird ein OperationOutcome mit dem HTTP-Statuscode 422 (Unprocessable Entity) zurückgegeben.

<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="StfDeleteBundle" />
<url value="http://gematik.de/fhir/oegd/stf/OperationDefinition/StfDeleteBundle" />
<name value="STF DeleteBundle" />
<title value="Löschen eines STF FHIR-Bundles" />
<status value="active" />
<kind value="operation" />
<experimental value="false" />
<publisher value="ELFA Maßnahme Interoperabilität" />
<description value="Löscht alle Ressourcen, die innerhalb einer Provenance Ressource als `target` referenziert sind, aus dem FHIR-Server. Die Löschung ist final und kein sgn. Soft-Delete." />
<affectsState value="true" />
<code value="deleteBundle" />
<comment value="Die Operation löscht alle Ressourcen und gibt als Antwort pro gelöschter Ressource ein 410 Gone zurück. Schlägt die Löschung fehl, wird ein OperationOutcome mit dem HTTP-Statuscode 422 (Unprocessable Entity) zurückgegeben." />
<resource value="Provenance" />
<system value="false" />
<type value="false" />
<instance value="true" />
<name value="return" />
<use value="out" />
<min value="1" />
<max value="1" />
<documentation value="Die vom Server erzeugte Antwort der Löschoperation. Bei einem Fehler wird ein OperationOutcome mit HTTP-Statuscode 422 (Unprocessable Entity)zurückgegeben." />
<type value="OperationOutcome" />
</parameter>
</OperationDefinition>
{
"resourceType": "OperationDefinition",
"id": "StfDeleteBundle",
"url": "http://gematik.de/fhir/oegd/stf/OperationDefinition/StfDeleteBundle",
"name": "STF DeleteBundle",
"title": "Löschen eines STF FHIR-Bundles",
"status": "active",
"kind": "operation",
"experimental": false,
"publisher": "ELFA Maßnahme Interoperabilität",
"description": "Löscht alle Ressourcen, die innerhalb einer Provenance Ressource als `target` referenziert sind, aus dem FHIR-Server. Die Löschung ist final und kein sgn. Soft-Delete.",
"affectsState": true,
"code": "deleteBundle",
"comment": "Die Operation löscht alle Ressourcen und gibt als Antwort pro gelöschter Ressource ein 410 Gone zurück. Schlägt die Löschung fehl, wird ein OperationOutcome mit dem HTTP-Statuscode 422 (Unprocessable Entity) zurückgegeben.",
"Provenance"
],
"system": false,
"type": false,
"instance": true,
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Die vom Server erzeugte Antwort der Löschoperation. Bei einem Fehler wird ein OperationOutcome mit HTTP-Statuscode 422 (Unprocessable Entity)zurückgegeben.",
"type": "OperationOutcome"
}
]
}