EFA XDS/XDR Binding

Aus Hl7wiki
Implementierungsleitfaden
Wechseln zu: Navigation, Suche
(→‎EFA XDR/XDS Binding: Diagramme hinzugefügt, die Actor-Binding beschreiben)
(Added section for Cross-Community Option (Peer-to-Peer), Fixed constraints and triggers section)
Zeile 21: Zeile 21:
 
<tt>Bitte markieren Sie [[cdaefa:Kommentierung_EFAv2.0|Kommentare]] zu diesem Abschnitt mit dem Code {EDXDg.01}</tt>
 
<tt>Bitte markieren Sie [[cdaefa:Kommentierung_EFAv2.0|Kommentare]] zu diesem Abschnitt mit dem Code {EDXDg.01}</tt>
  
−
[[Datei:EFA-Actor-Bindings.png|583px]]
+
This section specifies the binding of the [[cdaefa:EFA_Dienste|EFA components]] to IHE-ITI actors and the binding of the [[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)|EFA operations]] to IHE-ITI transactions.
  
−
[[Datei:EFA-Actor-Bindings-P2P.png|765px]]
+
The figure below give an overview of the bindings. The EFA actors are depicted as packages. They include the IHE-ITI actors they are bound to. The EFA operations are depicted as lines.
  
−
Within EFA the actors and transactions of the IHE XDS/XDR integration profiles are mapped onto EFA logical services and operations as follows:
+
[[Image:EFA-Actor-Bindings.png|frame|Overview of bindings of actors and operation|none|583px]]
 +
 
 +
In detail, EFA actors SHOULD be bound to IHE-ITI actors as follows:
  
 
{|class="wikitable" style="text-align: left; cellpadding: 10;"
 
{|class="wikitable" style="text-align: left; cellpadding: 10;"
−
!Role
+
!EFA actor
−
!EFA Service Functional Model
+
!IHE-ITI actors
−
!IHE XDS/XDR
+
!Operations
−
!Binding
+
|-
 +
|rowspan="2"|EFA Client
 +
| Document Source
 +
| out-bound: createECR, createPartition, closeECR, registerConsent, provideData
 
|-
 
|-
−
!Actor
+
| Document Consumer
−
|EFA Client
+
| out-bound: listPartitions, listPartitionContents, retrieveData
−
|Document Source (for createECR, createPartition, closeECR, registerConsent, provideData)<br>Document Consumer (for listPartitions, retrieveData)
 
−
| -
 
 
|-
 
|-
−
!Actor
 
 
|EFA Resource Manager
 
|EFA Resource Manager
−
|Document Repository implementing Document Recipient (for createECR, createPartition, closeECR, registerConsent)<br>Document Registry (for listPartitions)
+
|Document Recipient grouped with Document Source
−
| -
+
|in-bound: createECR, closeECR, registerConsent<br>
 +
out-bound: createPartition, provideData
 
|-
 
|-
−
!Actor
 
 
|EFA Document Registry
 
|EFA Document Registry
−
|XDS Document Registry  
+
|Document Registry  
−
| -
+
| in-bound: listPartitions, listPartitionContent, (registerData)
 
|-
 
|-
−
!Actor
 
 
|EFA Document Repository  
 
|EFA Document Repository  
−
|XDS Document Repository (implementing Document Recipient for provideData)
+
|Document Repository
−
| -
+
| in-bound: createPartition, provideData
 +
|}
 +
 
 +
In detail, EFA operations MUST be bound to IHE-ITI transactions as follows:
 +
 
 +
{|class="wikitable" style="text-align: left; cellpadding: 10;"
 +
!EFA Service Functional Model
 +
!IHE XDS/XDR
 +
!Binding
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#createECR|createECR]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#createECR|createECR]]
 
|Provide and Register Document Set ITI-41
 
|Provide and Register Document Set ITI-41
 
|[[cdaefa:EFA_XDS_ResourceManager#EFA_XDS.2FXDR_Binding:_createECR|createECR]]
 
|[[cdaefa:EFA_XDS_ResourceManager#EFA_XDS.2FXDR_Binding:_createECR|createECR]]
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#createPartition|createPartition]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#createPartition|createPartition]]
 
|Provide and Register Document Set ITI-41
 
|Provide and Register Document Set ITI-41
 
|[[cdaefa:EFA_XDS_ResourceManager#EFA_XDS.2FXDR_Binding:_createPartition|createPartition]]
 
|[[cdaefa:EFA_XDS_ResourceManager#EFA_XDS.2FXDR_Binding:_createPartition|createPartition]]
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#closeECR|closeECR]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#closeECR|closeECR]]
 
|Provide and Register Document Set ITI-41
 
|Provide and Register Document Set ITI-41
 
|[[cdaefa:EFA_XDS_ResourceManager#EFA_XDS.2FXDR_Binding:_closeECR|closeECR]]
 
|[[cdaefa:EFA_XDS_ResourceManager#EFA_XDS.2FXDR_Binding:_closeECR|closeECR]]
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#listPartitions|listPartitions]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#listPartitions|listPartitions]]
 
|Registry Stored Query [ITI-18]
 
|Registry Stored Query [ITI-18]
 
|[[cdaefa:EFA_XDS_ResourceManager#EFA_XDS_Binding:_listPartitions|listPartitions]]
 
|[[cdaefa:EFA_XDS_ResourceManager#EFA_XDS_Binding:_listPartitions|listPartitions]]
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#registerConsent|registerConsent]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#registerConsent|registerConsent]]
 
|Provide and Register Document Set ITI-41
 
|Provide and Register Document Set ITI-41
 
|[[cdaefa:EFA_XDS_ResourceManager#EFA_XDS.2FXDR_Binding:_registerConsent|registerConsent]]
 
|[[cdaefa:EFA_XDS_ResourceManager#EFA_XDS.2FXDR_Binding:_registerConsent|registerConsent]]
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#notifyOfConsent|notifyOfConsent]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#notifyOfConsent|notifyOfConsent]]
 
|Document Metadata Notify ITI-53
 
|Document Metadata Notify ITI-53
 
|
 
|
 
|-
 
|-
−
!Transaction
 
−
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#issueAccessToken|issueAccessToken]]
 
−
|
 
−
|
 
−
|-
 
−
!Transaction
 
−
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#redeemAccessToken|redeemAccessToken]]
 
−
|
 
−
|
 
−
|-
 
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#listRecordLocations|listRecordLocations]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#listRecordLocations|listRecordLocations]]
−
|Patient Location Query ITI-56
+
|Cross Gateway Query ITI-38
 
|
 
|
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#registerRecordLocation|registerRecordLocation]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#registerRecordLocation|registerRecordLocation]]
−
|Patient Identity Feed HL7 V3 ITI-44
+
|Provide and Register Document Set-b ITI-41
 
|
 
|
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#registerData|registerData]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#registerData|registerData]]
 
|Register Document Set ITI-42
 
|Register Document Set ITI-42
 
|[[cdaefa:EFA_XDS_DocumentRegistry#EFA_XDS_Binding:_registerData|registerData]]
 
|[[cdaefa:EFA_XDS_DocumentRegistry#EFA_XDS_Binding:_registerData|registerData]]
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#listPartitionContent|listPartitionContent]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#listPartitionContent|listPartitionContent]]
 
|Registry Stored Query ITI-18
 
|Registry Stored Query ITI-18
 
|[[cdaefa:EFA_XDS_DocumentRegistry#EFA_XDS_Binding:_listPartitionContent|listPartitionContent]]
 
|[[cdaefa:EFA_XDS_DocumentRegistry#EFA_XDS_Binding:_listPartitionContent|listPartitionContent]]
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#provideData|provideData]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#provideData|provideData]]
 
|Provide and Register Document Set ITI-41
 
|Provide and Register Document Set ITI-41
 
|[[cdaefa:EFA_XDS_DocumentRepository#EFA_XDS_Binding:_provideData|provideData]]
 
|[[cdaefa:EFA_XDS_DocumentRepository#EFA_XDS_Binding:_provideData|provideData]]
 
|-
 
|-
−
!Transaction
 
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#retrieveData|retrieveData]]
 
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#retrieveData|retrieveData]]
 
|Retrieve Document Set ITI-43
 
|Retrieve Document Set ITI-43
Zeile 124: Zeile 111:
 
|}
 
|}
  
−
=== Constraints and Triggers ===
+
=== Cross-Community Option ===
 +
[[Image:EFA-Actor-Bindings_X-outbound.png|frame|Overview of bindings of Cross-Community Option, out-bound|none|677px]]
  
−
The EFA XDS/XDR Bindings bind multiple operations of the EFA Service Functional Model to the IHE transactions ITI-18 and ITI-41. Thus, the XDS Document Repository or XDS Document Registry must determine the intended binding with the set of constraints that is valid for a request message. All request messages must satisfy
+
[[Image:EFA-Actor-Bindings_X-inbound.png|frame|Overview of bindings of Cross-Community Option, in-bound|none|676px]]
−
* a set of common constraints on the ITI-Transaction and
 
−
* a distinct set of constraint which triggers a binding.
 
−
A ITI-18 request or ITI-41 request is invalid if both conditions are not met. In this case the XDS Document Registry and XDS Document Repository respectively MUST respond with an error.
 
  
−
==== Common constraints on ITI-41 ====
+
=== Constraints and Triggers ===
  
−
* The request MUST contain exactly one XDS Folder.
+
All bindings to the ITI-41 transaction MUST satisfy a set of common constraints and a distinct set of constraints which triggers a certain binding.
−
* The XDS Folder MUST satisfy the [[cdaefa:EFA_XDS_Folder_Metadata_Binding|EFA XDS Folder Metadata Binding]].
 
−
* The request MUST contain at least one XDS Document
 
−
* All XDS Documents MUST satisfy the [[cdaefa:EFA_XDS_Document_Metadata_Binding|EFA XDS Document Metadata Binding]].
 
−
* All XDS Documents MUST be a member of the XDS Folder.
 
−
* The following object types MUST NOT have EFA semantics:
 
−
** SubmissionSet,
 
−
** HasMember (1),
 
−
** HasMember (3) and
 
−
** HasMember (4) (see IHE-ITI-TF-Vol3 4.1.2).
 
  
−
==== Triggers ====
+
The common constraints are:
 +
* The SubmissionSet MUST NOT have EFA semantics.
 +
* The HasMember-Associations MUST reference exactly one XDSFolder.
 +
* The XDSFolder MUST satisfy the [[cdaefa:EFA_XDS_Folder_Metadata_Binding|EFA XDS Folder Metadata Binding]].
 +
* All XDSDocument-Elements MUST be associated with the XDSFolder.
 +
* All XDSDocument-Elements MUST satisfy the [[cdaefa:EFA_XDS_Document_Metadata_Binding|EFA XDS Document Metadata Binding]].
  
−
The distinct sets of constraints for the bindings are defined in the table below (R = required, O = optional, - = forbidden).
+
The distinct sets of constraints are defined in the table below (R = required, O = optional, - = forbidden).
  
 
{|class="wikitable" style="text-align: left; cellpadding: 10;"
 
{|class="wikitable" style="text-align: left; cellpadding: 10;"
 
!Transaction
 
!Transaction
 
!Constraints
 
!Constraints
−
!colspan="5"|Triggers for EFA XDS/XDR bindings
+
!colspan="5"|Triggers for bindings
 
|-
 
|-
−
|rowspan="6"| ITI-41
+
|rowspan="5"| ITI-41
 
|  
 
|  
 
!createECR
 
!createECR
Zeile 161: Zeile 142:
 
!provideData
 
!provideData
 
|-
 
|-
−
|One XDS-Document is a consentInfo which gives a new consent or does not revoke all active consents
+
|One XDSDocument is a consentInfo which gives a new consent or does not revoke all active consents
 
| align="center"|R
 
| align="center"|R
 
| align="center"|-
 
| align="center"|-
Zeile 168: Zeile 149:
 
| align="center"|-
 
| align="center"|-
 
|-  
 
|-  
−
|One XDS-Document is a consentInfo, which revokes all active consents
+
|One XDSDocument is a consentInfo, which revokes all active consents
 
| align="center"|-
 
| align="center"|-
 
| align="center"|R
 
| align="center"|R
Zeile 175: Zeile 156:
 
| align="center"|-
 
| align="center"|-
 
|-
 
|-
−
|The provided XDSFolder and a registered XDSFolder  have the XDSFolder.codeList and XDSFolder.patientID in common (i.e. the EFA exists)
+
|An XDSFolder is provided (uniqueID)
−
| align="center"|-
 
−
| align="center"|R
 
−
| align="center"|R
 
−
| align="center"|R
 
−
| align="center"|R
 
−
|-
 
−
|The XDSFolder is not registered (uniqueID)
 
 
| align="center"|R
 
| align="center"|R
 
| align="center"|O
 
| align="center"|O
Zeile 189: Zeile 163:
 
| align="center"|-
 
| align="center"|-
 
|-
 
|-
−
|The XDSFolder is registered (uniqueID)
+
|An XDSFolder is referenced (uniqueID)
 
| align="center"|-
 
| align="center"|-
 
| align="center"|O
 
| align="center"|O
Zeile 195: Zeile 169:
 
| align="center"|-
 
| align="center"|-
 
| align="center"|R
 
| align="center"|R
−
|-
 
−
|rowspan="3"| ITI-18
 
−
!
 
−
!listPartitions
 
−
!listPartionContent
 
−
!colspan="3"|
 
−
|-
 
−
|Query Name: FindFolders [IHE ITI TF-2a#3.18.4.1.2.3.7.3]
 
−
| align="center"|R
 
−
| align="center"|-
 
−
|colspan="3"|
 
−
|-
 
−
|Query Name: GetFolderAndContents [IHE ITI TF-2a#3.18.4.1.2.3.7.11]
 
−
| align="center"|-
 
−
| align="center"|R
 
−
|colspan="3"|
 
−
|-
 
 
|}
 
|}
  

Version vom 19. Juni 2014, 15:11 Uhr

Logo-hl720.jpg
EFA XDS/XDR Binding
EFA XDS/XDR Binding
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


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 XDR/XDS Binding

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

This section specifies the binding of the EFA components to IHE-ITI actors and the binding of the EFA operations to IHE-ITI transactions.

The figure below give an overview of the bindings. The EFA actors are depicted as packages. They include the IHE-ITI actors they are bound to. The EFA operations are depicted as lines.

Overview of bindings of actors and operation

In detail, EFA actors SHOULD be bound to IHE-ITI actors as follows:

EFA actor IHE-ITI actors Operations
EFA Client Document Source out-bound: createECR, createPartition, closeECR, registerConsent, provideData
Document Consumer out-bound: listPartitions, listPartitionContents, retrieveData
EFA Resource Manager Document Recipient grouped with Document Source in-bound: createECR, closeECR, registerConsent

out-bound: createPartition, provideData

EFA Document Registry Document Registry in-bound: listPartitions, listPartitionContent, (registerData)
EFA Document Repository Document Repository in-bound: createPartition, provideData

In detail, EFA operations MUST be bound to IHE-ITI transactions as follows:

EFA Service Functional Model IHE XDS/XDR Binding
createECR Provide and Register Document Set ITI-41 createECR
createPartition Provide and Register Document Set ITI-41 createPartition
closeECR Provide and Register Document Set ITI-41 closeECR
listPartitions Registry Stored Query [ITI-18] listPartitions
registerConsent Provide and Register Document Set ITI-41 registerConsent
notifyOfConsent Document Metadata Notify ITI-53
listRecordLocations Cross Gateway Query ITI-38
registerRecordLocation Provide and Register Document Set-b ITI-41
registerData Register Document Set ITI-42 registerData
listPartitionContent Registry Stored Query ITI-18 listPartitionContent
provideData Provide and Register Document Set ITI-41 provideData
retrieveData Retrieve Document Set ITI-43 retrieveData

Cross-Community Option

Overview of bindings of Cross-Community Option, out-bound
Overview of bindings of Cross-Community Option, in-bound

Constraints and Triggers

All bindings to the ITI-41 transaction MUST satisfy a set of common constraints and a distinct set of constraints which triggers a certain binding.

The common constraints are:

The distinct sets of constraints are defined in the table below (R = required, O = optional, - = forbidden).

Transaction Constraints Triggers for bindings
ITI-41 createECR closeECR registerConsent createPartition provideData
One XDSDocument is a consentInfo which gives a new consent or does not revoke all active consents R - R - -
One XDSDocument is a consentInfo, which revokes all active consents - R - - -
An XDSFolder is provided (uniqueID) R O O R -
An XDSFolder is referenced (uniqueID) - O O - R
Attention icon.svg Hybrid EFA/non-EFA systems should verify that a request is an EFA request prior to processing it with EFA semantics. Non-EFA requests MUST be rejected with an error message if processed with EFA semantics.

Querverweise und Referenzen

Abgerufen von „https://wiki.hl7.de/index.php?title=cdaefa:EFA_XDS/XDR_Bindings&oldid=18117“