Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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

Example CapabilityStatement/example-terminology-server (Turtle)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

Raw Turtle (+ also see Turtle/RDF Format Specification)

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 -------------------------------------------------------------------

[a fhir:CapabilityStatement;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example-terminology-server"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "extensions" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <h2>ACMETerminologyService—CapabilityStatement</h2>\n      <div>\n        <p>Example 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/>\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 title=\"GET a resource (read interaction)\">Read</b>\n          </th>\n          <th>\n            <b title=\"GET all set of resources of the type (search interaction)\">Search</b>\n          </th>\n          <th>\n            <b title=\"PUT a new resource version (update interaction)\">Update</b>\n          </th>\n          <th>\n            <b title=\"POST a new resource (create interaction)\">Create</b>\n          </th>\n        </tr>\n        <tr>\n          <td>CodeSystem</td>\n          <td>\n            <a href=\"http://hl7.org/fhir/StructureDefinition/CodeSystem\">http://hl7.org/fhir/StructureDefinition/CodeSystem</a>\n          </td>\n          <td>y</td>\n          <td>y</td>\n          <td/>\n          <td/>\n        </tr>\n        <tr>\n          <td>ValueSet</td>\n          <td>\n            <a href=\"http://hl7.org/fhir/StructureDefinition/ValueSet\">http://hl7.org/fhir/StructureDefinition/ValueSet</a>\n          </td>\n          <td>y</td>\n          <td>y</td>\n          <td/>\n          <td/>\n        </tr>\n        <tr>\n          <td>ConceptMap</td>\n          <td>\n            <a href=\"http://hl7.org/fhir/StructureDefinition/ConceptMap\">http://hl7.org/fhir/StructureDefinition/ConceptMap</a>\n          </td>\n          <td>y</td>\n          <td>y</td>\n          <td/>\n          <td/>\n        </tr>\n      </table>\n    </div>"
  ];
  fhir:CapabilityStatement.url [ fhir:value "http://hl7.org/fhir/CapabilityStatement/terminology-server"];
  fhir:CapabilityStatement.version [ fhir:value "5.0.0-ballot"];
  fhir:CapabilityStatement.name [ fhir:value "ACMETerminologyService—CapabilityStatement"];
  fhir:CapabilityStatement.title [ fhir:value "ACME Terminology Service — Capability Statement"];
  fhir:CapabilityStatement.status [ fhir:value "draft"];
  fhir:CapabilityStatement.date [ fhir:value "2022-09-01"^^xsd:date];
  fhir:CapabilityStatement.description [ fhir:value "Example 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 "instance"];
  fhir:CapabilityStatement.implementation [
     fhir:CapabilityStatement.implementation.description [ fhir:value "The ACME FHIR Terminology Server" ]
  ];
  fhir:CapabilityStatement.fhirVersion [ fhir:value "5.0.0-ballot"];
  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.resource [
       fhir:index 0;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "CodeSystem" ];
       fhir:CapabilityStatement.rest.resource.profile [
         fhir:value "http://hl7.org/fhir/StructureDefinition/CodeSystem";
         fhir:link <http://hl7.org/fhir/StructureDefinition/CodeSystem>
       ];
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ];
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index 0;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "url" ];
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/SearchParameter/CodeSystem-url";
           fhir:link <http://hl7.org/fhir/SearchParameter/CodeSystem-url>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "uri" ]
       ], [
         fhir:index 1;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "version" ];
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/SearchParameter/CodeSystem-version";
           fhir:link <http://hl7.org/fhir/SearchParameter/CodeSystem-version>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ]
       ], [
         fhir:index 2;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "name" ];
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/SearchParameter/CodeSystem-name";
           fhir:link <http://hl7.org/fhir/SearchParameter/CodeSystem-name>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ]
       ], [
         fhir:index 3;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "title" ];
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/SearchParameter/CodeSystem-title";
           fhir:link <http://hl7.org/fhir/SearchParameter/CodeSystem-title>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ]
       ], [
         fhir:index 4;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "status" ];
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/SearchParameter/CodeSystem-status";
           fhir:link <http://hl7.org/fhir/SearchParameter/CodeSystem-status>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ]
       ];
       fhir:CapabilityStatement.rest.resource.operation [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.operation.name [ fhir:value "expand" ];
         fhir:CapabilityStatement.rest.resource.operation.definition [
           fhir:value "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup";
           fhir:link <http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup>
         ]
       ], [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.operation.name [ fhir:value "expand" ];
         fhir:CapabilityStatement.rest.resource.operation.definition [
           fhir:value "http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code";
           fhir:link <http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code>
         ]
       ], [
         fhir:index 2;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.operation.name [ fhir:value "expand" ];
         fhir:CapabilityStatement.rest.resource.operation.definition [
           fhir:value "http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes";
           fhir:link <http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes>
         ]
       ]
     ], [
       fhir:index 1;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "ValueSet" ];
       fhir:CapabilityStatement.rest.resource.profile [
         fhir:value "http://hl7.org/fhir/StructureDefinition/ValueSet";
         fhir:link <http://hl7.org/fhir/StructureDefinition/ValueSet>
       ];
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ];
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index 0;
         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:link <http://hl7.org/fhir/SearchParameter/ValueSet-url>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "uri" ]
       ], [
         fhir:index 1;
         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:link <http://hl7.org/fhir/SearchParameter/ValueSet-version>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ]
       ], [
         fhir:index 2;
         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:link <http://hl7.org/fhir/SearchParameter/ValueSet-name>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ]
       ], [
         fhir:index 3;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "title" ];
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/SearchParameter/ValueSet-title";
           fhir:link <http://hl7.org/fhir/SearchParameter/ValueSet-title>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ]
       ], [
         fhir:index 4;
         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:link <http://hl7.org/fhir/SearchParameter/ValueSet-status>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ]
       ];
       fhir:CapabilityStatement.rest.resource.operation [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.operation.name [ fhir:value "expand" ];
         fhir:CapabilityStatement.rest.resource.operation.definition [
           fhir:value "http://hl7.org/fhir/OperationDefinition/ValueSet-expand";
           fhir:link <http://hl7.org/fhir/OperationDefinition/ValueSet-expand>
         ]
       ], [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.operation.name [ fhir:value "expand" ];
         fhir:CapabilityStatement.rest.resource.operation.definition [
           fhir:value "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code";
           fhir:link <http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code>
         ]
       ]
     ], [
       fhir:index 2;
       fhir:CapabilityStatement.rest.resource.type [ fhir:value "ConceptMap" ];
       fhir:CapabilityStatement.rest.resource.profile [
         fhir:value "http://hl7.org/fhir/StructureDefinition/ConceptMap";
         fhir:link <http://hl7.org/fhir/StructureDefinition/ConceptMap>
       ];
       fhir:CapabilityStatement.rest.resource.interaction [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ]
       ], [
         fhir:index 1;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ]
       ];
       fhir:CapabilityStatement.rest.resource.searchParam [
         fhir:index 0;
         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:link <http://hl7.org/fhir/SearchParameter/ConceptMap-url>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "uri" ]
       ], [
         fhir:index 1;
         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:link <http://hl7.org/fhir/SearchParameter/ConceptMap-version>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ]
       ], [
         fhir:index 2;
         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:link <http://hl7.org/fhir/SearchParameter/ConceptMap-name>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ]
       ], [
         fhir:index 3;
         fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "title" ];
         fhir:CapabilityStatement.rest.resource.searchParam.definition [
           fhir:value "http://hl7.org/fhir/SearchParameter/ConceptMap-title";
           fhir:link <http://hl7.org/fhir/SearchParameter/ConceptMap-title>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ]
       ], [
         fhir:index 4;
         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:link <http://hl7.org/fhir/SearchParameter/ConceptMap-status>
         ];
         fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ]
       ];
       fhir:CapabilityStatement.rest.resource.operation [
         fhir:index 0;
         fhir:Element.extension [
           fhir:index 0;
           fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation" ];
           fhir:Extension.valueCode [ fhir:value "SHALL" ]
         ];
         fhir:CapabilityStatement.rest.resource.operation.name [ fhir:value "expand" ];
         fhir:CapabilityStatement.rest.resource.operation.definition [
           fhir:value "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate";
           fhir:link <http://hl7.org/fhir/OperationDefinition/ConceptMap-translate>
         ]
       ]
     ]
  ]] .

# - ontology header ------------------------------------------------------------

[a owl:Ontology;
  owl:imports fhir:fhir.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.