This page is part of the FHIR Specification (v3.0.2: STU 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 | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
Terminology Server Base Capability Statement
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource ------------------------------------------------------------------- <http://hl7.org/fhir/CapabilityStatement/terminology-server> a fhir:CapabilityStatement; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "terminology-server"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Terminology Service Capability Statement</h2>\n <div>\n <p>Basic capability statement for a Terminology Server. A server can support more fucntionality than defined here, but this is the minimum amount</p>\n\n </div>\n <table>\n <tr>\n <td>Mode</td>\n <td>SERVER</td>\n </tr>\n <tr>\n <td>Description</td>\n <td>RESTful Terminology Server</td>\n </tr>\n <tr>\n <td>Transaction</td>\n <td/>\n </tr>\n <tr>\n <td>System History</td>\n <td/>\n </tr>\n <tr>\n <td>System Search</td>\n <td/>\n </tr>\n </table>\n <table>\n <tr>\n <th>\n <b>Resource Type</b>\n </th>\n <th>\n <b>Profile</b>\n </th>\n <th>\n <b>Read</b>\n </th>\n <th>\n <b>V-Read</b>\n </th>\n <th>\n <b>Search</b>\n </th>\n <th>\n <b>Update</b>\n </th>\n <th>\n <b>Updates</b>\n </th>\n <th>\n <b>Create</b>\n </th>\n <th>\n <b>Delete</b>\n </th>\n <th>\n <b>History</b>\n </th>\n </tr>\n <tr>\n <td>ValueSet</td>\n <td>\n <a href=\"StructureDefinition/ValueSet\">StructureDefinition/ValueSet</a>\n </td>\n <td>y</td>\n <td/>\n <td>y</td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <td>ConceptMap</td>\n <td>\n <a href=\"StructureDefinition/ConceptMap\">StructureDefinition/ConceptMap</a>\n </td>\n <td>y</td>\n <td/>\n <td>y</td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n </table>\n </div>" ]; fhir:DomainResource.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-supported-system" ]; fhir:Extension.valueUri [ fhir:value "http://loinc.org" ] ]; fhir:CapabilityStatement.url [ fhir:value "http://hl7.org/fhir/terminology-server"]; fhir:CapabilityStatement.name [ fhir:value "Terminology Service Capability Statement"]; fhir:CapabilityStatement.status [ fhir:value "draft"]; fhir:CapabilityStatement.date [ fhir:value "2015-07-05"^^xsd:date]; fhir:CapabilityStatement.publisher [ fhir:value "HL7, Inc"]; fhir:CapabilityStatement.contact [ fhir:index 0; fhir:ContactDetail.name [ fhir:value "FHIR Project" ]; fhir:ContactDetail.telecom [ fhir:index 0; fhir:ContactPoint.system [ fhir:value "url" ]; fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ] ] ]; fhir:CapabilityStatement.description [ fhir:value "Basic capability statement for a Terminology Server. A server can support more fucntionality than defined here, but this is the minimum amount"]; fhir:CapabilityStatement.kind [ fhir:value "capability"]; fhir:CapabilityStatement.software [ fhir:CapabilityStatement.software.name [ fhir:value "ACME Terminology Server" ] ]; fhir:CapabilityStatement.fhirVersion [ fhir:value "3.0.2"]; fhir:CapabilityStatement.acceptUnknown [ fhir:value "both"]; fhir:CapabilityStatement.format [ fhir:value "json"; fhir:index 0 ], [ fhir:value "xml"; fhir:index 1 ]; fhir:CapabilityStatement.rest [ fhir:index 0; fhir:CapabilityStatement.rest.mode [ fhir:value "server" ]; fhir:CapabilityStatement.rest.documentation [ fhir:value "RESTful Terminology Server" ]; fhir:CapabilityStatement.rest.security [ fhir:CapabilityStatement.rest.security.cors [ fhir:value "true"^^xsd:boolean ]; fhir:CapabilityStatement.rest.security.service [ fhir:index 0; fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://hl7.org/fhir/restful-security-service" ]; fhir:Coding.code [ fhir:value "Certificates" ] ] ] ]; fhir:CapabilityStatement.rest.resource [ fhir:index 0; fhir:CapabilityStatement.rest.resource.type [ fhir:value "ValueSet" ]; fhir:CapabilityStatement.rest.resource.profile [ fhir:link <http://hl7.org/fhir/StructureDefinition/ValueSet>; fhir:Reference.reference [ fhir:value "StructureDefinition/ValueSet" ] ]; fhir:CapabilityStatement.rest.resource.interaction [ fhir:index 0; fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]; fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Read allows clients to get the logical definitions of the value sets" ] ], [ fhir:index 1; fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]; fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Search allows clients to find value sets on the server" ] ]; fhir:CapabilityStatement.rest.resource.searchParam [ fhir:index 0; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "date" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ValueSet-date" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "date" ] ], [ fhir:index 1; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "name" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ValueSet-name" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ] ], [ fhir:index 2; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "reference" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ValueSet-reference" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ] ], [ fhir:index 3; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "status" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ValueSet-status" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ] ], [ fhir:index 4; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "url" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ValueSet-url" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "uri" ] ], [ fhir:index 5; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "version" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ValueSet-version" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ] ] ], [ fhir:index 1; fhir:CapabilityStatement.rest.resource.type [ fhir:value "ConceptMap" ]; fhir:CapabilityStatement.rest.resource.profile [ fhir:link <http://hl7.org/fhir/StructureDefinition/ConceptMap>; fhir:Reference.reference [ fhir:value "StructureDefinition/ConceptMap" ] ]; fhir:CapabilityStatement.rest.resource.interaction [ fhir:index 0; fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]; fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Read allows clients to get the logical definitions of the concept maps" ] ], [ fhir:index 1; fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]; fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Search allows clients to find concept maps on the server" ] ]; fhir:CapabilityStatement.rest.resource.searchParam [ fhir:index 0; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "date" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ConceptMap-date" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "date" ] ], [ fhir:index 1; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "name" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ConceptMap-name" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ] ], [ fhir:index 2; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "status" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ConceptMap-status" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ] ], [ fhir:index 3; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "source" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ConceptMap-source" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "uri" ] ], [ fhir:index 4; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "target" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ConceptMap-target" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "uri" ] ], [ fhir:index 5; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "url" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ConceptMap-url" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "uri" ] ], [ fhir:index 6; fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "version" ]; fhir:CapabilityStatement.rest.resource.searchParam.definition [ fhir:value "http://hl7.org/fhir/SearchParameter/ConceptMap-version" ]; fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ] ] ]; fhir:CapabilityStatement.rest.operation [ fhir:index 0; fhir:CapabilityStatement.rest.operation.name [ fhir:value "expand" ]; fhir:CapabilityStatement.rest.operation.definition [ fhir:link <http://hl7.org/fhir/OperationDefinition/ValueSet-expand>; fhir:Reference.reference [ fhir:value "OperationDefinition/ValueSet-expand" ] ] ], [ fhir:index 1; fhir:CapabilityStatement.rest.operation.name [ fhir:value "lookup" ]; fhir:CapabilityStatement.rest.operation.definition [ fhir:link <http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup>; fhir:Reference.reference [ fhir:value "OperationDefinition/CodeSystem-lookup" ] ] ], [ fhir:index 2; fhir:CapabilityStatement.rest.operation.name [ fhir:value "validate-code" ]; fhir:CapabilityStatement.rest.operation.definition [ fhir:link <http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code>; fhir:Reference.reference [ fhir:value "OperationDefinition/ValueSet-validate-code" ] ] ], [ fhir:index 3; fhir:CapabilityStatement.rest.operation.name [ fhir:value "translate" ]; fhir:CapabilityStatement.rest.operation.definition [ fhir:link <http://hl7.org/fhir/OperationDefinition/ConceptMap-translate>; fhir:Reference.reference [ fhir:value "OperationDefinition/ConceptMap-translate" ] ] ], [ fhir:index 4; fhir:CapabilityStatement.rest.operation.name [ fhir:value "closure" ]; fhir:CapabilityStatement.rest.operation.definition [ fhir:link <http://hl7.org/fhir/OperationDefinition/ConceptMap-closure>; fhir:Reference.reference [ fhir:value "OperationDefinition/ConceptMap-closure" ] ] ] ] . <http://hl7.org/fhir/StructureDefinition/ValueSet> a fhir:StructureDefinition . <http://hl7.org/fhir/StructureDefinition/ConceptMap> a fhir:StructureDefinition . <http://hl7.org/fhir/OperationDefinition/ValueSet-expand> a fhir:OperationDefinition . <http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup> a fhir:OperationDefinition . <http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code> a fhir:OperationDefinition . <http://hl7.org/fhir/OperationDefinition/ConceptMap-translate> a fhir:OperationDefinition . <http://hl7.org/fhir/OperationDefinition/ConceptMap-closure> a fhir:OperationDefinition . # - ontology header ------------------------------------------------------------ <http://hl7.org/fhir/CapabilityStatement/terminology-server.ttl> a owl:Ontology; owl:imports fhir:fhir.ttl; owl:versionIRI <http://hl7.org/fhir/STU3/CapabilityStatement/terminology-server.ttl> . # -------------------------------------------------------------------------------------
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.