EFA Metadata Bindings

Aus Hl7wiki
(Teildokument von CDA für die elektronische Fallakte)
Wechseln zu: Navigation, Suche
(communityID-Attibut der Klasse MountPoint ergänzt.)
K (Mapping for Status of ECRs (Lifecylce) moved to distinct section for better readability.)
Zeile 5: Zeile 5:
  
 
== Mapping of Core Information Model Classes ==
 
== Mapping of Core Information Model Classes ==
−
<tt>Bitte markieren Sie [[cdaefa:Kommentierung_EFAv2.0|Kommentare]] zu diesem Abschnitt mit dem Code {MdaBs.01}</tt>
 
  
−
For the linkage of XDS compliant components with eCR components the following mapping of business objects MUST be implemented:
+
Bitte markieren Sie [[cdaefa:Kommentierung_EFAv2.0|Kommentare]] zu diesem Abschnitt mit dem Code {MdaBs.01}
 +
 
 +
This section defines the XDS-Metadata bindings for the [[cdaefa:EFA_Business_Informationsmodell#EFA_Informationsmodell|classes of the EFA core information model]].
 +
 
 +
The following table describes how EFA classes MUST be mapped to classes and object types of IHE ITI.
  
 
{|class="wikitable" style="text-align: left; cellpadding: 10;"
 
{|class="wikitable" style="text-align: left; cellpadding: 10;"
−
!Electronic Case Record
+
|-
−
!IHE XDS
+
|'''EFA core information model'''
 +
|'''IHE ITI'''
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#Patient|Patient]]
 
|[[cdaefa:EFA_Business_Informationsmodell#Patient|Patient]]
Zeile 17: Zeile 21:
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#Fallakte|eCR CaseRecord]]
 
|[[cdaefa:EFA_Business_Informationsmodell#Fallakte|eCR CaseRecord]]
−
|Set of XDS Folders that have values of XDSFolder.patientID and XDSFolder.codeList in common
+
|Set of Folder-objects, that have values of Folder.patientID and Folder.codeList in common
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#Partition|eCR Partition]]
 
|[[cdaefa:EFA_Business_Informationsmodell#Partition|eCR Partition]]
−
|XDS Folder
+
|Folder
−
|-
 
−
|''no correspondence''
 
−
|XDS Submission Set
 
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#document|eCR Medical Data Object]]
 
|[[cdaefa:EFA_Business_Informationsmodell#document|eCR Medical Data Object]]
−
|XDS Document Entry (document metadata)<br>Repository Object (document data)
+
|DocumentEntry for metadata, Document for binary data
 
|}
 
|}
 +
The object type SubmissionSet of IHE ITI has no corresponding class of the EFA core information model. Therefore, SubmissionSet SHALL be used as specified in IHE ITI but it MUST NOT have EFA semantics.
  
 
== Mapping of PIM Classes ==
 
== Mapping of PIM Classes ==
−
<tt>Bitte markieren Sie [[cdaefa:Kommentierung_EFAv2.0|Kommentare]] zu diesem Abschnitt mit dem Code {MdaBs.01}</tt>
+
 
 +
Bitte markieren Sie [[cdaefa:Kommentierung_EFAv2.0|Kommentare]] zu diesem Abschnitt mit dem Code {MdaBs.01}
 +
 
 +
This section defines the XDS-Metadata bindings for the [[cdaefa:EFA_Business_Informationsmodell#PIM_Data_Structures|classes of the EFA platform independent model]].
  
 
Instances of [[cdaefa:EFA_Business_Informationsmodell#PIM_Data_Structures|ECR PIM Classes]] are shared through XD* transactions and within XD* metadata. The following table shows the respective binding of these classes to IHE XD*  
 
Instances of [[cdaefa:EFA_Business_Informationsmodell#PIM_Data_Structures|ECR PIM Classes]] are shared through XD* transactions and within XD* metadata. The following table shows the respective binding of these classes to IHE XD*  
 
message arguments and ebRS metadata slots/elements.
 
message arguments and ebRS metadata slots/elements.
  
−
{|class="wikitable" style="text-align: left; cellpadding: 10;"
+
{|class="wikitable"
−
!ECR PIM Class
+
|-
−
!IHE XD*
+
|'''EFA PIM'''
−
!Comments
+
|'''IHE ITI Metadata Model'''
 +
|'''Comments'''
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#patientID|patientID]]
 
|[[cdaefa:EFA_Business_Informationsmodell#patientID|patientID]]
−
|XDSDocumentEntry.patientId<br>XDSFolder.patientID
+
|Folder.patientId
−
| -
+
 
 +
DocumentEntry.patientId
 +
|<nowiki>-</nowiki>
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#communityID|communityID]]
 
|[[cdaefa:EFA_Business_Informationsmodell#communityID|communityID]]
−
|XDSDocumentEntry.homeCommunityId<br>XDSFolder.homeCommunityID
+
|DocumentEntry.homeCommunityId
−
| -
+
 
 +
Folder.homeCommunityId
 +
|<nowiki>-</nowiki>
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#purpose|purpose]]
 
|[[cdaefa:EFA_Business_Informationsmodell#purpose|purpose]]
−
|XDSFolder.codeList
+
|Folder.codeList
 
|see [[cdaefa:EFA_XDS_Folder_Metadata_Binding#codeList|XDS Folder Metadata]]
 
|see [[cdaefa:EFA_XDS_Folder_Metadata_Binding#codeList|XDS Folder Metadata]]
−
|-
 
−
|[[cdaefa:EFA_Business_Informationsmodell#ecrInfo|ecrInfo]]
 
−
| see below
 
−
|As there is no correspondence to a case record object with IHE XD* this class is mapped onto folder metadata. This implies that the ecrInfo fraction of all folder's belonging to the same eCR shall be identical and synchronized.
 
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#consentInfo|consentInfo]]
 
|[[cdaefa:EFA_Business_Informationsmodell#consentInfo|consentInfo]]
−
| -
+
|Document
 
|ECR consentInfo objects are represented as structured, coded documents. See [[Patienteneinwilligung|"Leitfaden Patienteneinwilligung"]] for details. The binding of consentInfo is not subject to the EFA Specification. An EFA domain must agree on a specific binding. [http://www.hl7.org/implement/standards/product_brief.cfm?product_id=280|HL7 Implementation Guide for CDA®, Release 2: Consent Directives, Release 1] MAY be used.
 
|ECR consentInfo objects are represented as structured, coded documents. See [[Patienteneinwilligung|"Leitfaden Patienteneinwilligung"]] for details. The binding of consentInfo is not subject to the EFA Specification. An EFA domain must agree on a specific binding. [http://www.hl7.org/implement/standards/product_brief.cfm?product_id=280|HL7 Implementation Guide for CDA®, Release 2: Consent Directives, Release 1] MAY be used.
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#consentDoc|consentDoc]]
 
|[[cdaefa:EFA_Business_Informationsmodell#consentDoc|consentDoc]]
−
| -
+
|Document
 
|Consent documents are represented as documents of a format that is to be agreed by each ECR domain (e.g. PDF/A).
 
|Consent documents are represented as documents of a format that is to be agreed by each ECR domain (e.g. PDF/A).
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#partitionID|partitionID]]
 
|[[cdaefa:EFA_Business_Informationsmodell#partitionID|partitionID]]
−
|XDSFolder.uniqueID
+
|Folder.uniqueId
 
|see IHE ITI TF Vol3 section 4.1.9.1 for details
 
|see IHE ITI TF Vol3 section 4.1.9.1 for details
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#partitionList|partitionList]]
 
|[[cdaefa:EFA_Business_Informationsmodell#partitionList|partitionList]]
−
|set of XDSFolder objects
+
|set of Folder objects
−
| -
+
|<nowiki>-</nowiki>
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]]
 
|[[cdaefa:EFA_Business_Informationsmodell#ecrRef|ecrRef]]
−
|XDSFolder.patientID and XDSFolder.codeList and XDSFolder.homeCommunityID
+
|Folder.patientId
−
|All folders classified with the same patient ID and [[cdaefa:EFA_XDS_Folder_Metadata_Binding#codeList|purpose codes]] set up a unique case record. The homeCommunityID signals the XDS Affinity Domain where the reference is valid.
+
 
 +
Folder.codeList
 +
 
 +
Folder.homeCommunityId
 +
|Folders that have the same patient ID and the same [[cdaefa:EFA_XDS_Folder_Metadata_Binding#codeList|purpose codes]] form a distinct case record. The homeCommunityId indicates the XDS Affinity Domain where the reference is valid.
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#partitionInfo|partitionInfo]]
 
|[[cdaefa:EFA_Business_Informationsmodell#partitionInfo|partitionInfo]]
−
|XDSFolder object
+
|Folder
 
|see [[cdaefa:EFA_XDS_Folder_Metadata_Binding|XDS Folder Metadata]] for details
 
|see [[cdaefa:EFA_XDS_Folder_Metadata_Binding|XDS Folder Metadata]] for details
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#docMetadata|docMetadata]]
 
|[[cdaefa:EFA_Business_Informationsmodell#docMetadata|docMetadata]]
−
|XDSDocument registry object
+
|DocumentEntry
 
|see [[cdaefa:EFA_XDS_Document_Metadata_Binding|XDS Document Metadata]] for details
 
|see [[cdaefa:EFA_XDS_Document_Metadata_Binding|XDS Document Metadata]] for details
 
|-
 
|-
 
|[[cdaefa:EFA_Business_Informationsmodell#docRelationship|docRelationship]]
 
|[[cdaefa:EFA_Business_Informationsmodell#docRelationship|docRelationship]]
−
|XDS Association object
+
|Document Relationship
 
|see Append and Replace in IHE ITI TF-3#4.1.2
 
|see Append and Replace in IHE ITI TF-3#4.1.2
 
|-
 
|-
 
|rowspan="2"|[[cdaefa:EFA_Business_Informationsmodell#documentID|documentID]]
 
|rowspan="2"|[[cdaefa:EFA_Business_Informationsmodell#documentID|documentID]]
−
|XDSDocument.uniqueID<br>XDSDocument.repositoryUniqueID
+
|DocumentEntry.uniqueId
−
| shall be used for document retrieval (retrieveDocument transaction).
 
−
|-
 
−
|XDSDocument.entryUUID
 
−
| shall be used for document referral (associations between registry entries)
 
−
|}
 
−
 
 
−
 
 
−
=== ecrInfo ===
 
  
−
{| class="wikitable"
+
DocumentEntry.repositoryUniqueId
−
!Attribute
+
|shall be used for document retrieval (retrieveDocument transaction).
−
!Description
 
−
!Mapping onto IHE XD* metadata
 
−
|-
 
−
|[[cdaefa:EFA_Business_Informationsmodell#patientID|patientID]] (mandatory)
 
−
|Identifier of the patient who is subject to the eCR
 
−
|All XDS folders representing the partitions of an eCR instance shall be assigned the same ''patientID'' attribute (see [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#page=41&zoom=auto,88,270 IHE ITI TF Volume 3, Section 4.2.3.1.3]).
 
−
|-
 
−
|[[#purpose|purpose]] (mandatory)
 
−
|purpose for maintaining the eCR
 
−
|All XDS folders representing the partitions of an eCR instance shall be classified with the same purpose (see [[cdaefa:EFA_XDS_Folder_Metadata_Binding#codeList|folder metadata ''codeList'' element]]).  
 
−
|-
 
−
|ecrStatus (mandatory)
 
−
|Status of an eCR instance
 
−
|The status of en eCR is implemented through the eCR access policy and the avaibalility status of the XDS folders that represent the partitions of the ecR. 
 
−
{| class="wikitable"
 
−
!status
 
−
!XDS folder availabilityStatus
 
−
!eCR Access Policy
 
−
|-
 
−
|open
 
−
|approved
 
−
|access policy reflects the patient's consent
 
 
|-
 
|-
−
|suspended
+
|DocumentEntry.entryUUID
−
|approved
+
|shall be used for document referral (associations between registry entries)
−
|access policy only allows access to the case record manager and to privacy commissionars
 
−
|-
 
−
|retired
 
−
|approved
 
−
|deny-all access policy assigned to the eCR.
 
−
|-
 
−
|archived
 
−
| -
 
−
|all eCR data and metadata have been deleted from the XDS registry and repository
 
−
|}
 
 
|}
 
|}
−
 
−
 
−
{{NoteBox
 
−
| According to IHE ITI TF volume 3, the deprecation of Folders is not allowed. Therefore this value shall always be Approved. Nevertheless eCR takes this attribute into account as future versions of the ITI technical framework may allow for further options.}}
 
 
=== MountPoint ===
 
=== MountPoint ===
  
−
Instances of the ECR PIM class MountPoint SHALL be bound to XDSDocumentEntry as follows:
+
Instances of the EFA PIM class MountPoint SHALL be bound to DocumentEntry as follows:
  
 
{|class="wikitable"
 
{|class="wikitable"
Zeile 152: Zeile 118:
 
|-
 
|-
 
|patientID
 
|patientID
−
|XDSDocumentEntry.patientId
+
|DocumentEntry.patientId
 
|
 
|
 
|-
 
|-
 
|sourcePatientID
 
|sourcePatientID
−
|XDSDocumentEntry.sourcePatientId
+
|DocumentEntry.sourcePatientId
 
|
 
|
 
|-
 
|-
 
|communityID
 
|communityID
−
|XDSDocumentEntry.homeCommunityId
+
|DocumentEntry.homeCommunityId
 
|
 
|
 
|}
 
|}
−
The XDSDocumentEntry SHALL be a member of a XDSFolder. This XDSFolder SHALL have a codeList-Classification containing
+
The DocumentEntry SHALL be a member of a Folder. This Folder SHALL have a codeList classification containing
  
 
*(code="ECR-mountpoint", codeSystem="IHE-D-Cookbook-FolderClassCode") and
 
*(code="ECR-mountpoint", codeSystem="IHE-D-Cookbook-FolderClassCode") and
 
*a [[cdaefa:EFA_XDS_Folder_Metadata_Binding#codeList|purpose code]].
 
*a [[cdaefa:EFA_XDS_Folder_Metadata_Binding#codeList|purpose code]].
 +
== Mapping of the Lifecylce ==
 +
 +
The lifecylce of an electronic case record MUST be implemented by means of access policies. The states of the lifecycle MUST correspond to access policies and system configuration as follows:
 +
 +
;Open:The access policy implements the patient's consent.
 +
;Suspended:The access policy implements the patient's consent with the exception that only the consented case record manager and their substitutes are authorized.
 +
;Retired:No access policy permits access to the case record.
 +
;Archived:No XDS metadata and no documents reside in the EFA system.
 +
{{FAQBox
 +
| The IHE ITI TF-3 states that the value of the XDS attribute Folder.availabilityStatus must always be Approved. Therefore, the lifecycle of case records does not correspond to this XDS attribute.}}
 +
 
== Querverweise und Referenzen ==
 
== Querverweise und Referenzen ==
  
 
* [[cdaefa:EFA_Spezifikation_v2.0|EFA-2.0-Spezifikation]]
 
* [[cdaefa:EFA_Spezifikation_v2.0|EFA-2.0-Spezifikation]]

Version vom 17. Oktober 2014, 13:25 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 unter den einzelnen Überschriften in geschweiften Klammern angegebenen Kürzel 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".

Mapping of Core Information Model Classes

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

This section defines the XDS-Metadata bindings for the classes of the EFA core information model.

The following table describes how EFA classes MUST be mapped to classes and object types of IHE ITI.

EFA core information model IHE ITI
Patient Patient
eCR CaseRecord Set of Folder-objects, that have values of Folder.patientID and Folder.codeList in common
eCR Partition Folder
eCR Medical Data Object DocumentEntry for metadata, Document for binary data

The object type SubmissionSet of IHE ITI has no corresponding class of the EFA core information model. Therefore, SubmissionSet SHALL be used as specified in IHE ITI but it MUST NOT have EFA semantics.

Mapping of PIM Classes

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

This section defines the XDS-Metadata bindings for the classes of the EFA platform independent model.

Instances of ECR PIM Classes are shared through XD* transactions and within XD* metadata. The following table shows the respective binding of these classes to IHE XD* message arguments and ebRS metadata slots/elements.

EFA PIM IHE ITI Metadata Model Comments
patientID Folder.patientId

DocumentEntry.patientId

-
communityID DocumentEntry.homeCommunityId

Folder.homeCommunityId

-
purpose Folder.codeList see XDS Folder Metadata
consentInfo Document ECR consentInfo objects are represented as structured, coded documents. See "Leitfaden Patienteneinwilligung" for details. The binding of consentInfo is not subject to the EFA Specification. An EFA domain must agree on a specific binding. Implementation Guide for CDA®, Release 2: Consent Directives, Release 1 MAY be used.
consentDoc Document Consent documents are represented as documents of a format that is to be agreed by each ECR domain (e.g. PDF/A).
partitionID Folder.uniqueId see IHE ITI TF Vol3 section 4.1.9.1 for details
partitionList set of Folder objects -
ecrRef Folder.patientId

Folder.codeList

Folder.homeCommunityId

Folders that have the same patient ID and the same purpose codes form a distinct case record. The homeCommunityId indicates the XDS Affinity Domain where the reference is valid.
partitionInfo Folder see XDS Folder Metadata for details
docMetadata DocumentEntry see XDS Document Metadata for details
docRelationship Document Relationship see Append and Replace in IHE ITI TF-3#4.1.2
documentID DocumentEntry.uniqueId

DocumentEntry.repositoryUniqueId

shall be used for document retrieval (retrieveDocument transaction).
DocumentEntry.entryUUID shall be used for document referral (associations between registry entries)

MountPoint

Instances of the EFA PIM class MountPoint SHALL be bound to DocumentEntry as follows:

ECR PIM MountPoint attribute IHE XDS Metadata Attribute Comments
patientID DocumentEntry.patientId
sourcePatientID DocumentEntry.sourcePatientId
communityID DocumentEntry.homeCommunityId

The DocumentEntry SHALL be a member of a Folder. This Folder SHALL have a codeList classification containing

  • (code="ECR-mountpoint", codeSystem="IHE-D-Cookbook-FolderClassCode") and
  • a purpose code.

Mapping of the Lifecylce

The lifecylce of an electronic case record MUST be implemented by means of access policies. The states of the lifecycle MUST correspond to access policies and system configuration as follows:

Open
The access policy implements the patient's consent.
Suspended
The access policy implements the patient's consent with the exception that only the consented case record manager and their substitutes are authorized.
Retired
No access policy permits access to the case record.
Archived
No XDS metadata and no documents reside in the EFA system.
Faq.svg The IHE ITI TF-3 states that the value of the XDS attribute Folder.availabilityStatus must always be Approved. Therefore, the lifecycle of case records does not correspond to this XDS attribute.

Querverweise und Referenzen

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