Difference between revisions of "Cross-Enterprise Document Sharing"

From IHE Wiki
Jump to navigation Jump to search
(30 intermediate revisions by the same user not shown)
Line 32: Line 32:
 
* The concept of a document in XDS is not limited to textual information. As XDS is document content neutral, any type of clinical information without regard to content and representation is supported. This makes the XDS IHE Integration Profile equally able to handle documents containing simple text, formatted text (e.g., HL7 CDA Release 1), images (e.g., DICOM) or structured and vocabulary coded clinical information (e.g., CDA Release 2, CCR, CEN ENV 13606, DICOM SR). In order to ensure the necessary interoperability between the document sources and the document consumers, the XDS Affinity Domain must adopt policies concerning document format, structure and content.
 
* The concept of a document in XDS is not limited to textual information. As XDS is document content neutral, any type of clinical information without regard to content and representation is supported. This makes the XDS IHE Integration Profile equally able to handle documents containing simple text, formatted text (e.g., HL7 CDA Release 1), images (e.g., DICOM) or structured and vocabulary coded clinical information (e.g., CDA Release 2, CCR, CEN ENV 13606, DICOM SR). In order to ensure the necessary interoperability between the document sources and the document consumers, the XDS Affinity Domain must adopt policies concerning document format, structure and content.
  
 +
==FAQ==
 +
 +
This is not normative text, but provided informatively due to the frequency that questions are asked.
 +
 +
=== Optimal Query===
 +
(Text originally published in the [[Document Sharing Metadata Handbook]])
 +
 +
The FindDocuments query has 17 query parameters, but 7 of them play a critical role. These parameters are the “critical few”, especially for the initial query that performs the primary filtering (further discussed in Section 3.4) among all available documents for a patient that may be in the thousands with a mature deployment. This primary filtering optimizes the use of query to return the best possible results, avoiding missing any results that should be considered. This favors false-positives (results that are not desired), over false-negatives (missed results). The query results returned include full metadata for each entry found; local refinement of these results (see section 2.2 below) is used to further eliminate these false-positives.
 +
 +
The other 12 parameters may also be used, but the effectiveness of these additional parameters in primary filtering is limited. See section 2.1.2 for further explanation.
 +
 +
Here are the 7 query parameters and metadata attributes that are combined for primary filtering:
 +
 +
* patientId - this is required in XDS/XCA. You must have a Patient ID you are interested in. Use of PIX, PDQ, XCPD, or some other Patient Identity Management system is a prerequisite, that will not be further discussed in this handbook.
 +
* classCode – classCode is used to group documents into logical classes which are useful to primary filtering success. A small number of controlled value set of pre-negotiated code values should be defined to group documents into broad logical 'classifications', designed so that for any use case where someone is looking for documents they can pick one term from this value set.
 +
* practiceSettingCode - this is the clinical specialty where the act that resulted in the document was performed. Like the classCode, this should have been filled with a controlled value set of pre-negotiated code values that represents broad classifications of clinical specialties. By restricting the value set to the high-level clinical specialties, one should avoid the misfiling associated with documents produced by sub-specialties.
 +
* serviceStartTime - serviceStopTime – When there is a timerange of the service event that you are interested, you will query against the serviceStartTime and service StopTime metadata element to find documents that indicate they fit your timerange. .
 +
 +
===service Start to Stop Time===
 +
The service times are specific to the time range of the treatment or episode. This is different than the document creation time, which is when the document was created. The query results will return any document whose “service time” falls within that range. It is important to note that these parameters work together to give a period of time.
 +
 +
Given you are interested in a specific time range (Start -> Stop).
 +
 +
The serviceStartTimeFrom and serviceStopTimeTo are clear they should bound that time with a little slop to deal with poor timeclocks:
 +
* serviceStartTimeFrom parameter in the query should be set to a few minutes before the time you are interested in being the Start of the service time range
 +
* serviceStopTimeTo parameter in the query should be a set to a few minutes after the time you are interested in being in the Stop of the service time range
 +
Some DocumentEntries will have a service start time but not have a service stop time. This is common in chronic care, radiology, and other circumstances where the end of the service has not happened or where the end is unknowable, therefore you should include a query parameter that would eliminate DocumentEntries that have a declared start time well after the time range you are interested in:
 +
* serviceStartTimeTo parameter in the query should be set to a few minutes before the time you are interested in being the Stop of the service time range
 +
Some DocumentEntries will have a service stop time but not a service start time. This is not common, but will happen where there is no clear start time to an observation, therefore you should include a query parameter that would eliminate DocumentEntries that have a declared stop time well before the time range you are interested in:
 +
* serviceStopTimeFrom parameter in the query should be set to a few minutes after the time you are interested in being the Start of the service time range
 +
Some DocumentEntries will have neither service start or stop. These will be returned regardless of any timeframe query parameters.  Your Community Metadata Specification should encourage all metadata publications populate the serviceStartTime and serviceStopTime element as much as possible to avoid false-positive query results.
  
 
==Systems Affected==
 
==Systems Affected==
Line 46: Line 77:
 
==Specification==
 
==Specification==
  
'''Profile Status:''' [[Comments| Final Text]]
+
'''Profile Status:''' [[Comments| Final Text]]  
  
'''Documents:'''  
+
'''Formal Profile Specification:'''  
 
[http://www.ihe.net/Technical_Framework/index.cfm#IT IHE IT Infrastructure Technical Framework Version 2 or later]
 
[http://www.ihe.net/Technical_Framework/index.cfm#IT IHE IT Infrastructure Technical Framework Version 2 or later]
* Vol. 1 -
+
=== Vol. 1 ===
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_Cross_Enterprise_Document_Sh Section 10],  
+
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_Cross_Enterprise_Document_Sh Section 10],  
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=Appendix_E__Cross_Profile_Consi Appendix E Cross Profile Considerations],
+
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_2_1_Document_Replacement_Opt Document Replace Option]
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=Appendix_J__Content_and_Format_ Appendix J Content and Format of XDS Documents],
+
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_2_2_Document_Addendum_Option Document Addendum Option]
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=Appendix_K__XDS_Concept_Details Appendix K XDS Concepts]
+
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_2_3_Document_Transformation_ Document Transformation Option]
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2a.pdf#nameddest=3_18_Registry_Stored_Query__ITI Vol. 2a - Sections 3.18 Registry Stored Query]  
+
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_2_4_Folder_Management_Option Folder Management Option]
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2b.pdf#nameddest=3_41_Provide_and_Register_Docum Vol. 2b - Sections 3.41 Provide and Register Document Set]
+
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_2_5_Asynchronous_Web_Service Asynchronous Web Service Option]
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2b.pdf#nameddest=3_42_Register_Document_Set_b__I Vol. 2b - Sections 3.42 Register Document Set]  
+
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_2_6_Reference_ID_Option Reference ID Option]
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2b.pdf#nameddest=3_43_Retrieve_Document_Set__ITI Vol. 2b - Sections 3.43 Retrieve Document Set]
+
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_2_7_On_Demand_Documents_Opti On-Demand Option]
* Vol. 2x - Appendix A, B, K, L, M, N, V, W
+
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_2_8_Persistence_of_Retrieved Persistence of Retrieved Option]
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_A__Web_Service_Definit Vol. 2x - Appendix A Web Services Definition]
+
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=10_2_9_Basic_Patient_Privacy_En Basic Patient Privacy Enforcement Option]
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_B__Definition_of_Docum Vol. 2x - Appendix B Definition of a Document]
+
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=Appendix_E__Cross_Profile_Consi Appendix E Cross Profile Considerations],
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_K__XDS_Security_Enviro Vol. 2x - Appendix K XDS Security Environment]
+
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=Appendix_J__Content_and_Format_ Appendix J Content and Format of XDS Documents],
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_M__Using_Patient_Demog Vol. 2x - Appendix M Using Patient Demographics Query in a Multi-Domain Environment]
+
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol1.pdf#nameddest=Appendix_K__XDS_Concept_Details Appendix K XDS Concepts]
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_N__Common_Data_Types Vol. 2x - Appendix N Common Datatypes]
+
=== Vol. 2 ===
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_V__Web_Services_for_IH Vol. 2x - Appendix V Web Services for IHE Transactions]
+
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2a.pdf#nameddest=3_18_Registry_Stored_Query__ITI 3.18 Registry Stored Query]  
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_W__Implementation_Mate Vol. 2x - Appendix Implementation Materials]
+
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2b.pdf#nameddest=3_41_Provide_and_Register_Docum 3.41 Provide and Register Document Set]  
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_0_Metadata_used_in_Document_S Vol. 3 - Section 4.0 Metadata used in Document Sharing]
+
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2b.pdf#nameddest=3_42_Register_Document_Set_b__I 3.42 Register Document Set]
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2b.pdf#nameddest=3_43_Retrieve_Document_Set__ITI 3.43 Retrieve Document Set]
 +
 
 +
=== Vol. 2x ===
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_A__Web_Service_Definit Appendix A Web Services Definition]
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_B__Definition_of_Docum Appendix B Definition of a Document]
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_K__XDS_Security_Enviro Appendix K XDS Security Environment]
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_M__Using_Patient_Demog Appendix M Using Patient Demographics Query in a Multi-Domain Environment]
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_N__Common_Data_Types Appendix N Common Datatypes]
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_V__Web_Services_for_IH Appendix V Web Services for IHE Transactions]
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol2x.pdf#nameddest=Appendix_W__Implementation_Mate Appendix W Implementation Materials]
 +
 
 +
=== Vol. 3 ===
 +
excerpts (Not all sub-sections below level 3 are listed here)
 +
 
 +
[http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_0_Metadata_used_in_Document_S Vol. 3 - Section 4.0 Metadata used in Document Sharing]
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_1_Abstract_Metadata_Model  4.1 - Abstract Metadata Model]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_1_1_Metadata_Object_Types 4.1.1 - Metadata Object Types]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_1_2_Association_Types 4.1.2 - Association Types]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_1_3_Metadata_Attributes 4.1.3 - Metadata Object Types]
 +
*** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_1_3_1_The_Purpose_of_Metadata 4.1.3.1 - The Purpose of Metadata]
 +
*** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_1_3_2_DocumentEntry_Metadata_ 4.1.3.2 - DocumentEntry Metadata Attributes]
 +
*** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_1_3_3_SubmissionSet_Metadata_ 4.1.3.3 - SubmissionSet Metadata Attributes]
 +
*** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_1_3_4_Folder_Metadata_Attribu 4.1.3.4 - Folder Metadata Attributes]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_1_4_Submission_Request 4.1.4 - Submission Request]
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_ebRIM_Representation 4.2 - ebRIM Representation]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_1_Metadata_Object_Types 4.2.1 - Metadata Object Types]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_2_Association_Types 4.2.2 - Association Types]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_Metadata_Attributes 4.2.3 - Metadata Attributes]
 +
*** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_General_Information_abo 4.2.3.1 General Information about Metadata Attributes]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_1_Attribute_Value_Lengt Attribute Value Length]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_2_Creating_Coded_Attrib Coded Attributes]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_3_Creating_External_Ide External Identifiers]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_4_Creating_Author_Attri Author Attributes]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_5_UUIDs UUIDs]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_6_Extra_Metadata_Attrib Extra Metadata Attributes]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_7_Metadata_Attribute_Da Metadata Attribute Data Types] aka Table 4.2.3.1.7-2: Data Types (previously Table 4.1-3)
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_8_General_format_of_Doc General format of DocumentEntry, Folder and SubmissionSet Attribute Tables]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_9_Metadata_Attribute_Ca Metadata Attribute Cardinality]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_1_10_classificationScheme classificationScheme vs. classifcationNode]
 +
*** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_DocumentEntry_Attribute 4.2.3.2 DocumentEntry Attributes]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_1_DocumentEntry_author author]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_2_DocumentEntry_availab availabilityStatus]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_3_DocumentEntry_classCo classCode]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_4_DocumentEntry_comment comments]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_5_DocumentEntry_confide confidentialityCode]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_6_DocumentEntry_creatio creationTime]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_7_DocumentEntry_entryUU entryUUID]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_8_DocumentEntry_eventCo eventCodeList]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_9_DocumentEntry_formatC formatCode]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_10_DocumentEntry_hash hash]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_11_DocumentEntry_health healthcareFacilityTypeCode]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_12_DocumentEntry_homeCo homeCommunityId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_13_DocumentEntry_langua languageCode]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_14_DocumentEntry_legalA legalAuthenticator]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_15_DocumentEntry_mimeTy mimeType]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_16_DocumentEntry_patien patientId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_17_DocumentEntry_practi practiceSettingCode]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_18_DocumentEntry_reposi repositoryUniqueId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_19_DocumentEntry_servic serviceStartTime]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_20_DocumentEntry_servic serviceStopTime]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_21_DocumentEntry_size size]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_22_DocumentEntry_source sourcePatientId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_23_DocumentEntry_source sourcePatientInfo]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_24_DocumentEntry_title title]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_25_DocumentEntry_typeCo typeCode]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_26_DocumentEntry_unique uniqueId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_27_DocumentEntry_URI URI]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_28_DocumentEntry_refere referenceIdList]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_29_DocumentEntry_limite limitedMetadata]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_2_30_DocumentEntry_object objectType]
 +
*** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_SubmissionSet_Attribute 4.2.3.3 SubmissionSet Attributes]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_1_SubmissionSet_author author]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_2_SubmissionSet_availab availabilityStatus]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_3_SubmissionSet_comment comment]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_4_SubmissionSet_content contentTypeCode]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_5_SubmissionSet_entryUU entryUUID]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_6_SubmissionSet_homeCom homeCommunityId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_7_SubmissionSet_intende intendedRecipient]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_8_SubmissionSet_patient patientId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_9_SubmissionSet_sourceI sourceId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_10_SubmissionSet_submis submissionTime]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_11_SubmissionSet_title title]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_12_SubmissionSet_unique uniqueId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_3_13__SubmissionSet_limit LimitedMetadata ]
 +
*** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4__Folder_Attributes 4.2.3.4 Folder Attributes]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4_1_Folder_availabilitySt availabilityStats]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4_2_Folder_codeList codeList]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4_3_Folder_comments comments]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4_4_Folder_entryUUID entryUUID]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4_5_Folder_homeCommunityI homeCommunityId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4_6_Folder_lastUpdateTime lastUpdateTime]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4_7_Folder_patientId patientId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4_8_Folder_title title]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4_9_Folder_uniqueId uniqueId]
 +
**** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_3_4_10_Folder_limitedMetada LimitedMetadata ]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_4_Success_and_Error_Reporti 4.2.4 - Success and Error Reporting ]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_2_5_Metadata_Vocabulary 4.2.5 - Metadata Vocabulary ]
 +
* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_3_Additional_Document_Sharing 4.3 - Additional Document Sharing Requirements]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_3_1_Submission_Metadata_Attri 4.3.1 - Submission Metadata Attribute Optionality]
 +
** [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_TF_Vol3.pdf#nameddest=4_3_2_Requirements_on_Query_Typ 4.3.2 - Requirements on Query Type Transactions]
 +
 
 +
=== Additional ===
 +
[[IHE Format Codes]] vocabulary
  
 
'''CDA mapping to XDS Metadata:'''
 
'''CDA mapping to XDS Metadata:'''
Line 75: Line 209:
 
:* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_Suppl_XDS_Metadata_Update.pdf XDS Metadata Update]
 
:* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_Suppl_XDS_Metadata_Update.pdf XDS Metadata Update]
 
:* [[Remove Metadata and Documents (RMD)]]
 
:* [[Remove Metadata and Documents (RMD)]]
 +
:* [http://www.ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_Suppl_Delayed_Doc_Assem.pdf Delayed Document Assembly]
  
 
'''Underlying Standards:'''
 
'''Underlying Standards:'''
Line 84: Line 219:
 
:* [http://www.hl7.org HL7 Version 2.5]
 
:* [http://www.hl7.org HL7 Version 2.5]
 
:* [http://www.hl7.org HL7 Version 2.3.1 Chapter 2 – Control, Chapter 3 – Patient Administration]
 
:* [http://www.hl7.org HL7 Version 2.3.1 Chapter 2 – Control, Chapter 3 – Patient Administration]
 +
 +
===History===
 +
Originally published Trial Implementation August 15, 2004
 +
 +
XDS.b Originally published Trial Implementation August 15, 2007 (Original got renamed to XDS.a)
  
 
==See Also==
 
==See Also==
 +
[[Document Sharing]]
 +
 +
[[Document Sharing Metadata Handbook]]
 +
 
Related Profiles:
 
Related Profiles:
  
Line 99: Line 243:
 
** [[Document Digital Signature]] DSG
 
** [[Document Digital Signature]] DSG
 
* Other Derivatives
 
* Other Derivatives
** [[Cross Community Access]] XCA
+
** [[Cross-Community Access]] XCA
 
** [[Cross-enterprise Document Media Interchange]] XDM
 
** [[Cross-enterprise Document Media Interchange]] XDM
 
** [[Cross-enterprise Document Reliable Interchange]] XDR
 
** [[Cross-enterprise Document Reliable Interchange]] XDR

Revision as of 14:57, 25 July 2018

Cross-Enterprise Document Sharing (XDS) is an interoperability profile that facilitates the registration, distribution and access across health enterprises of patient electronic health records.

Summary

Cross-Enterprise Document Sharing (XDS) is focused on providing a standards-based specification for managing the sharing of documents between any healthcare enterprise, ranging from a private physician office to a clinic to an acute care in-patient facility and personal health record systems. This is managed through federated document repositories and a document registry to create a longitudinal record of information about a patient within a given clinical affinity domain. These are distinct entities with separate responsibilities:

  • A Document Repository is responsible for storing documents in a transparent, secure, reliable and persistent manner and responding to document retrieval requests.
  • A Document Registry is responsible for storing information about those documents so that the documents of interest for the care of a patient may be easily found, selected and retrieved irrespective of the repository where they are actually stored.
  • Documents are provided by one or more Document Sources
  • They are then accessed by one or more Document Consumers

Benefits

Facilitates management of the Electronic Health Record

  • facilitates the registration, distribution and access across health enterprises of patient electronic health records.
  • focused on providing a standards-based specification for managing the sharing of documents between any healthcare enterprise, ranging from a private physician office to a clinic to an acute care in-patient facility.

Details

The Cross-Enterprise Document Sharing (XDS) Integration Profile:

  • assumes that the enterprises belong to one or more XDS Affinity Domains. An XDS Affinity Domain is a group of healthcare enterprises that have agreed to work together using a common set of policies and share a common infrastructure.

Examples of XDS Affinity Domains include:

  • Community of Care supported by a regional health information organizations in order to serve all patients in a given region.
  • Nationwide EHR
  • Specialized or Disease-oriented Care
  • Cardiology Specialists and an Acute Cardiology Center
  • Oncology network
  • Diabetes network
  • Federation of enterprises
  • A regional federation made up of several local hospitals and healthcare providers
  • Government sponsored facilities (e.g., VA or Military)
  • Insurance Provider Supported Communities
  • The concept of a document in XDS is not limited to textual information. As XDS is document content neutral, any type of clinical information without regard to content and representation is supported. This makes the XDS IHE Integration Profile equally able to handle documents containing simple text, formatted text (e.g., HL7 CDA Release 1), images (e.g., DICOM) or structured and vocabulary coded clinical information (e.g., CDA Release 2, CCR, CEN ENV 13606, DICOM SR). In order to ensure the necessary interoperability between the document sources and the document consumers, the XDS Affinity Domain must adopt policies concerning document format, structure and content.

FAQ

This is not normative text, but provided informatively due to the frequency that questions are asked.

Optimal Query

(Text originally published in the Document Sharing Metadata Handbook)

The FindDocuments query has 17 query parameters, but 7 of them play a critical role. These parameters are the “critical few”, especially for the initial query that performs the primary filtering (further discussed in Section 3.4) among all available documents for a patient that may be in the thousands with a mature deployment. This primary filtering optimizes the use of query to return the best possible results, avoiding missing any results that should be considered. This favors false-positives (results that are not desired), over false-negatives (missed results). The query results returned include full metadata for each entry found; local refinement of these results (see section 2.2 below) is used to further eliminate these false-positives.

The other 12 parameters may also be used, but the effectiveness of these additional parameters in primary filtering is limited. See section 2.1.2 for further explanation.

Here are the 7 query parameters and metadata attributes that are combined for primary filtering:

  • patientId - this is required in XDS/XCA. You must have a Patient ID you are interested in. Use of PIX, PDQ, XCPD, or some other Patient Identity Management system is a prerequisite, that will not be further discussed in this handbook.
  • classCode – classCode is used to group documents into logical classes which are useful to primary filtering success. A small number of controlled value set of pre-negotiated code values should be defined to group documents into broad logical 'classifications', designed so that for any use case where someone is looking for documents they can pick one term from this value set.
  • practiceSettingCode - this is the clinical specialty where the act that resulted in the document was performed. Like the classCode, this should have been filled with a controlled value set of pre-negotiated code values that represents broad classifications of clinical specialties. By restricting the value set to the high-level clinical specialties, one should avoid the misfiling associated with documents produced by sub-specialties.
  • serviceStartTime - serviceStopTime – When there is a timerange of the service event that you are interested, you will query against the serviceStartTime and service StopTime metadata element to find documents that indicate they fit your timerange. .

service Start to Stop Time

The service times are specific to the time range of the treatment or episode. This is different than the document creation time, which is when the document was created. The query results will return any document whose “service time” falls within that range. It is important to note that these parameters work together to give a period of time.

Given you are interested in a specific time range (Start -> Stop).

The serviceStartTimeFrom and serviceStopTimeTo are clear they should bound that time with a little slop to deal with poor timeclocks:

  • serviceStartTimeFrom parameter in the query should be set to a few minutes before the time you are interested in being the Start of the service time range
  • serviceStopTimeTo parameter in the query should be a set to a few minutes after the time you are interested in being in the Stop of the service time range

Some DocumentEntries will have a service start time but not have a service stop time. This is common in chronic care, radiology, and other circumstances where the end of the service has not happened or where the end is unknowable, therefore you should include a query parameter that would eliminate DocumentEntries that have a declared start time well after the time range you are interested in:

  • serviceStartTimeTo parameter in the query should be set to a few minutes before the time you are interested in being the Stop of the service time range

Some DocumentEntries will have a service stop time but not a service start time. This is not common, but will happen where there is no clear start time to an observation, therefore you should include a query parameter that would eliminate DocumentEntries that have a declared stop time well before the time range you are interested in:

  • serviceStopTimeFrom parameter in the query should be set to a few minutes after the time you are interested in being the Start of the service time range

Some DocumentEntries will have neither service start or stop. These will be returned regardless of any timeframe query parameters. Your Community Metadata Specification should encourage all metadata publications populate the serviceStartTime and serviceStopTime element as much as possible to avoid false-positive query results.

Systems Affected

Systems involved in this profile are:

  • Enterprise-wide information systems that manage a patient’s Electronic Health Record, such as a Hospital Information System.


Actors & Transactions:

XDS-Actor-Transaction-b.jpg

Specification

Profile Status: Final Text

Formal Profile Specification: IHE IT Infrastructure Technical Framework Version 2 or later

Vol. 1

Vol. 2

Vol. 2x

Vol. 3

excerpts (Not all sub-sections below level 3 are listed here)

Vol. 3 - Section 4.0 Metadata used in Document Sharing

Additional

IHE Format Codes vocabulary

CDA mapping to XDS Metadata:

Additional Supplements: Trial Implementation

Underlying Standards:

History

Originally published Trial Implementation August 15, 2004

XDS.b Originally published Trial Implementation August 15, 2007 (Original got renamed to XDS.a)

See Also

Document Sharing

Document Sharing Metadata Handbook

Related Profiles:

XDS Purchasing describes considerations when purchasing equipment to deploy this Profile.

Sample Transactions

Annotated example of Provide and Register Transaction

raw examples

The XDS FAQ answers typical questions about what the Profile does.

XDS Implementation provides additional information about implementing this Profile in software.

References

Where in the World is CDA and XDS?

The XDS Factor

From Regional Healthcare Information Organizations to a National Healthcare Information Infrastructure

Cross-enterprise image sharing sees breakthrough

Medical Data GRIDs as approach towards secure cross enterprise document sharing (based on IHE XDS).

IHE Update: Bigger, Better Events, New Standards & Guides

Architecture for a Distributed National Electronic Health Record System in Austria

SAPHIRE: A semantic Web service based Clinical guideline deployment infrastructure exploiting IHE XDS (Turkey)

<List References (good and bad) (with link if possible) to Journal Articles that mention IHE's work (and hopefully include some analysis). Go ahead, Google: IHE <Profile Name> abstract or something. You might be surprised. >

This page is based on the Profile Template

Current: IT Infrastructure Technical Framework.