EFA Anwendungsdienste (logische Spezifikation)
(→registerConsent: Vorbedingung aus Kommunikationsmuster "Registrieren einer Einwilligung" in die Beschreibung der Operation verschoben.) |
(Redundanz in der Beschreibung der Eingabe-Parameter entfernt.) |
||
Zeile 102: | Zeile 102: | ||
| rowspan="4"|Eingabe | | rowspan="4"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#ecrInfo|ecrInfo]] | |[[cdaefa:EFA_Business_Informationsmodell#ecrInfo|ecrInfo]] | ||
|Identifizierende und beschreibende Daten zur anzulegenden Fallakte. | |Identifizierende und beschreibende Daten zur anzulegenden Fallakte. | ||
;[[cdaefa:EFA_Business_Informationsmodell#patientID|patientID]] | ;[[cdaefa:EFA_Business_Informationsmodell#patientID|patientID]] | ||
− | : | + | :Die ID des Patienten, für den die Fallakte angelegt werden soll. |
;[[cdaefa:EFA_Business_Informationsmodell#purpose|purpose]] | ;[[cdaefa:EFA_Business_Informationsmodell#purpose|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 | ;ecrStatus | ||
:muss bei der Neuanlage einer EFA immer "offen" sein. | :muss bei der Neuanlage einer EFA immer "offen" sein. | ||
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#consentInfo|consentInfo]] | |[[cdaefa:EFA_Business_Informationsmodell#consentInfo|consentInfo]] | ||
− | | | + | |Das strukturierte Dokument, das die Einwilligung des Patienten für die Anlage der Fallakte abbildet. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#consentDoc|consentDoc]] (optional) | |[[cdaefa:EFA_Business_Informationsmodell#consentDoc|consentDoc]] (optional) | ||
Zeile 176: | Zeile 176: | ||
| rowspan="4"|Eingabe | | rowspan="4"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]] | |[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]] | ||
Zeile 233: | Zeile 233: | ||
| rowspan="4"|Eingabe | | rowspan="4"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]] | |[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]] | ||
Zeile 283: | Zeile 283: | ||
| rowspan="3"|Eingabe | | rowspan="3"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#patientID|patientID]] | |[[cdaefa:EFA_Business_Informationsmodell#patientID|patientID]] | ||
− | | | + | |Die ID des betroffenen Patienten. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#purpose|purpose]] (optional) | |[[cdaefa:EFA_Business_Informationsmodell#purpose|purpose]] (optional) | ||
Zeile 331: | Zeile 331: | ||
| rowspan="4"|Eingabe | | rowspan="4"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]] | |[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]] | ||
Zeile 389: | Zeile 389: | ||
| rowspan="2"|Eingabe | | rowspan="2"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]] | |[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]] | ||
Zeile 435: | Zeile 435: | ||
| rowspan="3"|Eingabe | | rowspan="3"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#patientID|patientID]] | |[[cdaefa:EFA_Business_Informationsmodell#patientID|patientID]] | ||
− | |ID des Patienten in der Affinity Domain des Arztes, der das Token einreicht. | + | |Die ID des Patienten in der Affinity Domain des Arztes, der das Token einreicht. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#accessToken|accessToken]] | |[[cdaefa:EFA_Business_Informationsmodell#accessToken|accessToken]] | ||
Zeile 496: | Zeile 496: | ||
| rowspan="4"|Eingabe | | rowspan="4"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#partitionID|partitionID]] | |[[cdaefa:EFA_Business_Informationsmodell#partitionID|partitionID]] | ||
Zeile 548: | Zeile 548: | ||
| rowspan="2"|Eingabe | | rowspan="2"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#partitionID|partitionID]] | |[[cdaefa:EFA_Business_Informationsmodell#partitionID|partitionID]] | ||
Zeile 600: | Zeile 600: | ||
| rowspan="4"|Eingabe | | rowspan="4"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#partitionID|partitionID]] | |[[cdaefa:EFA_Business_Informationsmodell#partitionID|partitionID]] | ||
Zeile 652: | Zeile 652: | ||
| rowspan="2"|Eingabe | | rowspan="2"|Eingabe | ||
|[[cdaefa:EFA_Security_Informationsmodell#context|context]] | |[[cdaefa:EFA_Security_Informationsmodell#context|context]] | ||
− | | | + | |Gibt den Sicherheitskontext vor, in dem die Operation ausgeführt wird. Bezugsquelle: EFA Kontext Manager [[cdaefa:EFA_Context_Manager_SFM#Operation:_OpenContext|''openContext'']]. |
|- | |- | ||
|[[cdaefa:EFA_Business_Informationsmodell#documentID|documentID]] | |[[cdaefa:EFA_Business_Informationsmodell#documentID|documentID]] |
Version vom 5. März 2014, 14:05 Uhr
Dieses Dokument gibt wieder:
Implementierungsleitfaden EFA Anwendungsdienste (logische Spezifikation) (0.9). Die Teilmaterialien gehören der Kategorie cdaefa an. |
February 2013
Jörg Caumanns, Raik Kuhlisch
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".
Inhaltsverzeichnis
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 |
Anfordern eines Berechtigungstoken | issueAccessToken | EFA Ressource Manager |
Einlösen eines Berechtigungstoken | redeemAccessToken | 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.
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.
Operationen des EFA Ressource Manager
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01}
In den folgenden Abschnitten werden die Operationen des EFA Ressource Managers plattform-unabhängig als Service Functional Model spezifiziert. Die folgenden Vorbedingungen müssen für alle Aufrufe an den Ressource Manager erfüllt sein und werden:
- Das aufrufende Teilnehmersystem kann den EFA Ressource Manager lokalisieren und sicher authentifiziern.
- Der vom Teilnehmersystem übermittelte Sicherheitskontext ist gültig, vollständig, authentisch und wurde von einer vertrauenswürdigen Stelle für Aufrufer ausgestellt.
- Der Ressource Manager kann den Aufrufer anhand der im context übermittelten Daten sicher identifizieren und authentifizieren.
- Der Ressource Manager ist technisch in der Lage, einen Audit Trail Eintrag zu schreiben
- Der Ressource Manager verfügt über eine Möglichkeit, mit dem Operationsaufruf ggf. übergebene Daten im Document Repository abzulegen und im Document Registry zu registrieren.
createECR
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.01}
Operation | createECR | |
---|---|---|
Funktionalität | Mit der Operation createECR wird eine neue Fallakte für einen Patienten angelegt. Sofern bereits eine Fallakte zu dem benannten Zweck existiert, wird keine neue Akte angelegt, sondern stattdessen die bestehende Akte um eine Partition erweitert. In diesem Fall wird die bestehende Einwilligung invalidiert und durch die übergebene Einwilligung ersetzt. | |
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. | |
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 |
| |
Ablaufsequenz (logisch) |
Der Ressource Manager ...
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus, sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
Darüber hinaus sind die folgenden Warnungen definiert:
|
createPartition
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.02}
Operation | createPartition | |
---|---|---|
Funktionalität | Anlegen einer neuen Partition zu einer bestehenden Fallakte. | |
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 |
| |
Ablaufsequenz (logisch) |
Der Ressource Manager ...
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
Darüber hinaus sind die folgenden Warnungen definiert:
|
closeECR
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.03}
Operation | closeECR | |
---|---|---|
Funktionalität | Schließen einer bestehenden Fallakte. Die Fallakte geht damit in den "Grace"-Status über. | |
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 |
| |
Ablaufsequenz |
Der Ressource Manager ...
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
|
listPartitions
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.04}
Operation | listPartitions | |
---|---|---|
Funktionalität | Mit der Operation listPartitions werden Informationen zu allen Partitionen (und deren übergeordneten Fallakte) aufgelistet, zu denen der Aufrufer über die vom betroffenen Patienten gegebenen Einwilligungen zugangsberechtigt ist. | |
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 |
| |
Ablaufsequenz (logisch) |
Der Ressource Manager ...
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
|
registerConsent
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.05}
Operation | registerConsent | |
---|---|---|
Funktionalität | Registrierung einer neuen Patienteneinwilligung zu einer bestehenden Fallakte. Zweck, Gültigkeitsdauer und Teilnehmerkreis der Akte werden gemäß der neuen Einwilligung festgesetzt. Alle vorher gegebenen Einwilligungen verlieren damit ihre Gültigkeit, sind aber nach wie vor über die Akte nachvollziehbar. | |
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 |
| |
Ablaufsequenz (logisch) |
Der Ressource Manager ...
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus, sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
|
issueAccessToken
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.06}
Operation | issueAccessToken | |
---|---|---|
Funktionalität | Abrufen 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. | |
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 ein Berechtigungstoken abgerufen werden soll. | |
Rückgabe | accessToken | Berechtigungstoken, dessen Einlösung den einlösenden Leistungserbringer zum Zugriff auf eine Fallakte berechtigt. |
Vorbedingungen |
| |
Ablaufsequenz (logisch) |
Der Ressource Manager ...
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus, sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
|
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. | |
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 |
| |
Ablaufsequenz (logisch) |
Der Ressource Manager ...
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus, sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
|
Operationen des EFA Document Registry
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.02}
In den folgenden Abschnitten werden die Operationen des EFA Document Registry plattform-unabhängig als Service Functional Model spezifiziert. Die folgenden Vorbedingungen müssen für alle Aufrufe an das Document Registry erfüllt sein und werden:
- Das aufrufende Teilnehmersystem kann das EFA Document Registry lokalisieren und sicher authentifizieren.
- Ein aufrufendes Document Repository kann das EFA Document Registry lokalisieren und sicher authentifizieren.
- Der vom Teilnehmersystem übermittelte Sicherheitskontext ist gültig, vollständig, authentisch und wurde von einer vertrauenswürdigen Stelle für den Aufrufer ausgestellt.
- Das Document Registry kann den Aufrufer anhand der im context übermittelten Daten sicher identifizieren und authentifizieren.
- Das Document Registry ist technisch in der Lage, einen Audit Trail Eintrag zu schreiben.
registerData
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.02.01}
Operation | registerData | |
---|---|---|
Funktionalität | Registrieren von Daten an einer bestehenden Partition einer Fallakte. Dies ist eine EFA-Provider interne Funktion, die ausschließlich vom EFA Document Repository aufgerufen wird. 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 |
| |
Ablaufsequenz |
Das Document Registry ...
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus, sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
Zusätzlich sind die folgenden Warnungen definiert:
|
listPartitionContent
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.02.02}
Operation | listPartitionContent | |
---|---|---|
Funktionalität | Abruf der Metadaten zu den an einer Partition einer Fallakte registrierten Dokumenten. | |
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 |
| |
Ablaufsequenz |
Das Document Registry ...
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus, sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
|
Operationen des EFA Document Repository
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.03}
In den folgenden Abschnitten werden die Operationen des EFA Document Repository plattform-unabhängig als Service Functional Model spezifiziert. Die folgenden Vorbedingungen müssen für alle Aufrufe an das Document Repository erfüllt sein und werden:
- Das aufrufende Teilnehmersystem kann das EFA Document Repository lokalisieren und sicher authentifizieren.
- Der Document Repository ist ein Document Registry zugeordnet. Das Document Repository kann dieses Document Registry lokalisieren und sicher authentifizieren.
- Der vom Teilnehmersystem übermittelte Sicherheitskontext ist gültig, vollständig, authentisch und wurde von einer vertrauenswürdigen Stelle für den Aufrufer ausgestellt.
- Das Document Repository kann den Aufrufer anhand der im context übermittelten Daten sicher identifizieren und authentifizieren.
- Das Document Repository ist technisch in der Lage, einen Audit Trail Eintrag zu schreiben
provideData
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.03.01}
Operation | provideData | |
---|---|---|
Funktionalität | Einstellen von Daten in eine bestehende Partition einer Fallakte. | |
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 |
| |
Ablaufsequenz |
Das Document Repository
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus, sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
Zusätzlich sind die folgenden Warnungen definiert:
|
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. | |
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 |
| |
Ablaufsequenz |
Das Document Repository
| |
Fehler und Warnungen |
Über die in Fehlermeldungen und Warnungen definierten Ausnahmesituationen hinaus, sind für diese Operation die folgenden spezifischen Fehlermeldungen definiert:
Zusätzlich sind die folgenden Warnungen definiert:
|