Übersicht über ClaimContacts in Cloud-API

Der folgende Abschnitt enthält eine Übersicht über das ClaimContact-Verhalten, wie es in der Cloud-API vorhanden ist.

ClaimContact-Rollen

Jeder ClaimContact hat ein roles-Array. Dies ist eine schreibgeschützte Liste aller Rollen, die der ClaimContact hat.

Jedes Mitglied des roles-Arrays enthält die folgenden Eigenschaften:

  • relatedTo: der Typ und die ID des Objekts, mit dem der ClaimContact verbunden ist
  • role: die Rolle, die der ClaimContact für dieses Objekt hat
  • active: ein Boolescher Wert, der angibt, ob der ClaimContact die Rolle für den Schadenfall aktiv innehat.

Das active-Feld wird verwendet, um ClaimContacts zu identifizieren, die zuvor eine Rolle für den Schadenfall innehatten, aber nicht mehr aktiv an dem Schadenfall beteiligt sind. Beispiel: Angenommen, eine verletzte Person wird von einem Arzt behandelt, aber dann wird der Fall einem zweiten Arzt zugewiesen. Beide Ärzte könnten ClaimContacts für den Schadenfall sein, aber active wäre nur für den zweiten Arzt auf „true“ gesetzt.

Sie können die Rollen ändern, die ein ClaimContact hat. Dies geschieht jedoch nicht durch Ändern des roles-Arrays. Die Art und Weise, wie dies geschieht, hängt vielmehr davon ab, ob die Rolle reserviert ist oder nicht.

Reservierte Rollen

Eine reservierte Rolle ist eine Rolle, die nicht explizit für einen ClaimContact festgelegt werden kann. Stattdessen muss die Rolle implizit über ein Feld, ein Array oder eine Aktion für ein anderes Objekt festgelegt werden.

Beispielsweise ist reporter (Melder) eine reservierte Rolle. Sie können diese Rolle nicht direkt zu einem ClaimContact hinzufügen. Sie können jedoch das reporter-Feld eines Schadenfalls auf einen bestimmten ClaimContact setzen. Damit wird diesem ClaimContact implizit die Rolle reporter hinzugefügt. Dadurch wird auch die Rolle reporter aus allen anderen ClaimContact-Entitäten entfernt, in denen sie zuvor vorhanden war.

Die reservierten Rollen werden in der Datei ReservedContactRoles.yaml im Verzeichnis integration/contactroles/v1 definiert. Im Allgemeinen sind die reservierten Rollen entweder:

  • Rollen, für die es höchstens einen ClaimContact mit der Rolle geben kann. (Zum Beispiel ist reporter reserviert. Jeder Schadenfall kann maximal einen Melder haben.)
  • Rollen, die über ein Array für ein Nicht-ClaimContact-Objekt festgelegt werden. (Beispielsweise ist witness reserviert. Ein Schadenfall kann mehrere Zeugen haben. Diese Zeugen werden im witnesses-Array der Claim-Ressource definiert.)

Weitere Informationen zum Zuweisen einer reservierten Rolle zu einem ClaimContact finden Sie unter Festlegen reservierter Rollen.

Nicht reservierte Rollen

Eine nicht reservierte Rolle ist eine Rolle, die für einen ClaimContact explizit festgelegt werden kann. Jede Rolle, die nicht in der Datei ReservedContactRoles.yaml aufgeführt ist, ist eine nicht reservierte Rolle. Beispielsweise ist alternativer Kontakt eine nicht reservierte Rolle. Ein Schadenfall kann eine beliebige Anzahl alternativer Kontakte haben, und dieser ClaimContact-Typ wird nicht von einem Array für Claim verwaltet.

Weitere Informationen zum Zuweisen einer nicht reservierten Rolle zu einem ClaimContact finden Sie unter Festlegen nicht reservierter Rollen.

Kennungen

Wenn Sie einen ClaimContact in Nutzdaten angeben, können Sie verschiedene Kennungen verwenden.

  • id: Die System-API-ID des ClaimContact. Dies entspricht der öffentlichen ID des ClaimContact in ClaimCenter.
  • policySystemId: Eine Kennung im Policenverwaltungssystem, der den Kontakt eindeutig identifiziert.
  • refid: Wenn der ClaimContact in bestimmten Nutzdaten erstellt wird, können andere Teile der Nutzdaten mit einer beliebigen „Referenz-ID“ darauf verweisen.

Weitere Informationen zu den verschiedenen Optionen zur Identifizierung eines ClaimContact finden Sie unter Identifizieren des ClaimContact.

ClaimContacts und „Kontakte“ im Vergleich

Der Name der Ressource, die Kontaktinformationen erfasst, lautet ClaimContact. In dieser Dokumentation werden Kontakte, die sich auf Schadenfälle beziehen, als ClaimContacts bezeichnet.

Beachten Sie, dass es Stellen gibt, an denen die Cloud-API den Begriff „Kontakte“ verwendet, um auf ClaimContacts zu verweisen:

  • Bei Endpunkten, die ClaimContact als Stammressource haben, bezeichnet der Endpunktpfad die Ressourcen als „contact“. Zum Beispiel:
    • GET /claim/v1/claims/{claimId}/contacts
    • PATCH /claim/v1/claims/{claimId}/contacts/{contactId}
  • Wenn Sie den include-Abfrageparameter zum Einschließen zugehöriger ClaimContacts verwenden, werden die Ressourcen als „contacts“ bezeichnet. Zum Beispiel:
    • GET /claim/v1/claims?include=contacts

ClaimContact-Endpunkte

Sie können die folgenden Endpunkte verwenden, um direkt mit ClaimContacts zu interagieren:

Vorgang Endpunkt Beschreibung
GET /claims/{claimId}/contacts Abrufen der ClaimContacts für einen angegebenen Schadenfall
POST /claims/{claimId}/contacts Erstellen einer neuen Verknüpfung mit dem angegebenen Schadenfall
GET /claims/{claimId}/contacts/{contactId} Abrufen von Informationen über den angegebenen ClaimContact
PATCH /claims/{claimId}/contacts/{contactId} Aktualisieren von Informationen zu dem angegebenen ClaimContact
DELETE /claims/{claimId}/contacts/{contactId} Löschen des angegebenen ClaimContact
GET /claims/{claimId}/contact-role-owners Abrufen einer Liste von Objekten für den jeweiligen Schadenfall, denen ClaimContacts zugeordnet sein können

Bei reservierten Rollen können Sie einen ClaimContact auch indirekt ändern, indem Sie das Objekt ändern, das die Rolle steuert. Wenn Sie beispielsweise ein PATCH /claims/{claimId} ausführen und das Feld reporter des Schadenfalls auf einen bestimmten ClaimContact festlegen oder ändern, wird dadurch diesem ClaimContact die Rolle reporter zugewiesen.

Der /claims/{claimId}/contact-role-owners-Endpunkt gibt alle Objekte für den Schadenfall zurück, denen ClaimContacts zugeordnet sein können. Dazu gehören:

  • Der Schadenfall selbst
  • Die Police
  • Bestehende Vorfälle
  • Bestehende Teilschäden
  • Bestehende Serviceanforderungen
  • Bestehende Verhandlungen oder Rechtsangelegenheiten
    • Eine Verhandlung bezeichnet die Historie der Angebote und Gegenangebote im Zusammenhang mit einem Streitpunkt des Schadens.
    • Eine Rechtsangelegenheit ist eine Sammlung von Informationen, die ein Gerichtsverfahren bzw. ein potenzielles Gerichtsverfahren betrifft.
Beachten Sie, dass der /claims/{claimId}/contact-role-owners-Endpunkt die Objekte zurückgibt, denen ClaimContacts zugeordnet sein können. Mit diesen Objekten sind möglicherweise bereits ClaimContacts verknüpft. Wenn ClaimContacts mit ihnen verknüpft sind, werden die ClaimContacts nicht in die Antwort eingeschlossen.