{
  "openapi": "3.0.1",
  "info": {
    "title": "VIRD PseudonymisationService",
    "version": "v1"
  },
  "paths": {
    "/api/v1/pseudonym/generate": {
      "post": {
        "tags": [
          "Pseudonym"
        ],
        "summary": "Generiert für die übergebenen Patientendaten eine Transfernummer, mit dessen Hilfe die Pseudonyme für diesen Datensatz abgerufen werden können.",
        "requestBody": {
          "description": "Die Patientendaten, für die die Transfernummer generiert werden soll",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PatientCaseData"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Die Operation wurde erfolgreich abgeschlossen",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignedTransfernumber"
                }
              }
            }
          },
          "400": {
            "description": "Es wurden ungültige Daten gesendet"
          },
          "401": {
            "description": "Es ist ein Fehler mit der Authentifizierung aufgetreten"
          },
          "500": {
            "description": "Es ist ein interner Fehler bei der Verarbeitung aufgetreten"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "PatientCaseData": {
        "required": [
          "idDatensatz",
          "idKrankenversicherung",
          "idVersicherter"
        ],
        "type": "object",
        "properties": {
          "idVersicherter": {
            "pattern": "^[A-Z]{1}[0-9]{9}$",
            "type": "string",
            "description": "Definiert die Identifikationsnummer des Versicherten. Für gesetzlich versicherte Patienten ist dies die eGK-Nummer.  Der Wert muss einer gültigen KVNR entsprechen."
          },
          "idDatensatz": {
            "pattern": "^[a-zA-Z0-9.\\-]{3,40}$",
            "type": "string",
            "description": "Definiert die Datensatz-Id des betroffenen Falls. Der Wert muss einer gültigen Datensatz-Id entsprechen."
          },
          "idKrankenversicherung": {
            "pattern": "^[0-9]{9}$",
            "type": "string",
            "description": "Definiert die Id der Krankenversicherung des Versicherten. Der Wert muss einer gültigen IK-Nummer entsprechen."
          },
          "signature": {
            "type": "string",
            "description": "Signatur des SHA256-Hash des Datenpaketes, die mit dem privaten Schlüssel des Einsenders gebildet wird (TI-PKI).  Die Signatur muss als DER-Sequenz abgebildet sein.",
            "format": "byte"
          },
          "subjectPublicKeyInfo": {
            "type": "string",
            "description": "Der öffentliche Teil des verwendeten Signaturschlüssels.  Dieser kann entweder von einer Organisation (SMC-B) oder einer Person stammen (Heilberufeausweis, HBA).",
            "format": "byte"
          }
        },
        "additionalProperties": false,
        "description": "Definiert die Daten zu einem Implantatseingriff zu einem Patienten"
      },
      "SignedTransfernumber": {
        "type": "object",
        "properties": {
          "transfernumber": {
            "type": "string",
            "description": "Verschlüsselte Transfernummer",
            "format": "byte"
          },
          "signature": {
            "type": "string",
            "description": "ECDSA-Signatur des SHA256-Hash des Datenpaketes, die mit dem privaten Schlüssel der Vertrauensstelle gebildet wird (TI-PKI).  Die Signatur wird als DER-Sequenz abgebildet.",
            "format": "byte"
          }
        },
        "additionalProperties": false
      }
    }
  }
}