This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw XML (canonical form + also see XML Format Specification)
Terminology Server Base Capability Statement (id = "terminology-server")
<?xml version="1.0" encoding="UTF-8"?> <CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="terminology-server"/> <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml"> <h2> Terminology Service Capability Statement</h2> <div> <p> Basic capability statement for a Terminology Server. A server can support more fucntionality than defined here, but this is the minimum amount</p> </div> <table> <tr> <td> Mode</td> <td> SERVER</td> </tr> <tr> <td> Description</td> <td> RESTful Terminology Server</td> </tr> <tr> <td> Transaction</td> <td/> </tr> <tr> <td> System History</td> <td/> </tr> <tr> <td> System Search</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> ValueSet</td> <td> <a href="http://hl7.org/fhir/StructureDefinition/ValueSet">http://hl7.org/fhir/StructureDefinition/ValueSet</a> </td> <td> y</td> <td> y</td> <td/> <td/> </tr> <tr> <td> ConceptMap</td> <td> <a href="http://hl7.org/fhir/StructureDefinition/ConceptMap">http://hl7.org/fhir/StructureDefinition/ConceptMap</a> </td> <td> y</td> <td> y</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/terminology-server"/> <version value="4.5.0"/> <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.5.0"/> <format value="json"/> <format value="xml"/> <rest> <mode value="server"/> <documentation value="RESTful 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="ValueSet"/> <profile value="http://hl7.org/fhir/StructureDefinition/ValueSet"/> <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> <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="uri"/> </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/capabilitystatement-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/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Search allows clients to find concept maps on the server"/> </interaction> <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="reference"/> </searchParam> <searchParam> <name value="target"/> <definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-target"/> <type value="reference"/> </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> <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="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/OperationDefinition/ConceptMap-translate"/> </operation> <operation> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="closure"/> <definition value="http://hl7.org/fhir/OperationDefinition/ConceptMap-closure"/> </operation> </rest> </CapabilityStatement>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.