Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

: CRMI Artifact Terminology Service - XML Representation

Draft as of 2015-07-05

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="crmi-artifact-terminology-service"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>CRMIArtifactTerminologyService</h2><div><p>Capability statement for a terminology service supporting artifact authoring and evaulation use cases. A server can support more functionality than defined here, but this defines the minimum expectations.</p>
</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td><div><p>RESTful Artifact Terminology Server</p>
</div></td></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="POST a new resource (create interaction)">Create</b></th></tr><tr><td>CodeSystem</td><td><a href="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablecodesystem">http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablecodesystem</a><br/>Additional supported profiles:<br/>  <a href="StructureDefinition-crmi-publishablecodesystem.html">CRMI Publishable CodeSystem</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>ValueSet</td><td><a href="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablevalueset">http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablevalueset</a><br/>Additional supported profiles:<br/>  <a href="StructureDefinition-crmi-computablevalueset.html">CRMI Computable ValueSet</a><br/>  <a href="StructureDefinition-crmi-executablevalueset.html">CRMI Executable ValueSet</a><br/>  <a href="StructureDefinition-crmi-publishablevalueset.html">CRMI Publishable ValueSet</a></td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Library</td><td><a href="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary">http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary</a><br/>Additional supported profiles:<br/>  <a href="StructureDefinition-crmi-publishablelibrary.html">CRMI Publishable Library</a><br/>  <a href="StructureDefinition-crmi-computablelibrary.html">CRMI Computable Library</a><br/>  <a href="StructureDefinition-crmi-executablelibrary.html">CRMI Executable Library</a><br/>  <a href="StructureDefinition-crmi-modelinfolibrary.html">CRMI Model Info Library</a><br/>  <a href="StructureDefinition-crmi-manifestlibrary.html">CRMI Manifest Library</a><br/>  <a href="StructureDefinition-crmi-moduledefinitionlibrary.html">CRMI Module Definition Library</a></td><td>y</td><td>y</td><td></td><td></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-supported-system">
    <valueUri value="http://loinc.org"/>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/crmi/CapabilityStatement/crmi-artifact-terminology-service"/>
  <version value="1.0.0-ballot"/>
  <name value="CRMIArtifactTerminologyService"/>
  <title value="CRMI Artifact Terminology Service"/>
  <status value="draft"/>
  <experimental value="false"/>
  <date value="2015-07-05"/>
  <publisher value="Clinical Decision Support WG"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/dss"/>
    </telecom>
  </contact>
  <description
               value="Capability statement for a terminology service supporting artifact authoring and evaulation use cases. A server can support more functionality than defined here, but this defines the minimum expectations."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="json"/>
  <format value="xml"/>
  <implementationGuide
                       value="http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi"/>
  <rest>
    <mode value="server"/>
    <documentation value="RESTful Artifact Terminology Server"/>
    <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="CodeSystem"/>
      <profile
               value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablecodesystem"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablecodesystem"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Read allows clients to get the definitions and details of supported code systems"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="Search allows clients to search for supported code systems"/>
      </interaction>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="url"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-url"/>
        <type value="uri"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="version"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-version"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="name"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-name"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="title"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-title"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="description"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-description"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-status"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="code"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/CodeSystem-code"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="ValueSet"/>
      <profile
               value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablevalueset"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-computablevalueset"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-executablevalueset"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablevalueset"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Read allows clients to get the logical definitions of the value sets"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="Search allows clients to find value sets on the server"/>
      </interaction>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="date"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-date"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="name"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-name"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="title"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-title"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="description"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-description"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-status"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="url"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-url"/>
        <type value="uri"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="version"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-version"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="code"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/ValueSet-code"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="context"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-context"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="context-type"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-context-type"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="context-type-quantity"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity"/>
        <type value="composite"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="context-type-value"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/conformance-context-type-value"/>
        <type value="composite"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Library"/>
      <profile
               value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablelibrary"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-computablelibrary"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-executablelibrary"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-modelinfolibrary"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-moduledefinitionlibrary"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Read allows clients to get the logical definitions of the available artifact libraries"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="Search allows clients to find artifact libraries on the server"/>
      </interaction>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="date"/>
        <definition value="http://hl7.org/fhir/SearchParameter/Library-date"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="name"/>
        <definition value="http://hl7.org/fhir/SearchParameter/Library-name"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="title"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Library-title"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Library-identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="description"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Library-description"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Library-status"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="url"/>
        <definition value="http://hl7.org/fhir/SearchParameter/Library-url"/>
        <type value="uri"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="version"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Library-version"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="composed-of"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Library-composed-of"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="depends-on"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/Library-composed-of"/>
        <type value="reference"/>
      </searchParam>
    </resource>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="expand"/>
      <definition
                  value="http://hl7.org/fhir/OperationDefinition/ValueSet-expand"/>
    </operation>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHOULD"/>
      </extension>
      <name value="expand"/>
      <definition
                  value="http://hl7.org/fhir/uv/crmi/OperationDefinition/ValueSet-expand"/>
    </operation>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="lookup"/>
      <definition
                  value="http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup"/>
    </operation>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="validate-code"/>
      <definition
                  value="http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"/>
    </operation>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="translate"/>
      <definition
                  value="http://hl7.org/fhir/uv/crmi/OperationDefinition/Library-package"/>
    </operation>
  </rest>
</CapabilityStatement>