Connectathon On Demand transactions

How to validate On Demand (ITI-61) transactions in Connectathon

• Register transaction

  See this Register request message example for reference purposes: ftp://ftp.ihe.net/TF_Implementation_Material/ITI/examples/XDS.b/RegisterOnDemandDocumentEntryRequest_SOAP.xml

  In comparison to a Stable DocumentEntry Register request, the following are some differences:

  • SOAP Action

    urn:ihe:iti:2010:RegisterOnDemandDocumentEntry

  • objectType

    ExtrinsicObject's objectType should be urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248

  DocumentEntry Metadata slots:

  a) creationTime – Not Applicable; shall not be specified in a Register On-Demand Document Entry Request

  b) hash – Not Applicable; shall not be specified in a Register On-Demand Document Entry Request.

  For additional information on ITI-61 Register request, see this link and navigate to Section 3.61 Register On-Demand Document Entry for a complete list message semantics.

• Stored Query transaction

  • objectType

  A FindDocuments stored query response should return an ExtrinsicObject with its objectType attribute value set to objectType="urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248"

• Retrieve transaction

  • Request Message Example:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
        <wsa:To soapenv:mustUnderstand="true">http://localhost:8888/xdstools2-4.2.0-SNAPSHOT/sim/default__od/odds/ret</wsa:To>
        <wsa:MessageID soapenv:mustUnderstand="true">urn:uuid:20E56F699E99412B881483996045727</wsa:MessageID>
        <wsa:Action soapenv:mustUnderstand="true">urn:ihe:iti:2007:RetrieveDocumentSet</wsa:Action>
    </soapenv:Header>
    <soapenv:Body>
        <RetrieveDocumentSetRequest xmlns="urn:ihe:iti:xds-b:2007" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:ihe:iti:xds-b:2007 file:/Users/bill/ihe/Frameworks/ITI-4/XDS.b/schema/IHE/XDS.b_DocumentRepository.xsd">
            <DocumentRequest>
                <RepositoryUniqueId>1.1.4567248.1.1</RepositoryUniqueId>
                <DocumentUniqueId>1.42.20170106160444.2</DocumentUniqueId>
            </DocumentRequest>
        </RetrieveDocumentSetRequest>
    </soapenv:Body>
</soapenv:Envelope>

• Non-persistence Retrieve transaction:
  • Response Message Example:

<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope" s:mustUnderstand="1">urn:ihe:iti:2007:RetrieveDocumentSetResponse</wsa:Action>
      <wsa:RelatesTo xmlns:wsa="http://www.w3.org/2005/08/addressing">urn:uuid:20E56F699E99412B881483996045727</wsa:RelatesTo>
   </S:Header>
   <S:Body>
      <xdsb:RetrieveDocumentSetResponse xmlns:xdsb="urn:ihe:iti:xds-b:2007">
         <rs:RegistryResponse xmlns: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.1.4567248.1.1</xdsb:RepositoryUniqueId>
            <xdsb:DocumentUniqueId>1.42.20170106160444.2</xdsb:DocumentUniqueId>  	     <!-- Note: This is the promise token, not a real document. -->
            <xdsb:NewDocumentUniqueId>1.42.20170106160444.2.1</xdsb:NewDocumentUniqueId> <!-- Note: NewDocumentUniqueId is required when retrieval is of an On-Demand Document. -->
            <xdsb:mimeType>text/plain</xdsb:mimeType>
            <xdsb:Document>
               <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:doc1@ihexds.nist.gov" />
            </xdsb:Document>
         </xdsb:DocumentResponse>
      </xdsb:RetrieveDocumentSetResponse>
   </S:Body>
</S:Envelope>

• Retrieve with Persistence response message
  • Example:

<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope" s:mustUnderstand="1">urn:ihe:iti:2007:RetrieveDocumentSetResponse</wsa:Action>
      <wsa:RelatesTo xmlns:wsa="http://www.w3.org/2005/08/addressing">urn:uuid:20E56F699E99412B881483996239648</wsa:RelatesTo>
   </S:Header>
   <S:Body>
      <xdsb:RetrieveDocumentSetResponse xmlns:xdsb="urn:ihe:iti:xds-b:2007">
         <rs:RegistryResponse xmlns: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.1.4567248.1.1</xdsb:RepositoryUniqueId>
            <xdsb:DocumentUniqueId>1.42.20170109161023.2</xdsb:DocumentUniqueId>
            <xdsb:NewRepositoryUniqueId>1.1.4567332.1.4</xdsb:NewRepositoryUniqueId>   <--  Note: The the presence of the persisting repository here. The NewDocumentUniqueId snapshot should be retrievable directly from the repository specified by the NewRepositoryUniqueId. -->
            <xdsb:NewDocumentUniqueId>1.42.20170109161023.4</xdsb:NewDocumentUniqueId>
            <xdsb:mimeType>text/plain</xdsb:mimeType>
            <xdsb:Document>
               <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:doc1@ihexds.nist.gov" />
            </xdsb:Document>
         </xdsb:DocumentResponse>
      </xdsb:RetrieveDocumentSetResponse>
   </S:Body>
</S:Envelope>

• Important: According to the Gazelle Xds.b On Demand test, we should compare document contents (visually or by using a hash calculator) to see if the content is really dynamic. Reference: http://ihe.wustl.edu/gazelle-na/testing/testsDefinition/viewTestPage.seam?id=11374&testKeyword=XDS.b_On-Demand_Docs