EFA Document Repository Service Functional Model

Aus Hl7wiki
Implementierungsleitfaden
Wechseln zu: Navigation, Suche
K (→‎provideData)
(→‎provideData)
 
(3 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 41: Zeile 41:
 
| colspan="2"|Einstellen von Daten in eine bestehende Partition einer Fallakte.
 
| colspan="2"|Einstellen von Daten in eine bestehende Partition einer Fallakte.
 
|-
 
|-
−
| rowspan="3"|Eingabe
+
| rowspan="4"|Eingabe
 
|[[cdaefa:EFA_Security_Informationsmodell#context|context]]
 
|[[cdaefa:EFA_Security_Informationsmodell#context|context]]
 
|Das Einstellen von Daten in eine Partition muss innerhalb eines Sicherheitskontextes erfolgen, in dem der die Anlage der Partition initierende Arzt identifizierbar und in seiner Authentizität überprüfbar ist. Mit dem Parameter context wird der vorab über die Operation ''openContext'' des ''EFA Kontext Managers'' erstellte Sicherheitskontext so an den EFA-Provider übergeben, dass dieser den Kontext provider-seitig zur Prüfung der Berechtigungen des Aufrufers innerhalb des Aufrufkontextes rekonstruieren kann.
 
|Das Einstellen von Daten in eine Partition muss innerhalb eines Sicherheitskontextes erfolgen, in dem der die Anlage der Partition initierende Arzt identifizierbar und in seiner Authentizität überprüfbar ist. Mit dem Parameter context wird der vorab über die Operation ''openContext'' des ''EFA Kontext Managers'' erstellte Sicherheitskontext so an den EFA-Provider übergeben, dass dieser den Kontext provider-seitig zur Prüfung der Berechtigungen des Aufrufers innerhalb des Aufrufkontextes rekonstruieren kann.
Zeile 50: Zeile 50:
 
|[[cdaefa:EFA_Business_Informationsmodell#document|document]][1..*]
 
|[[cdaefa:EFA_Business_Informationsmodell#document|document]][1..*]
 
|In die Partition einzustellende Dokumente mitsamt ihrer Metadaten.
 
|In die Partition einzustellende Dokumente mitsamt ihrer Metadaten.
 +
|-
 +
|[[cdaefa:EFA_Business_Informationsmodell#docRelationship|docRelationship]][0..*]
 +
|Beziehungen der neu zu registrierenden Daten zu bestehenden Dokumenten.
 
|-
 
|-
 
|Rückgabe
 
|Rückgabe
 
|statusInfo
 
|statusInfo
 
|Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
 
|Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
 +
|-
 +
|Vorbedingungen
 +
| colspan="2"|
 +
* Der Sicherheitskontext ist gültig und vollständig. Die Angaben zur Nutzeridentität sind authentisch.
 +
* Die Ziel-Partition ist einer Fallakte zugeordnet.
 +
* Für die mit der Ziel-Partition verbundene Akte (Zweckbindung) sind zum Aktenzugang berechtigte Teilnehmer und deren Rollen definiert. Der Nutzer ist berechtigter Teilnehmer. Die Teilnehmerrolle berechtigt zum Einstellen von Daten in die Akte.
 +
* Der Nutzer ist berechtigt, bei dem EFA-Provider, der die Partition verwaltet, Daten einzustellen.
 +
* Die Metadaten der einzustellenden Dokumente sind vollständig und valide.
 +
* Sofern bestehende Dokumente aktualisiert oder ergänzt werden: Die Ziele der Dokumentbeziehungen sind valide.
 +
|-
 +
|Ablaufsequenz
 +
| colspan="2"|
 +
# Das Document Repository stellt sicher, dass die Vorbedingungen erfüllt sind.
 +
# Das Document Repository legt alle übergebenen Dokumente in einem sicheren Dokumentenspeicher ab.
 +
# Das Document Repository initiert die [[cdaefa:EFA_Document_Registry_SFM|registerData]] Operation mit den übergebenen Metadaten und Beziehungen beim Document Registry.
 +
# Das Document Repository schreibt einen Audit Trail Eintrag über die Ausführung der Operation.
 +
# Das Document Repository sendet eine Information zum Ausführungsstatus der Operation an den Nutzer zurück.
 +
|-
 +
| rowspan="4"|Mögliche, für diese Operation spezifische Fehler
 +
|unbekannte Partition
 +
|Die angegebene Ziel-Partition ist nicht existent, keine EFA-Partition oder für den Nutzer nicht zugreifbar.
 +
|-
 +
|Unvollständige Metadaten
 +
|Die übergebenen Metadaten sind nicht vollständig (z.B. weil ein verpflichtendes Datenfeld nicht belegt ist). In der Fehlermeldung sollen die Dokumente benannte werden, deren Metadaten unvollständig sind.
 +
|-
 +
|Invalide Metadaten
 +
|In den Metadaten werden Vorgaben zu den zu verwendenden Codesystemen verletzt. In der Fehlermeldung sollen die Dokumente benannte werden, deren Metadaten falsch kodiert sind.
 +
|-
 +
|Invalide Objektreferenzen
 +
|In Dokumentenbeziehungen referenzierte Dokumente existieren nicht oder sind nicht Bestandteil der Fallakte.
 +
|}
 +
 +
== ''retrieveData'' ==
 +
 +
{|class="wikitable" style="text-align: left; cellpadding: 10;"
 +
!Operation
 +
! colspan="2"|retrieveData
 +
|-
 +
|Funktionalität
 +
| colspan="2"|Abrufen von Daten aus einer Fallakte.
 +
|-
 +
| rowspan="2"|Eingabe
 +
|[[cdaefa:EFA_Security_Informationsmodell#context|context]]
 +
|Das Abrufen von Daten muss innerhalb eines Sicherheitskontextes erfolgen, in dem der die Anlage der Partition initierende Arzt identifizierbar und in seiner Authentizität überprüfbar ist. Mit dem Parameter context wird der vorab über die Operation ''openContext'' des ''EFA Kontext Managers'' erstellte Sicherheitskontext so an den EFA-Provider übergeben, dass dieser den Kontext provider-seitig zur Prüfung der Berechtigungen des Aufrufers innerhalb des Aufrufkontextes rekonstruieren kann.
 +
|-
 +
|[[cdaefa:EFA_Business_Informationsmodell#documentID|documentID]]
 +
|Eindeutige Identifizierung der abzurufenden Dokumente
 +
|-
 +
| rowspan="2"|Rückgabe
 +
|statusInfo
 +
|Informationen zur Durchführung der Operation (z.B. aufgetretene Fehler oder für die weitere EFA-Nutzung potenziell relevante Warnungen)
 +
|-
 +
|[[cdaefa:EFA_Business_Informationsmodell#docData|docData]][0..n]
 +
|angeforderte Dokumente
 
|-
 
|-
 
|Vorbedingungen
 
|Vorbedingungen
Zeile 69: Zeile 126:
 
|descr
 
|descr
 
|}
 
|}
−
 
  
  

Aktuelle Version vom 8. April 2013, 21:11 Uhr

Logo-hl720.jpg
EFA Document Repository Service Functional Model
EFA Document Repository Service Functional Model
Implementierungsleitfaden
vorgelegt von:
February 2013
Jörg Caumanns, Raik Kuhlisch
Draft
Version: 0.9
Datum: March 2013
Status: xxx
Verfahren: {{{Verfahren}}}
Realm: Flag de.svg Deutschland
Copyright © 2012-2013: HL7 Deutschland


Operationen des EFA Document Repository

Die nachfolgende Tabelle listet die vom EFA Document Repository (ECR Document Repository) bereit gestellten Operationen sowie die damit realisierbaren Kommunikationsmuster.

Operation Kommunikationsmuster
provideData Einstellen von Dokumenten
retrieveData Abrufen von Dokumenten

In den folgenden Abschnitten werden diese Operationen plattform-unabhängig über das Service Functional Model des EFA Document Repository spezifiziert.

provideData

Operation provideData
Funktionalität Einstellen von Daten in eine bestehende Partition einer Fallakte.
Eingabe context Das Einstellen von Daten in eine Partition muss innerhalb eines Sicherheitskontextes erfolgen, in dem der die Anlage der Partition initierende Arzt identifizierbar und in seiner Authentizität überprüfbar ist. Mit dem Parameter context wird der vorab über die Operation openContext des EFA Kontext Managers erstellte Sicherheitskontext so an den EFA-Provider übergeben, dass dieser den Kontext provider-seitig zur Prüfung der Berechtigungen des Aufrufers innerhalb des Aufrufkontextes rekonstruieren kann.
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
  • Der Sicherheitskontext ist gültig und vollständig. Die Angaben zur Nutzeridentität sind authentisch.
  • Die Ziel-Partition ist einer Fallakte zugeordnet.
  • Für die mit der Ziel-Partition verbundene Akte (Zweckbindung) sind zum Aktenzugang berechtigte Teilnehmer und deren Rollen definiert. Der Nutzer ist berechtigter Teilnehmer. Die Teilnehmerrolle berechtigt zum Einstellen von Daten in die Akte.
  • Der Nutzer ist berechtigt, bei dem EFA-Provider, der die Partition verwaltet, Daten einzustellen.
  • Die Metadaten der einzustellenden Dokumente sind vollständig und valide.
  • Sofern bestehende Dokumente aktualisiert oder ergänzt werden: Die Ziele der Dokumentbeziehungen sind valide.
Ablaufsequenz
  1. Das Document Repository stellt sicher, dass die Vorbedingungen erfüllt sind.
  2. Das Document Repository legt alle übergebenen Dokumente in einem sicheren Dokumentenspeicher ab.
  3. Das Document Repository initiert die registerData Operation mit den übergebenen Metadaten und Beziehungen beim Document Registry.
  4. Das Document Repository schreibt einen Audit Trail Eintrag über die Ausführung der Operation.
  5. Das Document Repository sendet eine Information zum Ausführungsstatus der Operation an den Nutzer zurück.
Mögliche, für diese Operation spezifische Fehler unbekannte Partition Die angegebene Ziel-Partition ist nicht existent, keine EFA-Partition oder für den Nutzer nicht zugreifbar.
Unvollständige Metadaten Die übergebenen Metadaten sind nicht vollständig (z.B. weil ein verpflichtendes Datenfeld nicht belegt ist). In der Fehlermeldung sollen die Dokumente benannte werden, deren Metadaten unvollständig sind.
Invalide Metadaten In den Metadaten werden Vorgaben zu den zu verwendenden Codesystemen verletzt. In der Fehlermeldung sollen die Dokumente benannte werden, deren Metadaten falsch kodiert sind.
Invalide Objektreferenzen In Dokumentenbeziehungen referenzierte Dokumente existieren nicht oder sind nicht Bestandteil der Fallakte.

retrieveData

Operation retrieveData
Funktionalität Abrufen von Daten aus einer Fallakte.
Eingabe context Das Abrufen von Daten muss innerhalb eines Sicherheitskontextes erfolgen, in dem der die Anlage der Partition initierende Arzt identifizierbar und in seiner Authentizität überprüfbar ist. Mit dem Parameter context wird der vorab über die Operation openContext des EFA Kontext Managers erstellte Sicherheitskontext so an den EFA-Provider übergeben, dass dieser den Kontext provider-seitig zur Prüfung der Berechtigungen des Aufrufers innerhalb des Aufrufkontextes rekonstruieren kann.
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
  • prec1
  • prec2
Ablaufsequenz
  1. seq1
  2. seq2
Mögliche Fehler name descr


Abgerufen von „https://wiki.hl7.de/index.php?title=cdaefa:EFA_Document_Repository_SFM&oldid=12705“