Capabilitystatement2-terminology-server.xml

Terminology Server Base Capability Statement (id = "terminology-server")

<?xml version="1.0" encoding="UTF-8"?>

<CapabilityStatement2 xmlns="http://hl7.org/fhir">
  <id value="terminology-server"/> 
<!--    
    in addition to the code systems defined in line in value sets, 
    terminology servers also provide terminology functionality on 
    additional code systems. Typically, LOINC, SNOMED CT, RcNorm in USA, etc.). 
    
    These extra code systems are declared here in this extension. It's a todo 
    for a future version to standardise things like which versions are supported etc. 
      -->
  <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative</b> </p> <p> <b> Supported Code System</b> : <a> http://loinc.org</a> </p> <p> <b> url</b> : <code> http://hl7.org/fhir/terminology-server</code> </p> <p> <b> name</b> : Terminology Service Capability Statement</p> <p> <b> status</b> : draft</p> <p> <b> date</b> : 2015-07-05</p> <p> <b> publisher</b> : HL7, Inc</p> <p> <b> contact</b> : FHIR Project: <a> http://hl7.org/fhir</a> </p> <p> <b> description</b> : Basic capability statement for a Terminology Server. A server can support more fucntionality
         than defined here, but this is the minimum amount</p> <p> <b> kind</b> : capability</p> <h3> Softwares</h3> <table> <tr> <td> -</td> <td> <b> Name</b> </td> </tr> <tr> <td> *</td> <td> ACME Terminology Server</td> </tr> </table> <p> <b> fhirVersion</b> : 4.6.0</p> <p> <b> format</b> : json, xml</p> <blockquote> <p> <b> rest</b> </p> <p> <b> mode</b> : server</p> <p> <b> documentation</b> : RESTful Terminology Server</p> <blockquote> <p> <b> resource</b> </p> <p> <b> type</b> : ValueSet</p> <p> <b> profile</b> : <a> http://hl7.org/fhir/StructureDefinition/ValueSet</a> </p> <blockquote> <p> <b> interaction</b> </p> <p> <b> Conformance expectation</b> : SHALL</p> <p> <b> code</b> : read</p> <p> <b> documentation</b> : Read allows clients to get the logical definitions of the value sets</p> </blockquote> <blockquote> <p> <b> interaction</b> </p> <p> <b> Conformance expectation</b> : SHALL</p> <p> <b> code</b> : search-type</p> <p> <b> documentation</b> : Search allows clients to find value sets on the server</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : date</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ValueSet-date</a> </p> <p> <b> type</b> : date</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : name</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ValueSet-name</a> </p> <p> <b> type</b> : string</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : reference</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ValueSet-reference</a> </p> <p> <b> type</b> : token</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : status</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ValueSet-status</a> </p> <p> <b> type</b> : token</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : url</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ValueSet-url</a> </p> <p> <b> type</b> : uri</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : version</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ValueSet-version</a> </p> <p> <b> type</b> : token</p> </blockquote> </blockquote> <blockquote> <p> <b> resource</b> </p> <p> <b> type</b> : ConceptMap</p> <p> <b> profile</b> : <a> http://hl7.org/fhir/StructureDefinition/ConceptMap</a> </p> <blockquote> <p> <b> interaction</b> </p> <p> <b> Conformance expectation</b> : SHALL</p> <p> <b> code</b> : read</p> <p> <b> documentation</b> : Read allows clients to get the logical definitions of the concept maps</p> </blockquote> <blockquote> <p> <b> interaction</b> </p> <p> <b> Conformance expectation</b> : SHALL</p> <p> <b> code</b> : search-type</p> <p> <b> documentation</b> : Search allows clients to find concept maps on the server</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : date</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ConceptMap-date</a> </p> <p> <b> type</b> : date</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : name</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ConceptMap-name</a> </p> <p> <b> type</b> : string</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : status</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ConceptMap-status</a> </p> <p> <b> type</b> : token</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : source</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ConceptMap-source</a> </p> <p> <b> type</b> : uri</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : target</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ConceptMap-target</a> </p> <p> <b> type</b> : uri</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : url</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ConceptMap-url</a> </p> <p> <b> type</b> : uri</p> </blockquote> <blockquote> <p> <b> searchParam</b> </p> <p> <b> name</b> : version</p> <p> <b> definition</b> : <a> http://hl7.org/fhir/SearchParameter/ConceptMap-version</a> </p> <p> <b> type</b> : token</p> </blockquote> </blockquote> <h3> Operations</h3> <table> <tr> <td> -</td> </tr> <tr> <td> *</td> </tr> <tr> <td> *</td> </tr> <tr> <td> *</td> </tr> <tr> <td> *</td> </tr> <tr> <td> *</td> </tr> </table> </blockquote> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement2-supported-system">
    <valueUri value="http://loinc.org"/> 
  </extension> 
  <url value="http://hl7.org/fhir/terminology-server"/> 
  <name value="Terminology Service Capability Statement"/> 
  <status value="draft"/> 
  <date value="2015-07-05"/> 
  <publisher value="HL7, Inc"/> 
  <contact> 
    <name value="FHIR Project"/> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="Basic capability statement for a Terminology Server. A server can support more fucntionality
   than defined here, but this is the minimum amount"/> 
  <kind value="capability"/> 
  <software> 
    <name value="ACME Terminology Server"/> 
  </software> 
  <fhirVersion value="4.6.0"/> 
<!--     json is mandatory, for support of mobile clients     -->
  <format value="json"/> 
<!--     xml is optional, but strongly recommended     -->
  <format value="xml"/> 
<!--     profile - terminology servers may consider 
    supporting the shareable value set directly, but
    are not required. HL7 servers will
  <profile value="http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"/>
    
      -->
  <rest> 
    <mode value="server"/> 
    <documentation value="RESTful Terminology Server"/> 
    <!--     <security>
    <!-.-  yes - terminology servers are expected to be used from web applications, and
     need to implement CORS  -.->
      <cors value="true"/>
    <!-.-  this bit is optional: security using registered client certificates  -.->
      <service>
        <coding>
          <system value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
          <code value="Certificates"/>
        </coding>
      </service>
    </security>    -->
  <!--     Server could implement value set & concept map editing using 
         SMART-on-FHIR, but this doesn't make sense for the actual terminology services
     API
      <service>
        <coding>
          <system value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
          <code value="SMART-on-FHIR"/>
        </coding>
      </service>
          -->
  <!--     value set. Must provide read and search     -->
    <resource> 
      <type value="ValueSet"/> 
      <profile value="http://hl7.org/fhir/StructureDefinition/ValueSet"/> 
      <interaction> 
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement2-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/capabilitystatement2-expectation">
          <valueCode value="SHALL"/> 
        </extension> 
        <code value="search-type"/> 
        <documentation value="Search allows clients to find value sets on the server"/> 
      </interaction> 
    <!--     
        servers should also consider offering these interactions to allow clients 
        to edit the content on the server, but are not required to do so
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
    <code value="update"/>
    </interaction>
      <interaction>
    <code value="delete"/>
    </interaction>
      
      this bit is up to servers - if they support editing, they should do so version safely
      <versioning value="versioned-update"/>
          -->
    <!--     no need for version history (though servers can), and no need to conditional updates
       etc.    -->
    <!--     search parameters: at least code, date, name, reference, status, system, url and version.
       More is recommended     -->
      <searchParam> 
        <name value="date"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ValueSet-date"/> 
        <type value="date"/> 
      </searchParam> 
      <searchParam> 
        <name value="name"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ValueSet-name"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="reference"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ValueSet-reference"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="status"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ValueSet-status"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="url"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ValueSet-url"/> 
        <type value="uri"/> 
      </searchParam> 
      <searchParam> 
        <name value="version"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ValueSet-version"/> 
        <type value="token"/> 
      </searchParam> 
    </resource> 
    <resource> 
      <type value="ConceptMap"/> 
      <profile value="http://hl7.org/fhir/StructureDefinition/ConceptMap"/> 
      <interaction> 
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement2-expectation">
          <valueCode value="SHALL"/> 
        </extension> 
        <code value="read"/> 
        <documentation value="Read allows clients to get the logical definitions of the concept maps"/> 
      </interaction> 
      <interaction> 
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement2-expectation">
          <valueCode value="SHALL"/> 
        </extension> 
        <code value="search-type"/> 
        <documentation value="Search allows clients to find concept maps on the server"/> 
      </interaction> 
    <!--     
        servers should also consider offering these interactions to allow clients 
        to edit the content on the server, but are not required to do so
      <interaction>
    <code value="create"/>
    </interaction>
      <interaction>
    <code value="update"/>
    </interaction>
      <interaction>
    <code value="delete"/>
    </interaction>
      
      this bit is up to servers - if they support editing, they should do so version safely
      <versioning value="versioned-update"/>
          -->
    <!--     no need for version history (though servers can), and no need to conditional updates
       etc.    -->
    <!--     search parameters: at least date, name, status, source, target, url, version. More
       is recommended     -->
      <searchParam> 
        <name value="date"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-date"/> 
        <type value="date"/> 
      </searchParam> 
      <searchParam> 
        <name value="name"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-name"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="status"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-status"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="source"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-source"/> 
        <type value="uri"/> 
      </searchParam> 
      <searchParam> 
        <name value="target"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-target"/> 
        <type value="uri"/> 
      </searchParam> 
      <searchParam> 
        <name value="url"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-url"/> 
        <type value="uri"/> 
      </searchParam> 
      <searchParam> 
        <name value="version"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-version"/> 
        <type value="token"/> 
      </searchParam> 
    </resource> 
  <!--     now, operations. We expect terminology services to implement these 
      named services, though not necessarily actually these profiles     -->
    <operation> 
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement2-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/capabilitystatement2-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/capabilitystatement2-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/capabilitystatement2-expectation">
        <valueCode value="SHALL"/> 
      </extension> 
      <name value="translate"/> 
      <definition value="http://hl7.org/fhir/OperationDefinition/ConceptMap-translate"/> 
    </operation> 
    <operation> 
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement2-expectation">
        <valueCode value="SHOULD"/> 
      </extension> 
      <name value="closure"/> 
      <definition value="http://hl7.org/fhir/OperationDefinition/ConceptMap-closure"/> 
    </operation> 
  </rest> 
</CapabilityStatement2>