Using CQL With FHIR
3.0.0-ballot - STU 3 Ballot

Using CQL With FHIR - Downloaded Version null See the Directory of published versions

## : Library Evaluation Service Capability Statement Example

Page standards status: Informative

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="cql-evaluation-service-example"/>
      <meta>
        <profile
                 value="http://hl7.org/fhir/uv/cql/StructureDefinition/cql-capabilitystatement"/>
      </meta>
      <language value="en"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement cql-evaluation-service-example</b></p><a name="cql-evaluation-service-example"> </a><a name="hccql-evaluation-service-example"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-cql-capabilitystatement.html">CQL Capability Statement</a></p></div><h2 id="title">Library Evaluation Service Capability Statement Example</h2><ul><li>Implementation Guide Version: 3.0.0-ballot </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Published on: 2016-09-16 </li><li>Published by: HL7 International / Clinical Decision Support </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><p>This CapabilityStatement instantiates the CapabilityStatement <code>http://hl7.org/fhir/knowledge-repository</code> (Knowledge Repository Service Conformance Statement)</p><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div><p>RESTful Library Evaluation Service</p>
    </div><div class="lead"><em>Security</em></div><div class="row"><div class="col-lg-6">Enable CORS: yes</div><div class="col-lg-6">Security services supported: <code>Certificates</code></div></div><div class="row"><div class="col-12"><span class="lead">Summary of System-wide Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-cql-cql.html">$cql</a></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-cql-library-evaluate.html">$evaluate</a></td><td><div/></td></tr></tbody></table></div></div></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Library1-1">Library</a></td><td><a href="http://hl7.org/fhir/R4/library.html">http://hl7.org/fhir/StructureDefinition/Library</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>description, identifier, status, title, topic, version, url</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Library1-1" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>Library</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="http://hl7.org/fhir/R4/library.html">Library</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <br/><code>read</code><div><p>Read allows clients to get the logical definitions of the libraries</p>
    </div><code>search-type</code><div><p>Search allows clients to find libraries on the server</p>
    </div></li></ul></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/library.html#search">description</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/library.html#search">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/library.html#search">status</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/library.html#search">title</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/library.html#search">topic</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/library.html#search">version</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/library.html#search">url</a></td><td><code>uri</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
      </text>
      <url
           value="http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service-example"/>
      <version value="3.0.0-ballot"/>
      <name value="LibraryEvaluationServiceCapabilityStatementExample"/>
      <title value="Library Evaluation Service Capability Statement Example"/>
      <status value="draft"/>
      <date value="2016-09-16"/>
      <publisher value="HL7 International / Clinical Decision Support"/>
      <contact>
        <telecom>
          <system value="url"/>
          <value value="http://www.hl7.org/Special/committees/dss"/>
        </telecom>
      </contact>
      <description
                   value="Basic conformance statement for a Library Evaluation Service. A server can support more functionality    than defined here, but this is the minimum amount"/>
      <jurisdiction>
        <coding>
          <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
          <code value="001"/>
          <display value="World"/>
        </coding>
      </jurisdiction>
      <kind value="instance"/>
      <instantiates value="http://hl7.org/fhir/knowledge-repository"/>
      <software>
        <name value="ACME Library Evaluation Service"/>
      </software>
      <implementation>
        <description
                     value="This service supports basic library repository features as well as library evaluation using the $evaluate operation."/>
        <url value="https://example.org/fhir"/>
      </implementation>
      <fhirVersion value="4.0.1"/>
      <format value="json"/>
      <format value="xml"/>
      <rest>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/cqf-supportedCqlVersion">
          <valueString value="1.5"/>
        </extension>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/cqf-supportedCqlVersion">
          <valueString value="1.4"/>
        </extension>
        <mode value="server"/>
        <documentation value="RESTful Library Evaluation Service"/>
        <security>
          <cors value="true"/>
          <service>
            <coding>
              <system
                      value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
              <code value="Certificates"/>
            </coding>
          </service>
        </security>
        <resource>
          <type value="Library"/>
          <profile value="http://hl7.org/fhir/StructureDefinition/Library"/>
          <interaction>
            <code value="read"/>
            <documentation
                           value="Read allows clients to get the logical definitions of the libraries"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
            <documentation
                           value="Search allows clients to find libraries on the server"/>
          </interaction>
          <searchParam>
            <name value="description"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Library-description"/>
            <type value="string"/>
          </searchParam>
          <searchParam>
            <name value="identifier"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Library-identifier"/>
            <type value="token"/>
          </searchParam>
          <searchParam>
            <name value="status"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Library-status"/>
            <type value="token"/>
          </searchParam>
          <searchParam>
            <name value="title"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Library-title"/>
            <type value="string"/>
          </searchParam>
          <searchParam>
            <name value="topic"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Library-topic"/>
            <type value="token"/>
          </searchParam>
          <searchParam>
            <name value="version"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Library-version"/>
            <type value="token"/>
          </searchParam>
          <searchParam>
            <name value="url"/>
            <definition value="http://hl7.org/fhir/SearchParameter/Library-url"/>
            <type value="uri"/>
          </searchParam>
        </resource>
        <operation>
          <name value="cql"/>
          <definition
                      value="http://hl7.org/fhir/uv/cql/OperationDefinition/cql-cql"/>
        </operation>
        <operation>
          <name value="evaluate"/>
          <definition
                      value="http://hl7.org/fhir/uv/cql/OperationDefinition/cql-library-evaluate"/>
        </operation>
      </rest>
    </CapabilityStatement>