EFA XDS/XDR Binding
(→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> | ||
− | [[ | + | 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. |
− | + | 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. | |
− | + | [[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;" | ||
− | + | !EFA actor | |
− | !EFA | + | !IHE-ITI actors |
− | !IHE | + | !Operations |
− | ! | + | |- |
+ | |rowspan="2"|EFA Client | ||
+ | | Document Source | ||
+ | | out-bound: createECR, createPartition, closeECR, registerConsent, provideData | ||
|- | |- | ||
− | + | | Document Consumer | |
− | | | + | | out-bound: listPartitions, listPartitionContents, retrieveData |
− | | | ||
− | |||
|- | |- | ||
− | |||
|EFA Resource Manager | |EFA Resource Manager | ||
− | |Document | + | |Document Recipient grouped with Document Source |
− | + | |in-bound: createECR, closeECR, registerConsent<br> | |
+ | out-bound: createPartition, provideData | ||
|- | |- | ||
− | |||
|EFA Document Registry | |EFA Document Registry | ||
− | | | + | |Document Registry |
− | | - | + | | in-bound: listPartitions, listPartitionContent, (registerData) |
|- | |- | ||
− | |||
|EFA Document Repository | |EFA Document Repository | ||
− | | | + | |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 | ||
|- | |- | ||
− | |||
|[[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]] | ||
|- | |- | ||
− | |||
|[[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]] | ||
|- | |- | ||
− | |||
|[[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]] | ||
|- | |- | ||
− | |||
|[[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]] | ||
|- | |- | ||
− | |||
|[[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]] | ||
|- | |- | ||
− | |||
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#notifyOfConsent|notifyOfConsent]] | |[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#notifyOfConsent|notifyOfConsent]] | ||
|Document Metadata Notify ITI-53 | |Document Metadata Notify ITI-53 | ||
| | | | ||
|- | |- | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#listRecordLocations|listRecordLocations]] | |[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#listRecordLocations|listRecordLocations]] | ||
− | | | + | |Cross Gateway Query ITI-38 |
| | | | ||
|- | |- | ||
− | |||
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#registerRecordLocation|registerRecordLocation]] | |[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#registerRecordLocation|registerRecordLocation]] | ||
− | | | + | |Provide and Register Document Set-b ITI-41 |
| | | | ||
|- | |- | ||
− | |||
|[[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]] | ||
|- | |- | ||
− | |||
|[[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]] | ||
|- | |- | ||
− | |||
|[[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]] | ||
|- | |- | ||
− | |||
|[[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: | ||
|} | |} | ||
− | === | + | === Cross-Community Option === |
+ | [[Image:EFA-Actor-Bindings_X-outbound.png|frame|Overview of bindings of Cross-Community Option, out-bound|none|677px]] | ||
− | + | [[Image:EFA-Actor-Bindings_X-inbound.png|frame|Overview of bindings of Cross-Community Option, in-bound|none|676px]] | |
− | |||
− | |||
− | |||
− | === | + | === 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 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 | + | 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 | + | !colspan="5"|Triggers for bindings |
|- | |- | ||
− | |rowspan=" | + | |rowspan="5"| ITI-41 |
| | | | ||
!createECR | !createECR | ||
Zeile 161: | Zeile 142: | ||
!provideData | !provideData | ||
|- | |- | ||
− | |One | + | |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 | + | |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"|- | ||
|- | |- | ||
− | | | + | |An XDSFolder is provided (uniqueID) |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| align="center"|R | | align="center"|R | ||
| align="center"|O | | align="center"|O | ||
Zeile 189: | Zeile 163: | ||
| align="center"|- | | align="center"|- | ||
|- | |- | ||
− | | | + | |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 | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
Version vom 19. Juni 2014, 15:11 Uhr
Dieses Dokument gibt wieder:
Implementierungsleitfaden EFA XDS/XDR Binding (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 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.
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
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 SubmissionSet MUST NOT have EFA semantics.
- The HasMember-Associations MUST reference exactly one XDSFolder.
- The XDSFolder MUST satisfy the EFA XDS Folder Metadata Binding.
- All XDSDocument-Elements MUST be associated with the XDSFolder.
- All XDSDocument-Elements MUST satisfy the EFA XDS Document Metadata Binding.
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 |