Da Vinci Alerts Implementation Guide (Release 0.1.0 STU1 Ballot)

This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Care Coordination Alerts (v0.1.0: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

XML Format: CapabilityStatement-query-responder

Download Raw xml


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="query-responder"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">Query Responder CapabilityStatement</h2><ul><li>FHIR Version: 4.0.0</li><li>Supported formats: xml, json</li><li>Published: 2019-07-29</li><li>Published by: HL7 International - Clinical Decision Support Work Group</li></ul><p><p>This CapabilityStatement describes the expected capabilities of a server that is capable of responding to a follow up FHIR RESTful query from an  Alert Intermediary/Recipient.</p></p><h3 id="igs" class="no_toc">SHALL Support the Following Implementation Guides:</h3><ul><li><a href="http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core-3.0.0">http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core-3.0.0</a></li></ul><h3 id="behavior">FHIR RESTful Capabilities</h3><p>The Da Vinci Alerts Query Responder <strong>SHALL</strong>:</p><ol><li>Support at least one use case defined in this Guide and listed in the <a href="index.html#scenarios">Scenarios</a> Section.</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>Support json source formats for all Da Vinci Alert interactions.</li><li>Declare a CapabilityStatement identifying the scenarios, transactions and profiles supported.</li></ol><p>The Da Vinci Alerts Query Responder <strong>SHOULD</strong>:</p><ol><li>Support xml source formats for all Da Vinci Alert interactions.</li><li>Identify the Da Vinci Alert or US Core profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li></ol><p id="security"><strong>Security:</strong></p><ol><li>For general security consideration refer to the <a href="http://build.fhir.org/secpriv-module.html">Security and Privacy Considerations</a>.</li><li>For security considerations specific to this guide refer to the  <a href="security.html">Security</a> page for requirements and recommendations.</li><li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li></ol><p><strong>Summary of System Wide Interactions</strong></p><li><strong>MAY</strong> support the	<code>transaction</code> interaction.</li><li><strong>MAY</strong> support the	<code>batch</code> interaction.</li><li><strong>MAY</strong> support the	<code>search-system</code> interaction.</li><li><strong>MAY</strong> support the	<code>history-system</code> interaction.</li><h3 id="resource--details" class="no_toc">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary of Search Criteria</strong></p><table class="grid"><thead><tr><th>Resource Type</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="#bundle">Bundle</a></td><td><a href="StructureDefinition-alerts-bundle.html">Da Vinci Alerts Bundle Profile</a></td><td>
							
						</td><td>
							
						</td><td>
              
            </td><td>
							
						</td></tr><tr><td><a href="#communication">Communication</a></td><td><a href="StructureDefinition-alerts-communication.html">Da Vinci Alerts Communication Profile</a></td><td>
							
						</td><td>
							
						</td><td>
              
            </td><td>
							
						</td></tr><tr><td><a href="#coverage">Coverage</a></td><td>HRex Coverage Profile</td><td>
							
						</td><td>
							
						</td><td>
              
            </td><td>
							
						</td></tr><tr><td><a href="#endpoint">Endpoint</a></td><td><a href="StructureDefinition-alerts-endpoint.html">Da Vinci Alerts Endpoint Profile</a></td><td>
							
						</td><td>
							
						</td><td>
              
            </td><td>
							
						</td></tr></tbody></table><br/><h4 id="bundle" class="no_toc">Bundle</h4><p>Supported Profiles:
				
											<a href="StructureDefinition-alerts-bundle.html">Da Vinci Alerts Bundle Profile</a>
				
				</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support 
																							<code>history-instance</code>.</li><li><strong>MAY</strong> support 
																							<code>create</code>, 
																							<code>search-type</code>, 
																							<code>read</code>, 
																							<code>vread</code>, 
																							<code>update</code>, 
																							<code>patch</code>, 
																							<code>delete</code>, 
																							<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
					A Server <strong>MAY</strong> be capable of returning a Bundle resource using:
					<br/>
						<code class="highlighter-rouge">GET [base]/Bundle/[id]</code>
				</li><br/></ul><hr/><h4 id="communication" class="no_toc">Communication</h4><p>Supported Profiles:
				
											<a href="StructureDefinition-alerts-communication.html">Da Vinci Alerts Communication Profile</a>
				
				</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support 
																							<code>search-type</code>, 
																							<code>read</code>.</li><li><strong>SHOULD</strong> support 
																							<code>vread</code>, 
																							<code>history-instance</code>.</li><li><strong>MAY</strong> support 
																							<code>create</code>, 
																							<code>update</code>, 
																							<code>patch</code>, 
																							<code>delete</code>, 
																							<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
					A Server <strong>SHALL</strong> be capable of returning a Communication resource using:
					<br/>
						<code class="highlighter-rouge">GET [base]/Communication/[id]</code>
				</li><br/></ul><hr/><h4 id="coverage" class="no_toc">Coverage</h4><p>Supported Profiles:
				
											HRex Coverage Profile
				
				</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support 
																							<code>search-type</code>, 
																							<code>read</code>.</li><li><strong>SHOULD</strong> support 
																							<code>vread</code>, 
																							<code>history-instance</code>.</li><li><strong>MAY</strong> support 
																							<code>create</code>, 
																							<code>update</code>, 
																							<code>patch</code>, 
																							<code>delete</code>, 
																							<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
					A Server <strong>SHALL</strong> be capable of returning a Coverage resource using:
					<br/>
						<code class="highlighter-rouge">GET [base]/Coverage/[id]</code>
				</li><br/></ul><hr/><h4 id="endpoint" class="no_toc">Endpoint</h4><p>Supported Profiles:
				
											<a href="StructureDefinition-alerts-endpoint.html">Da Vinci Alerts Endpoint Profile</a>
				
				</p><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support 
																							<code>create</code>, 
																							<code>search-type</code>, 
																							<code>read</code>, 
																							<code>vread</code>, 
																							<code>update</code>, 
																							<code>patch</code>, 
																							<code>delete</code>, 
																							<code>history-instance</code>, 
																							<code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
					A Server <strong>MAY</strong> be capable of returning a Endpoint resource using:
					<br/>
						<code class="highlighter-rouge">GET [base]/Endpoint/[id]</code>
				</li><br/></ul><hr/><br/></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/davinci-alerts/CapabilityStatement/query-responder"/>
  <version value="0.1.0"/>
  <name value="QueryResponderCapabilityStatement"/>
  <title value="Query Responder CapabilityStatement"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2019-07-29T00:00:00-04:00"/>
  <publisher value="HL7 International - Clinical Decision Support Work Group"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cds/index.cfm"/>
    </telecom>
  </contact>
  <description
               value="This CapabilityStatement describes the expected capabilities of a server that is capable of responding to a follow up FHIR RESTful query from an  Alert Intermediary/Recipient."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.0"/>
  <format value="xml"/>
  <format value="json"/>
  <patchFormat value="application/json-patch+json"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/davinci-alerts/ImplementationGuide/hl7.fhir.us.davinci-alerts-0.1.0"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core-3.0.0"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="The Da Vinci Alerts Query Responder **SHALL**:

1. Support at least one use case defined in this Guide and listed in the [Scenarios](index.html#scenarios) Section.
1. Implement the RESTful behavior according to the FHIR specification.
1. Support json source formats for all Da Vinci Alert interactions.
1. Declare a CapabilityStatement identifying the scenarios, transactions and profiles supported.

The Da Vinci Alerts Query Responder **SHOULD**:

1. Support xml source formats for all Da Vinci Alert interactions.
1. Identify the Da Vinci Alert or US Core profiles supported as part of the FHIR `meta.profile` attribute for each instance."/>
    <security>
      <description
                   value="1. For general security consideration refer to the [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html). 
1. For security considerations specific to this guide refer to the  [Security](security.html) page for requirements and recommendations.
1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."/>
    </security>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <type value="Bundle"/>
      <profile value="http://hl7.org/fhir/StructureDefinition/Bundle"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/alerts-bundle"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="create"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="read"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="vread"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="update"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="patch"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-type"/>
      </interaction>
      <referencePolicy value="resolves"/>
    </resource>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <type value="Communication"/>
      <profile value="http://hl7.org/fhir/StructureDefinition/Communication"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/alerts-communication"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="create"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="update"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="patch"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-type"/>
      </interaction>
      <referencePolicy value="resolves"/>
    </resource>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <type value="Coverage"/>
      <profile value="http://hl7.org/fhir/StructureDefinition/Coverage"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-coverage"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="create"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="update"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="patch"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-type"/>
      </interaction>
      <referencePolicy value="resolves"/>
    </resource>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <type value="Endpoint"/>
      <profile value="http://hl7.org/fhir/StructureDefinition/Endpoint"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-alerts/StructureDefinition/alerts-endpoint"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="create"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="read"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="vread"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="update"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="patch"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-type"/>
      </interaction>
      <referencePolicy value="resolves"/>
    </resource>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="transaction"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="batch"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="search-system"/>
    </interaction>
    <interaction>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="history-system"/>
    </interaction>
  </rest>
</CapabilityStatement>