550 likes | 927 Views
XDS.b ( Cross-Enterprise Document Sharing). 2011. 05. 12. Sungkee Lee. Agenda. XDS.b Overview Register Document Set-b [ITI-42] Retrieve Document Set [ITI-43] Registry Stored Query [ITI-18]. XDS.b. ITI TF-1 Ch. 10 10.1 Actors/Transactions 10.1.3 XDS Document Contents Support
E N D
XDS.b(Cross-Enterprise Document Sharing) 2011. 05. 12. Sungkee Lee
Agenda • XDS.b Overview • Register Document Set-b [ITI-42] • Retrieve Document Set [ITI-43] • Registry Stored Query [ITI-18]
XDS.b • ITI TF-1 Ch. 10 • 10.1 Actors/Transactions • 10.1.3 XDS Document Contents Support • 10.2 Integration Profile Options • 10.4.7.1 XDS Document Registry Data Model • 10.5 Implementation Strategies
XDS.b Actors and Transactions INFINITT Insung INFINITT GNSK MedicalStandard ezCaretech UCareSoft ezCaretech Insung INFINITT GNSK MedicalStandard ezCaretech
XDS.b Actors • Document Source • Source of documents and metadata about documents • Document Repository • Stores documents, requests indexing in Document Registry, supports retrieval • Document Registry • Indexes documents, supports search • Patient Identity Source • Feeds identity of known patients to Document Registry • Document Consumer • Initiates search and retrieval for consumer of documents
Patient Registration Patient Identity Source Patient Identity Feed Document Registry
Document Submission Document Registry Register Document Set Provide and Register Document Set Document Source Document Repository
Query and Retrieve Query Documents Document Registry Document Consumer Retrieve Document Document Repository
XDS Registry Data Model Entities • XDS Document Entry • XDS Document • XDS Folder • XDS Submission Set • XDS Submission Request
XDS.b Implementation Strategies • Strategy 1 : Repository at the Source
XDS.b Implementation Strategies • Strategy 2 : Third Party Repository
XDS.b Implementation Strategies • Strategy 3 : Direct Patient Transfer-Referral
Register Document Set-b [ITI-42] • ITI TF-2b 3.42 • 3.42.1 Scope • 3.42.2 Use Case Roles • 3.42.3 Referenced Standards • 3.42.4 Interaction Diagram • 3.42.4.1 Register Document Set-b Request • 3.42.4.2 Register Document Set-b Response • 3.42.5 Protocol Requirements • 3.42.5.1.1 Sample Register Document Set-b SOAP Request • 3.42.5.1.2 Sample Register Document Set-b SOAP Response • 3.42.4.1.2 Message Semantics • 3.42.7 Security Considerations
Register Document Set-b [ITI-42] • 3.42.1 Scope • Metadata describing zero or more documents • XDS Submission Set definition along with the linkage to new documents and references to existing documents • An optional XDS Folder definitions along with linkage to new or existing documents
Register Document Set-b [ITI-42] • 3.42.2 Use Case Roles
Register Document Set-b [ITI-42] • 3.42.3 Referenced Standards • ebRIM • OASIS/ebXML Registry Information Model v3.0 • ebRS • OASIS/ebXML Registry Services Specifications v3.0 • HL7v2 • HL7 Version 2.5 • Appendix V • ITI TF-2x: Appendix V Web Services for IHE Transactions • Contains references to all Web Services standards and requirements of use
Register Document Set-b [ITI-42] • 3.42.4 Interaction Diagram
Register Document Set-b [ITI-42] • 3.42.5 Protocol Requirements • ITI TF-2x Appendix V: Web Services • SOAP 1.2 • ftp://ftp.ihe.net/TF_Implementation_Material/ITI/ • WSDL • schema • examples
Message Structure SOAP Message ebXML Message
Sample Register Document Set-b SOAP Request <s:Envelope xmlns:s=http://www.w3.org/2003/05/soap-envelope xmlns:a="http://www.w3.org/2005/08/addressing"> <s:Header> <a:Action s:mustUnderstand="1">urn:ihe:iti:2007:RegisterDocumentSet-b</a:Action> <a:MessageID>urn:uuid:1ec52e14-4aad-4ba1-b7d3-fc9812a21340</a:MessageID> <a:ReplyTo> <a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address> </a:ReplyTo s:mustUnderstand="1"> <a:To >http://localhost:2647/XdsService/IHEXDSRegistry.svc</a:To> </s:Header> <s:Body> <lcm:SubmitObjectsRequest xmlns:lcm="urn:oasis:names:tc:ebxml-regrep:xsd:lcm:3.0" xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0" xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"> <!—Rest of SubmitObjectsRequest message goes here --> </lcm:SubmitObjectsRequest> </s:Body> </s:Envelope>
Sample Register Document Set-b SOAP Response <s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing"> <s:Header> <a:Action s:mustUnderstand="1">urn:ihe:iti:2007:RegisterDocumentSet-bResponse </a:Action> <a:RelatesTo>urn:uuid:1ec52e14-4aad-4ba1-b7d3-fc9812a21340</a:RelatesTo> </s:Header> <s:Body> <rs:RegistryResponse status="urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success" xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"/> </s:Body> </s:Envelope>
Register Document Set-b [ITI-42] • 3.42.4.1.2 Message Semantics • ITI TF-3 4.1 • 4.1.7 Document Definition Metadata • 4.1.8 Submission Set Metadata
Retrieve Document Set [ITI-43] • ITI TF-2b 3.43 • 3.43.1 Scope • 3.43.2 Use Case Roles • 3.43.3 Referenced Standard • 3.43.4 Interaction Diagram • 3.43.4.1 Retrieve Document Set Request • 3.43.4.2 Retrieve Document Set Response • 3.43.5 Protocol Requirements • 3.43.5.1.1 Sample Retrieve Document Set SOAP Request • 3.43.5.1.2 Sample Retrieve Document Set SOAP Response • 3.43.4.1.2 Message Semantics • 3.43.6 Security Considerations
Retrieve Document Set [ITI-43] • 3.43.1 Scope • Obtains the following Ids from Document Registry • XDSDocumentEntryuniqueId • Document Repository repositoryUniqueId
Retrieve Document Set [ITI-43] • 3.43.2 Use Case Roles
Retrieve Document Set [ITI-43] • 3.43.3 Referenced Standard • ebRIM • OASIS/ebXML Registry Information Model v3.0 • ebRS • OASIS/ebXML Registry Services Specifications v3.0 • Appendix V • ITI TF-2x: Appendix V Web Services for IHE Transactions • Contains references to all Web Services standards and requirements of use • MTOM • SOAP Message Transmission Optimization Mechanism • http://www.w3.org/TR/soap12-mtom/ • XOP • XML-binary Optimized Packaging • http://www.w3.org/TR/2005/REC-xop10-20050125/
Retrieve Document Set [ITI-43] • 3.43.4 Interaction Diagram
Retrieve Document Set [ITI-43] • 3.43.5 Protocol Requirements • ITI TF-2x Appendix V: Web Services • SOAP 1.2 • MTOM/XOP • Message Transmission Optimization Mechanism • XML-binary Optimized Packaging • ftp://ftp.ihe.net/TF_Implementation_Material/ITI/ • WSDL • schema • examples
Sample Retrieve Document Set SOAP Request POST /tf6/services/xdsrepositoryb HTTP/1.1 Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_DCD262C64C22DB97351256303951323; type="application/xop+xml"; start="<0.urn:uuid:DCD262C64C22DB97351256303951324@apache.org>"; start-info="application/soap+xml"; action="urn:ihe:iti:2007:RetrieveDocumentSet" User-Agent: Axis2 Host: localhost:5000 --MIMEBoundaryurn_uuid_DCD262C64C22DB97351256303951323 Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml" Content-Transfer-Encoding: binary 2945 Content-ID: <0.urn:uuid:DCD262C64C22DB97351256303951324@apache.org> <?xml version='1.0' encoding='UTF-8'?> <soapenv:Envelopexmlns:soapenv=http://www.w3.org/2003/05/soap-envelope <!—Rest of SOAP message goes here --> </soapenv:Envelope> --MIMEBoundaryurn_uuid_DCD262C64C22DB97351256303951323—
Sample Retrieve Document Set SOAP Request <soapenv:Envelopexmlns:soapenv="http://www.w3.org/2003/05/soap-envelope" xmlns:wsa="http://www.w3.org/2005/08/addressing"> <soapenv:Header> <wsa:To>http://localhost:5000/tf6/services/xdsrepositoryb</wsa:To> <wsa:MessageID>urn:uuid:DCD262C64C22DB97351256303951276</wsa:MessageID> <wsa:Action>urn:ihe:iti:2007:RetrieveDocumentSet</wsa:Action> </soapenv:Header> <soapenv:Body> <RetrieveDocumentSetRequestxmlns="urn:ihe:iti:xds-b:2007" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <DocumentRequest> <RepositoryUniqueId>1.19.6.24.109.42.1.5</RepositoryUniqueId> <DocumentUniqueId>2009.9.1.1573</DocumentUniqueId> </DocumentRequest> </RetrieveDocumentSetRequest> </soapenv:Body> </soapenv:Envelope>
Retrieve Document Set ResponseMessage Structure SOAP Message ebXML Message CDA Document
Sample Retrieve Document Set SOAP Response HTTP/1.1 200 OK Server: Apache-Coyote/1.1 Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_F862C3E04D9E35266C1256303956115; type="application/xop+xml"; start="0.urn:uuid:F862C3E04D9E35266C1256303956116@apache.org"; start-info="application/soap+xml"; action="urn:ihe:iti:2007:RetrieveDocumentSetResponse" Date: Fri, 23 Oct 2009 13:19:11 GMT 2975 --MIMEBoundaryurn_uuid_F862C3E04D9E35266C1256303956115 Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml" Content-Transfer-Encoding: binary Content-ID: <0.urn:uuid:F862C3E04D9E35266C1256303956116@apache.org> <?xml version='1.0' encoding='UTF-8'?> <soapenv:Envelopexmlns:soapenv="http://www.w3.org/2003/05/soap-envelope" <!—Rest of SOAP message goes here --> </soapenv:Envelope> --MIMEBoundaryurn_uuid_F862C3E04D9E35266C1256303956115 Content-Type: application/octet-stream Content-Transfer-Encoding: binary Content-ID: <1.urn:uuid:F862C3E04D9E35266C1256303956117@apache.org> This is the content of the document. --MIMEBoundaryurn_uuid_F862C3E04D9E35266C1256303956115—
Sample Retrieve Document Set SOAP Response <soapenv:Envelopexmlns:soapenv="http://www.w3.org/2003/05/soap-envelope" xmlns:wsa="http://www.w3.org/2005/08/addressing"> <soapenv:Header> 2985 <wsa:Action>urn:ihe:iti:2007:RetrieveDocumentSetResponse</wsa:Action> <wsa:RelatesTo>urn:uuid:DCD262C64C22DB97351256303951276</wsa:RelatesTo> </soapenv:Header> <soapenv:Body> <xdsb:RetrieveDocumentSetResponsexmlns:xdsb="urn:ihe:iti:xds-b:2007"> <rs:RegistryResponsexmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0" status="urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success"/> <xdsb:DocumentResponse> <xdsb:RepositoryUniqueId>1.19.6.24.109.42.1.5</xdsb:RepositoryUniqueId> <xdsb:DocumentUniqueId>2009.9.1.1573</xdsb:DocumentUniqueId> <xdsb:mimeType>application/pdf</xdsb:mimeType> <xdsb:Document> <xop:Includehref="cid:1.urn:uuid:F862C3E04D9E35266C1256303956117@apache.org" xmlns:xop="http://www.w3.org/2004/08/xop/include"/> </xdsb:Document> </xdsb:DocumentResponse> </xdsb:RetrieveDocumentSetResponse> </soapenv:Body> </soapenv:Envelope>
Retrieve Document Set [ITI-43] • 3.43.4.1.2 Message Semantics • ITI TF-3 4.1
Registry Stored Query [ITI-18] • ITI TF-2a 3.18 • 3.18.1 Scope • 3.18.2 Use Case Roles • 3.18.3 Referenced Standards • 3.18.4 Interaction Diagram • 3.18.4.1.2.7 Web Services Transport • 3.18.4.1.2.7.1.1 Sample Registry Stored Query SOAP Request • 3.18.4.1.2.7.1.2 Sample Registry Stored Query SOAP Response • 3.18.4.1.3.1 Sample Query Request • 3.18.4.1.3.3 Sample Query Response • 3.18.5 Security Considerations
Registry Stored Query [ITI-18] • 3.18.1 Scope • Query by patient (Id) for a time interval, by document type(s), by practice setting(s), by author person • Query by Document Source • Query for XDS Folders updated during a time interval • Query for all documents in a Folder or Submission Set • Query by time of submission • All queries return: • Metadata for one or more registry objects, or • Object references for one or more registry objects (registry UUIDs)
Registry Stored Query [ITI-18] • 3.18.2 Use Case Roles
Registry Stored Query [ITI-18] • 3.18.3 Referenced Standards • ebRIM • OASIS/ebXML Registry Information Model v3.0 • ebRS • OASIS/ebXML Registry Services Specifications v3.0 • HL7v2 • HL7 Version 2.5 • Appendix V • ITI TF-2x: Appendix V Web Services for IHE Transactions • Contains references to all Web Services standards and requirements of use
Registry Stored Query [ITI-18] • 3.18.4 Interaction Diagram
Registry Stored Query [ITI-18] • 3.18.4.1.2.7 Web Services Transport • ITI TF-2x Appendix V: Web Services • SOAP 1.2 • ftp://ftp.ihe.net/TF_Implementation_Material/ITI/ • WSDL • schema • examples
Sample Registry Stored Query SOAP Request <s:Envelope xmlns:s=http://www.w3.org/2003/05/soap-envelope xmlns:a="http://www.w3.org/2005/08/addressing"> <s:Header> <a:Action s:mustUnderstand="1">urn:ihe:iti:2007:RegistryStoredQuery</a:Action> <a:MessageID>urn:uuid:def119ad-dc13-49c1-a3c7-e3742531f9b3</a:MessageID> <a:ReplyTo s:mustUnderstand="1">> <a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address> </a:ReplyTo> <a:To>http://localhost/service/IHEXDSRegistry.svc</a:To> </s:Header> <s:Body> <query:AdhocQueryRequest <!—Rest of Query message goes here --> </query:AdhocQueryRequest> </s:Body> </s:Envelope>
Sample Registry Stored Query SOAP Request <query:AdhocQueryRequest xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0" xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0" xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"> <query:ResponseOptionreturnComposedObjects="true" returnType="LeafClass"/> <rim:AdhocQuery id=" urn:uuid:14d4debf-8f97-4251-9a74-a90016b0af0d "> <rim:Slot name="$XDSDocumentEntryPatientId"> <rim:ValueList><rim:Value>‟st3498702^^^&1.3.6.1.4.1.21367.2005.3.7&ISO‟</rim:Value> </rim:ValueList></rim:Slot> <rim:Slot name="$XDSDocumentEntryStatus"> <rim:ValueList><rim:Value>('urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Approved')</rim:Value> </rim:ValueList></rim:Slot> <rim:Slot name="$XDSDocumentEntryCreationTimeFrom"> <rim:ValueList><rim:Value>200412252300</rim:Value> </rim:ValueList></rim:Slot> <rim:Slot name="$XDSDocumentEntryCreationTimeTo"> <rim:ValueList><rim:Value>200501010800</rim:Value> </rim:ValueList></rim:Slot> <rim:Slot name="$XDSDocumentEntryHealthcareFacilityTypeCode"> <rim:ValueList><rim:Value>(„Emergency Department‟)</rim:Value> </rim:ValueList></rim:Slot> </rim:AdhocQuery> </query:AdhocQueryRequest>
Sample Registry Stored Query SOAP Response <s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing"> <s:Header> <a:Action s:mustUnderstand="1">urn:ihe:iti:2007:RegistryStoredQueryResponse</a:Action> <a:RelatesTo>urn:uuid:def119ad-dc13-49c1-a3c7-e3742531f9b3</a:RelatesTo> </s:Header> <s:Body> <query:AdhocQueryResponsexmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0"/> </s:Body> </s:Envelope>
Patient Identity Feed [ITI-8] • ITI TF-2a 3.8