EFA Anwendungsdienste (logische Spezifikation)

Aus Hl7wiki
Implementierungsleitfaden
Wechseln zu: Navigation, Suche
(Operation "registerRecordLocation" hinzugefügt)
(issueAccessToken)
Zeile 420: Zeile 420:
 
|-
 
|-
 
|Funktionalität
 
|Funktionalität
| colspan="2"|Diese Operation stellt ein Berechtigungstoken aus. Der Patient kann damit einen Arzt als Teilnehmer der Fallakte registrieren. Erteilte Einwilligung, Zweck und Gültigkeit der Akte werden nicht verändert.  
+
| colspan="2"|Diese Operation stellt ein Berechtigungstoken für eine Fallakte aus. Zu dem Berechtigungstoken gehört eine Redeem-Policy, die beim Policy Provider registriert wird. Die EFA-Berechtigungsregel der Fallakte wird durch diese Operation nicht verändert.
 
|-
 
|-
 
|Aufrufer
 
|Aufrufer
Zeile 430: Zeile 430:
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]]
 
|[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]]
|Eindeutige Identifizierung der Fallakte, zu der ein Berechtigungstoken abgerufen werden soll.
+
|Eindeutige Identifizierung der Fallakte, für die ein Berechtigungstoken ausgestellt werden soll.
 
|-
 
|-
 
|Rückgabe
 
|Rückgabe
 
|[[cdaefa:EFA_Security_Informationsmodell#accessToken|accessToken]]
 
|[[cdaefa:EFA_Security_Informationsmodell#accessToken|accessToken]]
|Berechtigungstoken, dessen Einlösung den einlösenden Leistungserbringer zum Zugriff auf eine Fallakte berechtigt.
+
|Ein Berechtigungstoken, das den Leistungserbringer, der es einreicht, zum Zugriff auf die Fallakte berechtigt.
 
|-
 
|-
 
|Vorbedingungen
 
|Vorbedingungen
 
| colspan="2"|
 
| colspan="2"|
* Die bestehende Einwilligung der Fallakte lässt die Nutzung von Berechtigungstoken zu.
 
 
|-
 
|-
 
|Ablauf
 
|Ablauf
 
| colspan="2"|
 
| colspan="2"|
Der Ressource Manager ...
+
# Erzeuge eine Berechtigungstoken-Kennung. Sie enthält die communityID dieses EFA-Providers und eine randomisierte, eindeutige Kennung. Siehe EFA-1.2 Offline-Token-Spezifikation.
# ... generiert einen Proof-Schlüssel (Geheimnis, etc.) anhand dessen beim Einreichen des Berechtigungstoken die Authentizität des Token validiert werden kann
+
# Erzeuge eine Redeem-Policy. (Einschränkung Rolle, Fachbereich, HCP-Identität, Verfallsdatum). Verknüpfe Sie mit der Kennung des Berechtigungstokens. Registriere die Redeem-Policy beim Policy-Provider.
# ... erzeugt ggf. eine Token-Redeem-Policy, die definiert, wer (Rolle, Fachbereich, etc.) das Token einreichen darf
+
# Erzeuge eine Berechtigungsregel. Sie sagt aus, welche Rechte der Einlöser des Berechtiungstoken erhält. Verknüpfe die Berechtigungsregel mit der Fallakte (ecrRef). Registriere die Berechtigungsregel beim Policy Provider.
# ... erzeugt eine Token-Access-Policy, die definiert, welche Berechtigungen an den Einreicher des Tokens vergeben werden
+
# Gib die Kennung des Berechtigungstokens dem Aufrufer.
# ... kapselt Informationen zur Fallakte und Proof-Schlüssel in einem Berechtigungstoken ([[cdaefa:EFA_Security_Informationsmodell#accessToken|accessToken]]-Objekt)
 
# ... registriert das erzeugte accessToken mitsamt Proof-Schlüssel und zugehörigen Poicies (z.B. im Policy Provider)
 
# ... liefert ein Berechtigungstoken an das aufrufende System zurück
 
 
|-
 
|-
 
|Fehler und Warnungen
 
|Fehler und Warnungen

Version vom 29. März 2014, 11:43 Uhr


Anmerkung: Die Kürzel unter den einzelnen Überschriften dienen der Unterstützung des Kommentierungsverfahrens. Bitte geben Sie bei einem Kommentar oder einem Verbesserungsvorschlag zu dieser Spezifikation immer das Kürzel des Abschnitts an, auf den sich Ihr Kommentar bezieht. Alle Kommentare werden in der Lasche "Diskussion" zu der kommentierten Seite gesammelt und gegenkommentiert.
Hinweise zum Kommentierungsverfahren einschließlich aller Formulare und Kontaktadressen finden Sie auf der Seite "Kommentierung EFAv2.0".


EFA Anwendungsarchitektur: Service Functional Model

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01}

Die nachfolgende Tabelle listet zu den EFA-Kommunikationsmustern die zu deren Umsetzung benötigten Operationen auf. Die Gesamtheit dieser Operationen bildet das Service Functional Model der EFA-Anwendungsarchitektur, d.h. liefert eine vollständige plattformunabhängige Beschreibung der technisch umzusetzenden EFA-Funktionalität.

Kommunikationsmuster Operation (logisch) Umsetzender Dienst (logisch)
Anlegen einer Fallakte createECR EFA Ressource Manager
Anlegen einer Partition zu einer bestehenden Fallakte createPartition EFA Ressource Manager
Schließen einer Fallakte closeECR EFA Ressource Manager
Auflisten von Partitionen listPartitions EFA Ressource Manager
Registrierung einer neuen Einwilligung registerConsent EFA Ressource Manager
Verteilen einer Einwilligung im EFA-Verbund notifyOfConsent EFA Ressource Manager
Anfordern eines Berechtigungstoken issueAccessToken EFA Ressource Manager
Einlösen eines Berechtigungstoken redeemAccessToken EFA Ressource Manager
listRecordLocations EFA Ressource Manager
registerRecordLocation EFA Ressource Manager
Einstellen von Dokumenten provideData EFA Document Repository
registerData EFA Document Registry
Auflisten von Dokumenten (einer Partition) listPartitionContent EFA Document Registry
Abrufen von Dokumenten retrieveData EFA Document Repository

Das Zusammenspiel von Diensten und Operationen ist in der folgenden Darstellung noch einmal im Überblick dargestellt.

EFA AppArch Transaktionen.png

Die gestrichelt dargestellten internen Operationsaufrufe vom Ressource Manager zu den anderen Diensten sind optional in dem Sinne als dass die geforderte Funktionalität der Speicherung und Registrierung von Einwilligungen und Einwilligungsdokumenten auch über interne Mechanismen des EFA-Providers erfolgen kann.

Für alle Operationen gilt:

  • Der vom Teilnehmersystem übermittelte Sicherheitskontext muss gültig, vollständig, authentisch und von einer vertrauenswürdigen Stelle für den Aufrufer ausgestellt worden sein.
  • Der EFA-Dienst muss den Aufrufer anhand des Eingabeparameters context authentifizieren können.
  • Die beteiligten Systeme schreiben einen Audit-Trail.

Operationen des EFA Ressource Manager

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01}

Der EFA Ressource Manager muss die in diesem Abschnitt enthaltenen Operationen implementieren.

createECR

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.01}

Operation createECR
Funktionalität Diese Operation erzeugt eine Fallakte. Wenn die Fallakte für den Patienten und für den Zweck bereits besteht, werden die bestehende und die neue Fallakte fusioniert. Die Einwilligung der bestehenden Fallakte wird invalidiert und mit der neuen Einwilligung ersetzt.
Aufrufer EFA-Teilnehmersystem der gleichen EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
ecrInfo Identifizierende und beschreibende Daten zur anzulegenden Fallakte.
patientID
Die ID des Patienten, für den die Fallakte angelegt werden soll.
purpose
Der Zweck für den die Fallakte angelegt werden soll. Er muss mit dem Zweck übereinstimmen, der im Eingabe-Parameter consentInfo angegeben ist.
ecrStatus
muss bei der Neuanlage einer EFA immer "offen" sein.
consentInfo Das strukturierte Dokument, das die Einwilligung des Patienten für die Anlage der Fallakte abbildet.
consentDoc (optional) Sofern die Einwilligungserklärung des Patienten als (gescanntes) elektronisches Dokument vorliegt, kann diese bei der Anlage der Akte direkt in die Akte eingestellt werden.
Rückgabe statusInfo Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
partitionID Eindeutige ID der initial zu der neuen Akte angelegten Partition. Mit Hilfe dieser ID kann der EFA-Teilnehmer weitere Operationen, wie z.B. das Einstellen von Dokumenten in die Fallakte, durchführen.
Vorbedingungen
  • Das übergebene consentInfo Dokument ist konsistent:
    • Die Angaben zum betroffenen Patient stimmen mit den verfügbaren Informationen zum Besitzer der übergebenen Patienten-ID überein.
    • Sofern ein Zweck benannt ist, stimmt dieser mit dem bei der EFA-Anlage benannten Zweck überein.
    • Es ist ein Gültigkeitsdatum benannt.
    • Die EFA Teilnehmer sind benannt.
    • Sofern im consentInfo ein Fallaktenmanager identifiziert ist, stimmt dieser mit der im EFA-Netzwerk für diese Rolle benannten Person überein (die Festlegung des Fallaktenmanagers erfolgt nicht durch den Patienten und muss daher nicht zwingend in den kodierten Informationen zur Einwilligung enthalten sein).
Ablauf
  1. Übersetze das consentInfo-Dokument in eine EFA-Berechtigungsregel.
  2. Registriere die EFA-Berechtigungsregel beim Policy Provider.
  3. Erzeuge eine Partition. Verknüpfe sie mit ecrRef.
  4. Konfiguriere die Metadaten der Partition (partitionInfo).
  5. Verknüpfe consentInfo und consentDoc mit der Partition (partitionID).
  6. Wenn eine Fallakte für patientID und purpose (ecrRef) existiert:
    1. Beachte die Fehlersituation Prohibited Merge.
    2. Ersetze (docRelationship) das bestehende consentInfo und consentDoc mit dem neuen consentInfo und consentDoc.
  7. Speichre und registriere consentInfo und consentDoc bei Document Repository und Document Registry.
  8. Gib die Kennung der neuen Partition (partitionID) und den Status dem Aufrufer.
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

createPartition

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.02}

Operation createPartition
Funktionalität Diese Operation erzeugt eine Partition für eine bestehende Fallakte.
Aufrufer EFA-Teilnehmersystem der gleichen EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
ecrRef Eindeutige Identifizierung der Fallakte, zu der die Partition hinzugefügt werden soll.
partitionInfo Metadaten zu der neu anzulegenden Partition (Titel, etc.)
initialDoc (optional) Bei der Anlage einer Partition können initial in diese Partition einzustellende Dokumente mit übergeben werden.
Rückgabe statusInfo Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
partitionID Eindeutige ID der neu angelegten Partition. Mit Hilfe dieser ID kann der EFA-Teilnehmer weitere Operationen, wie z.B. das Einstellen von Dokumenten in diese Partition, durchführen.
Vorbedingungen
  • Die übergebenen Metadaten der anzulegenden Partition sind vollständig und valide.
Ablauf
  1. Erzeuge eine Partition. Verknüpfe sie mit dem Eingabeparametern ecrRef und partitionInfo.
  2. Verknüpfe initialDoc mit der Partition (partitionID).
  3. Speichre und registriere initialDoc bei Document Repository und Document Registry.
  4. Gib die Kennung der neuen Partition (partitionID) und den Status dem Aufrufer.
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

closeECR

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.03}

Operation closeECR
Funktionalität Schließt eine Fallakte. Sie wechselt in den Status "Gesperrt" und ist nur für Fallaktenmanager verfügbar.
Aufrufer EFA-Teilnehmersystem der gleichen EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
ecrRef Eindeutige Identifizierung der Fallakte, die geschlossen werden soll.
consentInfo Angaben zum Grund für das Schließen der Fallakte (z.B. Rücknahme der Einwilligung durch den Patienten).
consentDoc (optional) Sofern die Schließung der Akte auf eine Änderung der Einwilligung zurückzuführen ist, kann eine elektronische Version des entsprechenden Dokuments mit übergeben werden. Hierdurch ist auch nach dem Schließen der Akte der Grund für diese Operation noch nachvollziehbar.
Rückgabe statusInfo Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
Vorbedingungen
Ablauf
  1. Ändere den Status der Fallakte (ecrStatus) auf "Gesperrt".
  2. Übersetze das consentInfo-Dokument in eine EFA-Berechtigungsregel.
  3. Registriere die EFA-Berechtigungsregel beim Policy Provider.
  4. Verknüpfe consentInfo und consentDoc mit einer Partition (partitionID) der Fallakte.
  5. Ersetze (docRelationship) das bestehende consentInfo und consentDoc mit dem neuen consentInfo und consentDoc.
  6. Speichre und registriere consentInfo und consentDoc bei Document Repository und Document Registry.
  7. Gib statusInfo dem Aufrufer.
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

listPartitions

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.04}

Operation listPartitions
Funktionalität Diese Operation listet die Informationen aller Partitionen (und deren übergeordneten Fallakte) auf, zu denen der Aufrufer über die vom betroffenen Patienten gegebenen Einwilligungen zugangsberechtigt ist.
Aufrufer
  • EFA-Teilnehmersystem der gleichen EFA-Provider-Domäne,
  • Ressource Manager einer benachbarten EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
patientID Die ID des betroffenen Patienten.
purpose (optional) Einschränkung der Suche auf Akten und Partitionen, die zu einem bestimmten Zweck angelegt wurden.
Rückgabe statusInfo Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
partitionList Liste von nach übergeordneten Fallakten strukturierten Partitionen des Patienten, die im Ergebnis der Suchanfrage gefunden wurden.
Vorbedingungen
Ablauf
  1. Identifiziere alle Partitionen,
    1. die mit den Eingabeparametern patientID und purpose verknüpft sind und
    2. für welche der Aufrufer (context) zugriffsberechtigt ist.
  2. Erstelle das partitionList-Objekt für diese Partitionen.
  3. Gib partitionList und statusInfo dem Aufrufer.
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

registerConsent

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.05}

Operation registerConsent
Funktionalität Registriert eine neue Patienteneinwilligung für eine bestehende Fallakte. Zweck, Gültigkeitsdauer und Teilnehmerkreis der Akte werden gemäß der neuen Einwilligung festgesetzt. Die zuvor gültige Einwilligung wird invalidiert.
Aufrufer EFA-Teilnehmersystem der gleichen EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
ecrRef Eindeutige Identifizierung der Fallakte, zu der eine neue Einwilligung vorliegt.
consentInfo Angaben zur neuen Einwilligung auf deren Basis Zweck, Gültigkeitsdauer und Teilnehmerkreis der Akte an Änderungen in der Behandlungsorganisation oder der Behandlungssituation angepasst werden sollen.
consentDoc (optional) Eine ggf. verfügbare elektronische Version des Einwilligungsdokuments kann im Rahmen dieser Operation zur Ablage in der Akte übergeben werden.
Rückgabe statusInfo Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
Vorbedingungen
  • Das übergebene consentInfo Dokument ist konsistent:
    • Es ist ein Gültigkeitsdatum benannt.
    • Die EFA Teilnehmer sind benannt.
    • Die Angaben zu den Rollen der Teilnehmer ermöglichen eine Zuordnung der Teilnehmer zu mit konkreten Zugriffsrechten hinterlegten EFA-Rollen.
Ablauf
  1. Passe ecrRef.purpose der Partitionen der Fallakte an den Zweck der neuen Einwilligung an.
  2. Übersetze das consentInfo-Dokument in eine EFA-Berechtigungsregel.
  3. Registriere die EFA-Berechtigungsregel beim Policy Provider.
  4. Verknüpfe consentInfo und consentDoc mit einer Partition (partitionID) der Fallakte.
  5. Ersetze (docRelationship) das bestehende consentInfo und consentDoc mit dem neuen consentInfo und consentDoc.
  6. Speichre und registriere consentInfo und consentDoc bei Document Repository und Document Registry.
  7. Gib statusInfo an den Aufrufer.
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

notifyOfConsent

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.08}

Operation notifyOfConsent
Funktionalität Benachrichtigt den EFA Ressource Manager über ein consentInfo-Dokument, das bei einem benachbarten EFA-Provider registriert wurde.
Aufrufer Ressource Manager einer benachbarten EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
ecrRef Eindeutige Identifizierung der Fallakte, zu der eine neue Einwilligung vorliegt.
documentID Die Referenz des consentInfo-Dokuments.
Rückgabe
Vorbedingungen
Ablauf
  1. Rufe die Operation retrieveData des Document Repository auf, das im Eingabe-Parameter documentID referenziert ist.
  2. Identifiziere die Fallakte, die das abgerufene consentInfo-Dokument referenziert.
  3. Übersetze das consentInfo-Dokument in eine EFA-Berechtigungsregel.
  4. Passe die bestehende EFA-Berechtigungsregel beim Policy Provider an.
Fehler und Warnungen

Folgende Fehler müssen erkannt und zurückgemeldet werden:

  • Gemeinsame Fehler und Warnungen.
  • Der Eingabe-Parameter documentID referenziert kein consentInfo-Dokument.
  • Die im consentInfo-Dokument referenzierte Fallakte existiert nicht.

issueAccessToken

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.06}

Operation issueAccessToken
Funktionalität Diese Operation stellt ein Berechtigungstoken für eine Fallakte aus. Zu dem Berechtigungstoken gehört eine Redeem-Policy, die beim Policy Provider registriert wird. Die EFA-Berechtigungsregel der Fallakte wird durch diese Operation nicht verändert.
Aufrufer EFA-Teilnehmersystem der gleichen EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
ecrRef Eindeutige Identifizierung der Fallakte, für die ein Berechtigungstoken ausgestellt werden soll.
Rückgabe accessToken Ein Berechtigungstoken, das den Leistungserbringer, der es einreicht, zum Zugriff auf die Fallakte berechtigt.
Vorbedingungen
Ablauf
  1. Erzeuge eine Berechtigungstoken-Kennung. Sie enthält die communityID dieses EFA-Providers und eine randomisierte, eindeutige Kennung. Siehe EFA-1.2 Offline-Token-Spezifikation.
  2. Erzeuge eine Redeem-Policy. (Einschränkung Rolle, Fachbereich, HCP-Identität, Verfallsdatum). Verknüpfe Sie mit der Kennung des Berechtigungstokens. Registriere die Redeem-Policy beim Policy-Provider.
  3. Erzeuge eine Berechtigungsregel. Sie sagt aus, welche Rechte der Einlöser des Berechtiungstoken erhält. Verknüpfe die Berechtigungsregel mit der Fallakte (ecrRef). Registriere die Berechtigungsregel beim Policy Provider.
  4. Gib die Kennung des Berechtigungstokens dem Aufrufer.
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

redeemAccessToken

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.07}

Operation redeemAccessToken
Funktionalität Einlösen eines Berechtigungstoken, über das ein Patient einen weiteren Arzt als Teilnehmer zur Nutzung einer bestehenden Fallakte berechtigen kann. Erteilte Einwilligung, Zweck und Gültigkeit der Akte werden von dieser Operation nicht berührt.
Aufrufer EFA-Teilnehmersystem der gleichen EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
patientID Die ID des Patienten in der Affinity Domain des Arztes, der das Token einreicht.
accessToken Über die Operation issueAccessToken ausgestelltes Berechtigungstoken, mit dem der Einreicher als Teilnehmer an der im Token kodierten Fallakte registriert werden soll.
Rückgabe subjectAccessPolicy Berechtigungspolicy für den neuen EFA-Teilnehmer. Die Berechtigungspolicy kann von dem Teilnehmer über das Client-Policy-Push Verfahren unmittelbar zum Zugriff auf die Akte genutzt werden.
Vorbedingungen
  • Die Fallakte ist im Zustand "offen".
  • Der Aufrufer verfügt über ein gültiges accessToken
Ablauf

Der Ressource Manager ...

  1. ... validiert den im Token kodierten Proof-Schlüssel (Geheimnis, etc.) um die Authentizität des Tokens sicherzustellen
  2. ... validiert die Identitätsdaten des Einreichers gegen eine ggf. erzeugte Redeem-Policy, um sicherzustellen, dass der Einreicher dieses Token einlösen darf
  3. ... verknüpft Fallakte und ID des Einreichers mit der hinterlegten Token-Access-Policy, die definiert, welche Berechtigungen an den Einreicher des Tokens vergeben werden
  4. ... registriert die erzeugte Policy am Policy Provider
  5. ... ruft vom Policy Provider die gültige subjectAccessPolicy des Einreichers ab
  6. ... liefert die subjectAccessPolicy an das aufrufende System zurück
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

  • Gemeinsame Fehlermeldungen und Warnungen
  • Die Einwilligung zu der Fallakte lässt keine Ad-Hoc-Autorisierungen über Berechtigungstoken zu. (Fehler)
  • Die Redeem-Policy schließt den Einreicher von der Einlösung des Berechtigungstoken aus. (Fehler)

listRecordLocations

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.09}

Operation listRecordLocations
Funktionalität Listet die an einer Fallakte beteiligten EFA-Provider-Domänen auf.
Aufrufer Ressource Manager einer benachbarten EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
ecrRef Referenziert die Fallakte, deren EFA-Provider-Domänen aufgelistet werden sollen.
Rückgabe communityID* Liste der Kennungen der EFA-Provider-Domänen
Vorbedingungen
Ablauf
  1. Identifiziere die EFA-Provider, die an der Fallakte beteiligt sind.
  2. Gib die Liste Kennungen dieser EFA-Provider dem Aufrufer.
Fehler und Warnungen

Folgende Fehler müssen erkannt und zurückgemeldet werden:

  • Gemeinsame Fehler und Warnungen.
  • Der Sicherheitskontext enthält kein Access Policy Token, das von diesem EFA-Provider ausgestellt wurde.

registerRecordLocation

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.10}

Operation registerRecordLocation
Funktionalität Registriert eine EFA-Provider-Domäne als weiteren Speicherort für Partitionen einer Fallakte. Beim Aufrufer wurde ein Offline-Token eingereicht, das vom aufgerufenen EFA-Provider ausgestellten worden ist.
Aufrufer Ressource Manager der EFA-Provider-Domäne, in der das Offline-Token eingereicht wurde.
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
ecrRef Referenziert die Fallakte, für die das Offline-Token gilt.
communityID Kennungen der EFA-Provider-Domänen, bei der das Offline-Token eingereicht wurde.
Rückgabe statusInfo Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
Vorbedingungen
Ablauf
  1. Verknüpfe und speichre den Eingabeparameter ecrRef mit der ecrRef-Instanz des accessPolicyToken.
Fehler und Warnungen

Folgende Fehler müssen erkannt und zurückgemeldet werden:

  • Gemeinsame Fehler und Warnungen.
  • Der Sicherheitskontext enthält kein Access Policy Token, das von diesem EFA-Provider ausgestellt wurde.

Operationen des EFA Document Registry

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.02}

Die EFA Document Registry muss die in diesem Abschnitt enthaltenen Operationen implementieren.

registerData

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.02.01}

Operation registerData
Funktionalität Diese Operation registriert von Daten an einer bestehenden Partition einer Fallakte.
Aufrufer Document Repository der gleichen EFA-Provider-Domäne. Die Absicherung der Kommunikation durch einen zwischen beiden Diensten gespannten Sicherheitskontext ist Aufgabe des EFA-Providers und kann mit EFA-unabhängigen Mechanismen realisiert werden.
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
partitionID Eindeutige Identifizierung der Partition, an der die Daten registriert werden sollen.
docMetadata[1..*] Metadaten der bereits im Document Repository abgelegten Daten, die am Document Registry registriert werden sollen.
docRelationship[0..*] Beziehungen der neu zu registrierenden Daten zu bestehenden Dokumenten. Diese müssen so registriert werden, dass sie bei der Auflistung von Dokumenten mit bereit gestellt werden können.
Rückgabe statusInfo Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
Vorbedingungen
  • Die übergebenen Metadaten der einzustellenden Daten sind vollständig und valide.
  • Die Konfiguration der angesprochenen Akte erlaubt das Einstellen der übergebenen Dokumente.
Ablauf
  1. Speichre docMetadata, docRelationship und den Bezug zu partitionID.
  2. Gib das statusInfo-Objekt dem Aufrufer.
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

listPartitionContent

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.02.02}

Operation listPartitionContent
Funktionalität Diese Operation gibt die Liste der Dokumente, die in einer Partition enthalten sind, zurück. Die Liste enthält die Dokument-Metadaten und Dokument-Beziehungen.
Aufrufer
  • EFA-Teilnehmersystem der gleichen EFA-Provider-Domäne,
  • Document Registry einer benachbarten EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
partitionID Eindeutige Identifizierung der Partition, deren Inhalte ausgelesen werden sollen.
Rückgabe docMetadata[0..*] Metadaten der an der ausgewählten Partition registrierten Dokumente
docRelationship[0..*] Beziehungen zwischen den Dokumenten der zu listenden Partition und Dokumenten dieser und anderer Partitionen.
Vorbedingungen
Ablauf
  1. Identifiziere alle Dokumente,
    1. die mit partitionID verknüpft sind und
    2. für welche der Aufrufer (context) zugriffsberechtigt ist.
  2. Identifiziere alle Dokument-Beziehungen dieser Dokumente.
  3. Gib die Metadaten der Dokumente und deren Dokument-Beziehungen dem Aufrufer.
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

Operationen des EFA Document Repository

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.03}

Das EFA Document Repository muss die in diesem Abschnitt enthaltenen Operationen implementieren.

provideData

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.03.01}

Operation provideData
Funktionalität Diese Operation stellt Daten in eine Partition einer Fallakte ein.
Aufrufer EFA-Teilnehmersystem der gleichen EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
partitionID Eindeutige Identifizierung der Partition, in die die Daten eingestellt werden sollen.
document[1..*] In die Partition einzustellende Dokumente mitsamt ihrer Metadaten.
docRelationship[0..*] Beziehungen der neu zu registrierenden Daten zu bestehenden Dokumenten.
Rückgabe statusInfo Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
Vorbedingungen
  • Die übergebenen Metadaten der einzustellenden Daten sind vollständig und valide.
Ablauf
  1. Speichre die Dokument-Daten.
  2. Rufe die Operation registerData Operation des Document Registry der gleichen Community auf. Übergebe die Eingabeparameter dieser Operation.
  3. Gib das statusInfo-Objekt dem Aufrufer.
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

retrieveData

Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.03.02}

Operation retrieveData
Funktionalität Abrufen von Daten aus einer Fallakte.
Aufrufer
  • EFA-Teilnehmersystem der gleichen EFA-Provider-Domäne,
  • Ressource Manager einer benachbarten EFA-Provider-Domäne
Eingabe context Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager openContext.
documentID Eindeutige Identifizierung der abzurufenden Dokumente
Rückgabe statusInfo Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
docData[0..n] angeforderte Dokumente
Vorbedingungen
Ablauf

Das Document Repository

  1. ... ruft die angefragten Dokumente aus dem sicheren Dokumentenspeicher ab.
  2. ... sendet eine Information zum Ausführungsstatus der Operation sie wie die angefragten Dokumente an den Nutzer zurück.
Fehler und Warnungen

Folgende Fehler müssen erkannt und rückgemeldet werden:

Querverweise und Referenzen