EFA Anwendungsdienste (logische Spezifikation)
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, Ben Kraufmann
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 |
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.
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. | |
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 |
| |
Ablauf |
| |
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 |
| |
Ablauf |
| |
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 |
| |
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 |
| |
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 |
| |
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 |
| |
Ablauf |
| |
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 |
| |
Fehler und Warnungen |
Folgende Fehler müssen erkannt und zurückgemeldet werden:
|
redeemAccessToken
Bitte markieren Sie Kommentare zu diesem Abschnitt mit dem Code {Enndn.01.01.07}
Operation | redeemAccessToken | |
---|---|---|
Funktionalität | Löst ein Berechtigungstoken ein. Diese Operation änder nicht den Zweck und die Gültigkeit der 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. |
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 | statusInfo | Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen) |
Vorbedingungen |
| |
Ablauf |
| |
Fehler und Warnungen |
Folgende Fehler müssen erkannt und rückgemeldet werden:
|
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 |
| |
Fehler und Warnungen |
Folgende Fehler müssen erkannt und zurückgemeldet werden:
|
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 |
| |
Fehler und Warnungen |
Folgende Fehler müssen erkannt und zurückgemeldet werden:
|
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 |
| |
Ablauf |
| |
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 |
| |
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 |
| |
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 |
| |
Ablauf |
| |
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 |
| |
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
| |
Fehler und Warnungen |
Folgende Fehler müssen erkannt und rückgemeldet werden: |