Using CQL with FHIR
1.1.0-cibuild - CIBuild International flag

Using CQL with FHIR, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cql-ig/ and changes regularly. See the Directory of published versions

: Library Evaluation Service Capability Statement Example - JSON Representation

Draft as of 2016-09-16

Raw json | Download


{
  "resourceType" : "CapabilityStatement",
  "id" : "cql-evaluation-service-example",
  "meta" : {
    "profile" : [
      🔗 "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-capabilitystatement"
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">Library Evaluation Service Capability Statement Example</h2><ul><li>Implementation Guide Version: 1.1.0-cibuild </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Supported Patch Formats: </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 CapabilityStatementKnowledge 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>\n</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=\"lead\"><em>Summary of System-wide Interactions</em></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>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><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: supported </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\">http://hl7.org/fhir/StructureDefinition/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 <code>read</code>, <code>search-type</code>.</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\">\u00a0</div></div></div></div></div></div>"
  },
  "url" : "http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service-example",
  "version" : "1.1.0-cibuild",
  "name" : "LibraryEvaluationServiceCapabilityStatementExample",
  "title" : "Library Evaluation Service Capability Statement Example",
  "status" : "draft",
  "date" : "2016-09-16",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "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" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "kind" : "instance",
  "instantiates" : [
    "http://hl7.org/fhir/knowledge-repository"
  ],
  "software" : {
    "name" : "ACME Library Evaluation Service"
  },
  "implementation" : {
    "description" : "This service supports basic library repository features as well as library evaluation using the $evaluate operation.",
    "url" : "https://example.org/fhir"
  },
  "fhirVersion" : "4.0.1",
  "format" : [
    "json",
    "xml"
  ],
  "rest" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/cqf-supportedCqlVersion",
          "valueString" : "1.5"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/cqf-supportedCqlVersion",
          "valueString" : "1.4"
        }
      ],
      "mode" : "server",
      "documentation" : "RESTful Library Evaluation Service",
      "security" : {
        "cors" : true,
        "service" : [
          {
            "coding" : [
              {
                "system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code" : "Certificates"
              }
            ]
          }
        ]
      },
      "resource" : [
        {
          "type" : "Library",
          "profile" : "http://hl7.org/fhir/StructureDefinition/Library",
          "interaction" : [
            {
              "code" : "read",
              "documentation" : "Read allows clients to get the logical definitions of the libraries"
            },
            {
              "code" : "search-type",
              "documentation" : "Search allows clients to find libraries on the server"
            }
          ],
          "searchParam" : [
            {
              "name" : "description",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-description",
              "type" : "string"
            },
            {
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-identifier",
              "type" : "token"
            },
            {
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-status",
              "type" : "token"
            },
            {
              "name" : "title",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-title",
              "type" : "string"
            },
            {
              "name" : "topic",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-topic",
              "type" : "token"
            },
            {
              "name" : "version",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-version",
              "type" : "token"
            },
            {
              "name" : "url",
              "definition" : "http://hl7.org/fhir/SearchParameter/Library-url",
              "type" : "uri"
            }
          ]
        }
      ],
      "operation" : [
        {
          "name" : "cql",
          "definition" : "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-cql"
        },
        {
          "name" : "evaluate",
          "definition" : "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-library-evaluate"
        }
      ]
    }
  ]
}