Da Vinci Clinical Data Exchange (CDex)
2.1.0-preview - CI Build United States of America flag

Da Vinci Clinical Data Exchange (CDex), published by HL7 International / Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 2.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-ecdx/ and changes regularly. See the Directory of published versions

: cdex-capabilitystatement-inline-example - XML Representation

Page standards status: Informative

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="cdex-capabilitystatement-inline-example"/>
  <meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/instance-name">
      <valueString value="CDex Capabilitystatement Inline Example"/>
    </extension>
    <extension
               url="http://hl7.org/fhir/StructureDefinition/instance-description">
      <valueMarkdown
                     value="Capabilitystatement example used to create inline example to demonstrate using the CapabilityStatement SubscriptionTopic Canonical] extension to advertise the canonical URLs of topics available to clients"/>
    </extension>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
    <!-- TODO 
    Jurisdiction 
    Prohibited extension - http://hl7.org/fhir/StructureDefinition/capabilitystatement-prohibited -->
    <!-- set include_symbols = false to turn off confonrmance symbols and legen, true to turn on -->
  
  
  <h2 id="title"/>
  <ul>
    
    <li><b>Implementation Guide Version:</b> 2.1.0-preview</li>
    <li><b>FHIR Version:</b> 4.0.1</li>
    <li><b>Intended Use:</b> requirements</li>
    <li><b>Supported Formats: </b> 

    
      
      
      json;
    

    </li>
    
    <li><b>Published:</b> 2024-05-16</li>
  
    <li><b>Published by:</b> HL7 International / Payer/Provider Information Exchange Work Group</li>
    <li><b>Status:</b> active</li>
    <li><b>Copyright:</b> <div><p>Used by permission of HL7 International all rights reserved Creative Commons License</p>
</div></li>
  </ul>
  <br/>



  
    <strong>Description:</strong> <div><div><p>R4 example of a CapabilityStatement advertising support for CDex Task Update topic-based subscription</p>
</div></div>
  
  <br/>
  
  


  
    <h3>Support and Requirements for Other Artifacts</h3>
    
      <tr>
        <th>Instantiates other capabilities:</th>
        <td>
          <ul>
            
              <li>
                
                <a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/CapabilityStatement-backport-subscription-server-r4.html">BackportSubscriptionCapabilityStatementR4</a>
              </li>
            
          </ul>
        </td>
      </tr>
    
    
    
      <tr>
        <th>Supports other guides:</th>
        <td>
          <ul>
            
              <li>
                
                <a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/ImplementationGuide-hl7.fhir.uv.subscriptions-backport.html">Subscriptions R5 Backport</a>
              </li>
            
          </ul>
        </td>
      </tr>
    
  

  <br/>
    <!-- TODO - Make this a summary of capabilities, including system wide and each paradigm -->
  <p>
    <b>Jump to:</b>
  </p>
  <ul>
    
      <li><a href="#server">REST server</a></li>
    
    
    
  </ul>



    <!-- REST Capabilities -->
  
    <br/>
    <a name="server"> </a>
    <h3 id="behavior">FHIR server RESTful Capabilities</h3>
    

      <!-- REST Security -->
    

      <!-- REST System wide Capabilities -->
    
      <h3>System-wide server Capabilities</h3>
    
        <!-- REST System wide interactions -->
      

        <!-- REST System wide operations -->
      


        <!-- REST System wide search parameters -->
      
    



      <!-- Resource Capabilities -->
    

      <h4>Summary of Resource/Profile Capabilities</h4>
        <!-- TODO need include conformance verb legend -->
      
      <table class="grid">
        <thead>
          <tr>
            <th>Resource Type</th>
            <th>Supported Interactions</th>
            <th>Supported Profiles</th>
            <th>Supported Searches</th>
            <th>Supported <code>_includes</code></th>
            <th>Supported <code>_revincludes</code></th>
            <th>Supported Operations</th>
          </tr>
        </thead>
        <tbody>
          
          <tr>
            <td>
              <a href="#server_Subscription"><span style="white-space: nowrap;">Subscription</span></a>
            </td>

              <!-- Supported Interactions -->
            <td>
              
                
                <span style="white-space: nowrap;">read</span>,
                
                <span style="white-space: nowrap;">create</span>,
                
                <span style="white-space: nowrap;">update</span>,
                
                <span style="white-space: nowrap;">delete</span>,
                
              
            </td>

              <!-- Supported Profiles -->
            <td>
              
                <a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html">R4/B Topic-Based Subscription</a>,
                
                
              
            </td>

              <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->
            <td>
              
                
                  <span style="white-space: nowrap;">url</span>, 
                  
                
                  <span style="white-space: nowrap;">status</span>, 
                  
                
                
              
            </td>

              <!-- Supported _includes -->
            <td>
              
            </td>

              <!-- Supported _revincludes -->
            <td>
              
            </td>

              <!-- Supported Operations -->
            <td>
              
                
                  <span style="white-space: nowrap;">$status</span>
                  
                
                  <span style="white-space: nowrap;">$events</span>
                  
                
                  <span style="white-space: nowrap;">$get-ws-binding-token</span>
                  
                
              
            </td>
          </tr>
          
          <tr>
            <td>
              <a href="#server_Patient"><span style="white-space: nowrap;">Patient</span></a>
            </td>

              <!-- Supported Interactions -->
            <td>
              
                
                <span style="white-space: nowrap;">read</span>,
                
                <span style="white-space: nowrap;">create</span>,
                
                <span style="white-space: nowrap;">update</span>,
                
                <span style="white-space: nowrap;">delete</span>,
                
              
            </td>

              <!-- Supported Profiles -->
            <td>
              
            </td>

              <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->
            <td>
              
            </td>

              <!-- Supported _includes -->
            <td>
              
            </td>

              <!-- Supported _revincludes -->
            <td>
              
            </td>

              <!-- Supported Operations -->
            <td>
              
            </td>
          </tr>
          
          <tr>
            <td>
              <a href="#server_Encounter"><span style="white-space: nowrap;">Encounter</span></a>
            </td>

              <!-- Supported Interactions -->
            <td>
              
                
                <span style="white-space: nowrap;">read</span>,
                
                <span style="white-space: nowrap;">create</span>,
                
                <span style="white-space: nowrap;">update</span>,
                
                <span style="white-space: nowrap;">delete</span>,
                
              
            </td>

              <!-- Supported Profiles -->
            <td>
              
            </td>

              <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->
            <td>
              
            </td>

              <!-- Supported _includes -->
            <td>
              
            </td>

              <!-- Supported _revincludes -->
            <td>
              
            </td>

              <!-- Supported Operations -->
            <td>
              
            </td>
          </tr>
          
          <tr>
            <td>
              <a href="#server_Observation"><span style="white-space: nowrap;">Observation</span></a>
            </td>

              <!-- Supported Interactions -->
            <td>
              
                
                <span style="white-space: nowrap;">read</span>,
                
                <span style="white-space: nowrap;">create</span>,
                
                <span style="white-space: nowrap;">update</span>,
                
                <span style="white-space: nowrap;">delete</span>,
                
              
            </td>

              <!-- Supported Profiles -->
            <td>
              
            </td>

              <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->
            <td>
              
            </td>

              <!-- Supported _includes -->
            <td>
              
            </td>

              <!-- Supported _revincludes -->
            <td>
              
            </td>

              <!-- Supported Operations -->
            <td>
              
            </td>
          </tr>
          
        </tbody>
      </table>
      <br/>

      <h3 id="resource-details" class="no_toc">RESTful server Capabilities by Resource/Profile:</h3>
        <!-- Each REST Resource Detail -->
      
        <h4 id="server_Subscription" class="no_toc">Subscription</h4>

          <p>Conformance Expectation:	<strong/></p>

          

          

          <p>Supported Profiles:</p>
            <ul>
              
                <li>
                <a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html">R4/B Topic-Based Subscription</a>
                </li>
              
            </ul>
          
      


        <p>
          

          

          

          
        </p>






          <!-- Resource Interactions -->
        <p>Subscription Interaction Summary:</p>
          <ul>
            
            
            
            
            
              <li> read,  create,  update,  delete, </li>
            
          </ul>

          
            
          
            
          
            
          
            
          
        

          <!-- Resource Operations -->
        



          <!-- TODO Nexted ul items do not appear with a subbullet style -->
        
          <br/>
          <p>Modify Criteria:</p> 
          <ul>
            
              

              

              


              

            
              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating a Subscription resource using:
                  <code class="highlighter-rouge">POST [base]/Subscription/[id]{?_format=[mime-type]}</code>
                  
                </li>
              

              

              


              

            
              

              
                <li>
                    <!-- TODO change note if server allows putting of a new one (with a specified ID) -->
                  A server <strong>(conformance expectation undefined)</strong> be capable of updating a existing Subscription resource using:
                  <code class="highlighter-rouge">PUT [base]/Subscription/[id]{?_format=[mime-type]}</code>
                  
                </li>
              

              


              

            
              

              

              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of deleting a Subscription resource using:
                  <code class="highlighter-rouge">DELETE [base]//[id]</code>
                  
                </li>
              


              

            
          </ul>
        


        
          <br/>
          <p>Fetch and Search Criteria:</p>
          <ul>
            
              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Subscription resource using:
                  <code class="highlighter-rouge">GET [base]/Subscription/[id]</code>
                  
                </li>
              
              
              
              
              
            
              
              
              
              
              
            
              
              
              
              
              
            
              
              
              
              
              
            

            

            

          </ul>
        

        
          <br/>
          <p>Search Parameter Summary:</p>
          <table class="grid">
            <thead>
              <tr>
                <th style="white-space: nowrap;">Conformance</th>
                <th>Parameter</th>
                <th>Type</th>
                <th>Example</th>
              </tr>
            </thead>
            <tbody>
                <!-- TODO, should the search paramaters be limited to only SHALL and SHOULD -->
              
              <tr>
                <td>
                  <strong>(conformance expectation undefined)</strong>
                </td>
                <td>
                  <a href="http://hl7.org/fhir/SearchParameter/Subscription-url">url</a>
                </td>
                <td>
                  uri
                </td>
                <td>
                  <code class="highlighter-rouge">GET [base]/Subscription?url=[uri]
                    </code>
                </td>
              </tr>
              
              <tr>
                <td>
                  <strong>(conformance expectation undefined)</strong>
                </td>
                <td>
                  <a href="http://hl7.org/fhir/SearchParameter/Subscription-status">status</a>
                </td>
                <td>
                  token
                </td>
                <td>
                  <code class="highlighter-rouge">GET [base]/Subscription?status=[system]|[code]
                    </code>
                </td>
              </tr>
              
            </tbody>
          </table>

        

          <!-- Search Combination -->
        
        
        

      
        <h4 id="server_Patient" class="no_toc">Patient</h4>

          <p>Conformance Expectation:	<strong/></p>

          

          

          
      


        <p>
          

          

          

          
        </p>






          <!-- Resource Interactions -->
        

          <!-- Resource Operations -->
        



          <!-- TODO Nexted ul items do not appear with a subbullet style -->
        
          <br/>
          <p>Modify Criteria:</p> 
          <ul>
            
              

              

              


              

            
              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating a Patient resource using:
                  <code class="highlighter-rouge">POST [base]/Patient/[id]{?_format=[mime-type]}</code>
                  
                </li>
              

              

              


              

            
              

              
                <li>
                    <!-- TODO change note if server allows putting of a new one (with a specified ID) -->
                  A server <strong>(conformance expectation undefined)</strong> be capable of updating a existing Patient resource using:
                  <code class="highlighter-rouge">PUT [base]/Patient/[id]{?_format=[mime-type]}</code>
                  
                </li>
              

              


              

            
              

              

              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of deleting a Patient resource using:
                  <code class="highlighter-rouge">DELETE [base]//[id]</code>
                  
                </li>
              


              

            
          </ul>
        


        
          <br/>
          <p>Fetch and Search Criteria:</p>
          <ul>
            
              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Patient resource using:
                  <code class="highlighter-rouge">GET [base]/Patient/[id]</code>
                  
                </li>
              
              
              
              
              
            
              
              
              
              
              
            
              
              
              
              
              
            
              
              
              
              
              
            

            

            

          </ul>
        

        

          <!-- Search Combination -->
        
        
        

      
        <h4 id="server_Encounter" class="no_toc">Encounter</h4>

          <p>Conformance Expectation:	<strong/></p>

          

          

          
      


        <p>
          

          

          

          
        </p>






          <!-- Resource Interactions -->
        

          <!-- Resource Operations -->
        



          <!-- TODO Nexted ul items do not appear with a subbullet style -->
        
          <br/>
          <p>Modify Criteria:</p> 
          <ul>
            
              

              

              


              

            
              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating a Encounter resource using:
                  <code class="highlighter-rouge">POST [base]/Encounter/[id]{?_format=[mime-type]}</code>
                  
                </li>
              

              

              


              

            
              

              
                <li>
                    <!-- TODO change note if server allows putting of a new one (with a specified ID) -->
                  A server <strong>(conformance expectation undefined)</strong> be capable of updating a existing Encounter resource using:
                  <code class="highlighter-rouge">PUT [base]/Encounter/[id]{?_format=[mime-type]}</code>
                  
                </li>
              

              


              

            
              

              

              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of deleting a Encounter resource using:
                  <code class="highlighter-rouge">DELETE [base]//[id]</code>
                  
                </li>
              


              

            
          </ul>
        


        
          <br/>
          <p>Fetch and Search Criteria:</p>
          <ul>
            
              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Encounter resource using:
                  <code class="highlighter-rouge">GET [base]/Encounter/[id]</code>
                  
                </li>
              
              
              
              
              
            
              
              
              
              
              
            
              
              
              
              
              
            
              
              
              
              
              
            

            

            

          </ul>
        

        

          <!-- Search Combination -->
        
        
        

      
        <h4 id="server_Observation" class="no_toc">Observation</h4>

          <p>Conformance Expectation:	<strong/></p>

          

          

          
      


        <p>
          

          

          

          
        </p>






          <!-- Resource Interactions -->
        

          <!-- Resource Operations -->
        



          <!-- TODO Nexted ul items do not appear with a subbullet style -->
        
          <br/>
          <p>Modify Criteria:</p> 
          <ul>
            
              

              

              


              

            
              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating a Observation resource using:
                  <code class="highlighter-rouge">POST [base]/Observation/[id]{?_format=[mime-type]}</code>
                  
                </li>
              

              

              


              

            
              

              
                <li>
                    <!-- TODO change note if server allows putting of a new one (with a specified ID) -->
                  A server <strong>(conformance expectation undefined)</strong> be capable of updating a existing Observation resource using:
                  <code class="highlighter-rouge">PUT [base]/Observation/[id]{?_format=[mime-type]}</code>
                  
                </li>
              

              


              

            
              

              

              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of deleting a Observation resource using:
                  <code class="highlighter-rouge">DELETE [base]//[id]</code>
                  
                </li>
              


              

            
          </ul>
        


        
          <br/>
          <p>Fetch and Search Criteria:</p>
          <ul>
            
              
                <li>
                  A server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Observation resource using:
                  <code class="highlighter-rouge">GET [base]/Observation/[id]</code>
                  
                </li>
              
              
              
              
              
            
              
              
              
              
              
            
              
              
              
              
              
            
              
              
              
              
              
            

            

            

          </ul>
        

        

          <!-- Search Combination -->
        
        
        

      
    



  









    <!-- Messaging Capabilities -->
  

    <!-- Document Capabilities -->
  

</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/cdex-capabilitystatement-inline-example"/>
  <version value="2.1.0-preview"/>
  <status value="active"/>
  <date value="2024-05-16"/>
  <publisher
             value="HL7 International / Payer/Provider Information Exchange Work Group"/>
  <contact>
    <name
          value="HL7 International / Payer/Provider Information Exchange Work Group"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/claims"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="pie@lists.hl7.org"/>
    </telecom>
  </contact>
  <description
               value="R4 example of a CapabilityStatement advertising support for CDex Task Update topic-based subscription"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <copyright
             value="Used by permission of HL7 International all rights reserved Creative Commons License"/>
  <kind value="requirements"/>
  <instantiates
                value="http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server-r4|1.1.0"/>
  <fhirVersion value="4.0.1"/>
  <format value="json"/>
  <implementationGuide
                       value="http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"/>
  <rest>
    <mode value="server"/>
    <resource>
      <extension
                 url="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/capabilitystatement-subscriptiontopic-canonical">
        <valueCanonical
                        value="http://hl7.org/fhir/us/davinci-cdex/SubscriptionTopic/cdex-task-update"/>
      </extension>
      <type value="Subscription"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription|1.1.0"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
      <searchParam>
        <name value="url"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Subscription-url"/>
        <type value="uri"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Subscription-status"/>
        <type value="token"/>
      </searchParam>
      <operation>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status"/>
      </operation>
      <operation>
        <name value="events"/>
        <definition
                    value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events"/>
      </operation>
      <operation>
        <name value="get-ws-binding-token"/>
        <definition
                    value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token"/>
      </operation>
    </resource>
    <resource>
      <type value="Patient"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
    <resource>
      <type value="Encounter"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
    <resource>
      <type value="Observation"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
  </rest>
</CapabilityStatement>