EFA XDS/XDR Bindings

Aus Hl7wiki
(Teildokument von CDA für die elektronische Fallakte)
Wechseln zu: Navigation, Suche
K (Common constraints on ITI-41)
(Constraints and Triggers)
 
(19 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
{{Infobox Dokument
+
{{DocumentPart
|Title    = EFA XDS/XDR Binding
 
|Short    = EFA XDS/XDR Binding
 
|Namespace = cdaefa
 
|Type      = Implementierungsleitfaden
 
|Version  = 0.9
 
|Submitted = February 2013
 
|Author    = Jörg Caumanns, Raik Kuhlisch
 
|Date      = March 2013
 
|Copyright = 2012-2013
 
|Status    = Draft
 
|Period    = xxx
 
|OID      = n.n.
 
|Realm    = 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.<br>Hinweise zum Kommentierungsverfahren einschließlich aller Formulare und Kontaktadressen finden Sie auf der Seite "[[cdaefa:Kommentierung EFAv2.0|Kommentierung EFAv2.0]]".''
 
''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.<br>Hinweise zum Kommentierungsverfahren einschließlich aller Formulare und Kontaktadressen finden Sie auf der Seite "[[cdaefa:Kommentierung EFAv2.0|Kommentierung EFAv2.0]]".''
 
----
 
----
Zeile 21: Zeile 7:
 
<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>
  
Within EFA the actors and transactions of the IHE XDS/XDR integration profiles are mapped onto EFA logical services and operations as follows:
+
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 [[cdaefa:EFA_Dienste|EFA actors]] MUST 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 Service Functional Model
 
!IHE XDS/XDR
 
!Binding
 
 
|-
 
|-
!Actor
+
|'''EFA actor'''
|EFA Client
+
|'''IHE-ITI actors'''
|Document Source (for createECR, createPartition, closeECR, registerConsent, provideData)<br>Document Consumer (for listPartitions, retrieveData)
+
|'''Operations'''
| -
+
|- style="vertical-align:top;"
 +
|rowspan="2"|EFA Client
 +
|Document Source
 +
|out-bound: createECR, closeECR, registerConsent, createPartition, provideData
 +
|-
 +
|Document Consumer
 +
|out-bound: listPartitions, listPartitionContents, retrieveData
 +
|- style="vertical-align:top;"
 +
|rowspan="5"|EFA Resource Manager
 +
|Document Repository
 +
|in-bound: createECR, closeECR, registerConsent
 +
|-
 +
|Document Source
 +
|out-bound: registerRecordLocation
 +
|-
 +
|Document Recipient
 +
|in-bound: registerRecordLocation
 +
|-
 +
|Initiating Gateway
 +
 
 +
with XDS Affinity Domain Option (see IHE-ITI-TF-Vol1#18.2.1)
 +
|out-bound: listRecordLocations
 +
|-
 +
|Responding Gateway
 +
 
 +
grouped with Document Consumer (see IHE-ITI-TF-Vol1#18.2.3.2)
 +
|in-bound: listRecordLocations
 +
|- style="vertical-align:top;"
 +
|rowspan="3"|EFA Document Registry
 +
|Document Registry
 +
|in-bound: listPartitions, listPartitionContent, registerData
 +
|-
 +
|Initiating Gateway
 +
 
 +
with XDS Affinity Domain Option (see IHE-ITI-TF-Vol1#18.2.1)
 +
|in-bound: listPartitions, listPartitionContent
 +
 
 +
out-bound: listPartitions, listPartitionContent
 +
|-
 +
|Responding Gateway
 +
 
 +
grouped with Document Consumer (see IHE-ITI-TF-Vol1#18.2.3.2)
 +
|in-bound: listPartitions, listPartitionContent
 +
 
 +
out-bound: listPartitions, listPartitionContent
 +
|- style="vertical-align:top;"
 +
|rowspan="3"|EFA Document Repository
 +
|Document Repository
 +
|in-bound: createPartition, provideData, retrieveData
 +
 
 +
out-bound: registerData
 
|-
 
|-
!Actor
+
|Initiating Gateway
|EFA Resource Manager
+
 
|Document Repository implementing Document Recipient (for createECR, createPartition, closeECR, registerConsent)<br>Document Registry (for listPartitions)
+
with XDS Affinity Domain Option (see IHE-ITI-TF-Vol1#18.2.1)
| -
+
|in-bound: retrieveData
 +
 
 +
out-bound: retrieveData
 
|-
 
|-
!Actor
+
|Responding Gateway
|EFA Document Registry
+
 
|XDS Document Registry
+
grouped with Document Consumer (see IHE-ITI-TF-Vol1#18.2.3.2)
| -
+
|in-bound: listPartitions, listPartitionContent
 +
 
 +
out-bound: listPartitions, listPartitionContent
 +
|}
 +
 
 +
{{FAQBox
 +
| There are no contraints on the grouping or composition of EFA actors and IHE-ITI actors.}}
 +
The EFA operations MUST be bound to IHE-ITI transactions as follows:
 +
 
 +
{|class="wikitable" style="text-align: left; cellpadding: 10;"
 
|-
 
|-
!Actor
+
|'''EFA Service Functional Model'''
|EFA Document Repository
+
|'''IHE-ITI Profile'''
|XDS Document Repository (implementing Document Recipient for provideData)
+
|'''Binding'''
| -
 
 
|-
 
|-
!Transaction
+
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#createECR|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]]
|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]]
|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]]
|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]]
|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)#listRecordLocations|listRecordLocations]]
|[[cdaefa:EFA_Document_Registry_SFM#registerData|registerData]]
+
|Cross Gateway Query ITI-38
|Register Document Set ITI-42
+
|[[cdaefa:EFA_XDS_ResourceManager#EFA_IHE-ITI-Binding:_listRecordLocations|listRecordLocations]]
 +
|-
 +
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#registerRecordLocation|registerRecordLocation]]
 +
|Provide and Register Document Set-b ITI-41
 +
|[[cdaefa:EFA_XDS_ResourceManager#EFA_IHE-ITI-Binding:_registerRecordLocation|registerRecordLocation]]
 +
|-
 +
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#registerData|registerData]]
 +
|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_Document_Registry_SFM#listData|listData]]
+
|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:_listData|listData]]
 
 
|-
 
|-
!Transaction
+
|[[cdaefa:EFA_Anwendungsdienste_(logische_Spezifikation)#provideData|provideData]]
|[[cdaefa:EFA_Kommunikationsmuster#Einstellen_von_Dokumenten|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]]
|retrieveData
+
|Retrieve Document Set ITI-43
|Retrieve Document Set ITI-43
 
 
|[[cdaefa:EFA_XDS_DocumentRepository#EFA_XDS_Binding:_retrieveData|retrieveData]]
 
|[[cdaefa:EFA_XDS_DocumentRepository#EFA_XDS_Binding:_retrieveData|retrieveData]]
 
|}
 
|}
 
 
=== Constraints and Triggers ===
 
=== Constraints and Triggers ===
  
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
+
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.
* 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 ====
 
 
 
* The request MUST contain exactly one XDS Folder.
 
* 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.
 
  
==== Triggers ====
+
The common constraints are:
 +
* The SubmissionSet MUST NOT have EFA semantics.
 +
* The HasMember(4)-Associations (SubmissionSet to XDSDocumentEntry) MUST have the SubmissionSetStatus-attribute set to "Original".
 +
* 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
+
!rowspan="2"|Constraints
!Constraints
+
!colspan="5"|Triggers for bindings
!colspan="5"|Triggers for EFA XDS/XDR bindings
 
 
|-
 
|-
|rowspan="6"| ITI-41
 
|
 
 
!createECR
 
!createECR
 
!closeECR
 
!closeECR
Zeile 127: Zeile 161:
 
!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 134: Zeile 168:
 
| 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 141: Zeile 175:
 
| 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 155: Zeile 182:
 
| 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 161: Zeile 188:
 
| align="center"|-
 
| align="center"|-
 
| align="center"|R
 
| align="center"|R
 +
|}
 +
 +
{{AlertBox|
 +
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.}}
 +
 +
=== IHE XDS Options ===
 +
 +
The table below shows which IHE XDS options apply to EFA.
 +
 +
{|class="wikitable"
 +
!XDS Option
 +
!Use for EFA
 +
!Remarks
 +
|-
 +
|Document Replacement
 +
|SHOULD NOT be used
 +
|EFA clients may replace documents within any dedicated peer. In order to minimize complexity of peer-to-peer deployments, this option may only be used for replacing own documents. It must not be used for replacing documents that have been provided to EFA by another user.
 +
|-
 +
|Document Addendum
 +
|MUST NOT be used
 +
|This option does not work for EFA peer-to-peer deployments and therefore must not be used.
 +
|-
 +
|Document Transformation
 +
|MUST NOT be used
 +
|This option does not work for EFA peer-to-peer deployments and therefore must not be used.
 +
|-
 +
|Folder Management
 +
|SHALL be implemented
 +
|EFA access control builds upon folders. Therefore the implementation of this option is indispensible for EFA compliant systems.
 +
|-
 +
|Basic Patient Privacy Enforcement
 +
|MUST NOT be used
 +
|EFA requires full and written consent to be given by the patient. BPPC-style consents must not be used for EFA. Respective requests (e.g. providing or requesting a BPPC document) shall be ignored by all EFA actors.
 +
|-
 +
|Asynchronous Web Services Exchange
 +
|MAY be used
 +
|EFAv2.0 does not constrain the use of this option.
 
|-
 
|-
|rowspan="3"| ITI-18
+
|Reference-ID
!
+
|SHOULD be implemented
!listPartitions
+
|EFA implementations may use the referenceIDList for linking related documents. In this case the FindDocumentsByReferenceId Query may be used for discovering related documents to a given document.
!listData
 
!colspan="3"|  
 
 
|-
 
|-
|Flavor FindFolder
+
|On-Demand Documents
| align="center"|R
+
|MAY be used
| align="center"|-
+
|EFAv2.0 does not constrain the use of this option.
|colspan="3"|
 
 
|-
 
|-
|Flavor GetFolderAndContents
+
|Persistence of Retrieved Documents
| align="center"|-
+
|MAY be used
| align="center"|R
+
|EFAv2.0 does not constrain the use of this option.
|colspan="3"|
 
 
|-
 
|-
 +
|Limited Metadata
 +
|Not applicable because EFA builds upon IHE XDS for which limited metadata is not permitted.
 +
|
 
|}
 
|}
  
{{AlertBox|
 
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 ==
+
----
 +
 
  
 +
{{NoteBox|'''Referenzen und Querverweise'''
 
* [[cdaefa:EFA_Spezifikation_v2.0|EFA-2.0-Spezifikation]]
 
* [[cdaefa:EFA_Spezifikation_v2.0|EFA-2.0-Spezifikation]]
 +
<nowiki></nowiki>
 +
}}

Aktuelle Version vom 14. Februar 2016, 20:57 Uhr

Dieses Material ist Teil des Leitfadens CDA für die elektronische Fallakte.
  • Direkt im Wiki geändert werden sollten Schreibfehler, ergänzende Hinweise.
  • Offene Fragen, die der Diskussionen bedürfen, sollten auf der Diskussionsseite aufgenommen werden.
  • Liste der Seiten dieses Leitfadens: hier, Liste der Seiten, in denen dieses Material verwendet (transkludiert) siehe hier .

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 EFA actors MUST be bound to IHE-ITI actors as follows:

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

with XDS Affinity Domain Option (see IHE-ITI-TF-Vol1#18.2.1)

out-bound: listRecordLocations
Responding Gateway

grouped with Document Consumer (see IHE-ITI-TF-Vol1#18.2.3.2)

in-bound: listRecordLocations
EFA Document Registry Document Registry in-bound: listPartitions, listPartitionContent, registerData
Initiating Gateway

with XDS Affinity Domain Option (see IHE-ITI-TF-Vol1#18.2.1)

in-bound: listPartitions, listPartitionContent

out-bound: listPartitions, listPartitionContent

Responding Gateway

grouped with Document Consumer (see IHE-ITI-TF-Vol1#18.2.3.2)

in-bound: listPartitions, listPartitionContent

out-bound: listPartitions, listPartitionContent

EFA Document Repository Document Repository in-bound: createPartition, provideData, retrieveData

out-bound: registerData

Initiating Gateway

with XDS Affinity Domain Option (see IHE-ITI-TF-Vol1#18.2.1)

in-bound: retrieveData

out-bound: retrieveData

Responding Gateway

grouped with Document Consumer (see IHE-ITI-TF-Vol1#18.2.3.2)

in-bound: listPartitions, listPartitionContent

out-bound: listPartitions, listPartitionContent

The EFA operations MUST be bound to IHE-ITI transactions as follows:

EFA Service Functional Model IHE-ITI Profile 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
listRecordLocations Cross Gateway Query ITI-38 listRecordLocations
registerRecordLocation Provide and Register Document Set-b ITI-41 registerRecordLocation
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

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(4)-Associations (SubmissionSet to XDSDocumentEntry) MUST have the SubmissionSetStatus-attribute set to "Original".
  • 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).

Constraints Triggers for bindings
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

IHE XDS Options

The table below shows which IHE XDS options apply to EFA.

XDS Option Use for EFA Remarks
Document Replacement SHOULD NOT be used EFA clients may replace documents within any dedicated peer. In order to minimize complexity of peer-to-peer deployments, this option may only be used for replacing own documents. It must not be used for replacing documents that have been provided to EFA by another user.
Document Addendum MUST NOT be used This option does not work for EFA peer-to-peer deployments and therefore must not be used.
Document Transformation MUST NOT be used This option does not work for EFA peer-to-peer deployments and therefore must not be used.
Folder Management SHALL be implemented EFA access control builds upon folders. Therefore the implementation of this option is indispensible for EFA compliant systems.
Basic Patient Privacy Enforcement MUST NOT be used EFA requires full and written consent to be given by the patient. BPPC-style consents must not be used for EFA. Respective requests (e.g. providing or requesting a BPPC document) shall be ignored by all EFA actors.
Asynchronous Web Services Exchange MAY be used EFAv2.0 does not constrain the use of this option.
Reference-ID SHOULD be implemented EFA implementations may use the referenceIDList for linking related documents. In this case the FindDocumentsByReferenceId Query may be used for discovering related documents to a given document.
On-Demand Documents MAY be used EFAv2.0 does not constrain the use of this option.
Persistence of Retrieved Documents MAY be used EFAv2.0 does not constrain the use of this option.
Limited Metadata Not applicable because EFA builds upon IHE XDS for which limited metadata is not permitted.