---
type: "resource"
title: "TerminologyCapabilities"
resource: "TerminologyCapabilities"
---
# TerminologyCapabilities


## Introduction


## Scope and Usage

The TerminologyCapabilities resource provides for a terminology server to describe how the underlying terminology service works.

A client can get the TerminologyCapabilities statement for a [Terminology Service](terminology-service) by using the [capabilities API](http#capabilities):

 GET \[base\]/metadata?mode=terminology

This will return the TerminologyCapabilities resource that applies to the service itself.

## Boundaries and Relationships

-   The TerminologyCapabilities resource does not describe the API - see [CapabilityStatement](capabilitystatement) for this.
-   The CodeSystem resource documents the inherent structure and capabilities of code system, whereas the [TerminologyCapabilities](terminologycapabilities) resource documents what a server hosting the code system is capable of

## StructureDefinition

### Elements (Simplified)

- **[TerminologyCapabilities](/terminologycapabilities-definitions#TerminologyCapabilities)** [0..*]: - A statement of system capabilities
- **[TerminologyCapabilities.url](/terminologycapabilities-definitions#TerminologyCapabilities.url)** [0..1]: [uri](/uri) Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
- **[TerminologyCapabilities.identifier](/terminologycapabilities-definitions#TerminologyCapabilities.identifier)** [0..*]: [Identifier](/Identifier) Additional identifier for the terminology capabilities
- **[TerminologyCapabilities.version](/terminologycapabilities-definitions#TerminologyCapabilities.version)** [0..1]: [string](/string) Business version of the terminology capabilities
- **[TerminologyCapabilities.versionAlgorithm[x]](/terminologycapabilities-definitions#TerminologyCapabilities.versionAlgorithm%5Bx%5D)** [0..1]: [string](/string), [Coding](/Coding) extensible:[version-algorithm](/valueset-version-algorithm) How to compare versions
- **[TerminologyCapabilities.name](/terminologycapabilities-definitions#TerminologyCapabilities.name)** [0..1]: [string](/string) Name for this terminology capabilities (computer friendly)
- **[TerminologyCapabilities.title](/terminologycapabilities-definitions#TerminologyCapabilities.title)** [0..1]: [string](/string) Name for this terminology capabilities (human friendly)
- **[TerminologyCapabilities.status](/terminologycapabilities-definitions#TerminologyCapabilities.status)** [1..1]: [code](/code) required:[publication-status](/valueset-publication-status) draft | active | retired | unknown
- **[TerminologyCapabilities.experimental](/terminologycapabilities-definitions#TerminologyCapabilities.experimental)** [0..1]: [boolean](/boolean) For testing only - never for real usage
- **[TerminologyCapabilities.date](/terminologycapabilities-definitions#TerminologyCapabilities.date)** [1..1]: [dateTime](/dateTime) Date last changed
- **[TerminologyCapabilities.publisher](/terminologycapabilities-definitions#TerminologyCapabilities.publisher)** [0..1]: [string](/string) Name of the publisher/steward (organization or individual)
- **[TerminologyCapabilities.contact](/terminologycapabilities-definitions#TerminologyCapabilities.contact)** [0..*]: [ContactDetail](/ContactDetail) Contact details for the publisher
- **[TerminologyCapabilities.description](/terminologycapabilities-definitions#TerminologyCapabilities.description)** [0..1]: [markdown](/markdown) Natural language description of the terminology capabilities
- **[TerminologyCapabilities.useContext](/terminologycapabilities-definitions#TerminologyCapabilities.useContext)** [0..*]: [UsageContext](/UsageContext) The context that the content is intended to support
- **[TerminologyCapabilities.jurisdiction](/terminologycapabilities-definitions#TerminologyCapabilities.jurisdiction)** [0..*]: [CodeableConcept](/CodeableConcept) extensible:[jurisdiction](/valueset-jurisdiction) Jurisdiction of the authority that maintains the terminology capabilities (if applicable)
- **[TerminologyCapabilities.purpose](/terminologycapabilities-definitions#TerminologyCapabilities.purpose)** [0..1]: [markdown](/markdown) Why this terminology capabilities is defined
- **[TerminologyCapabilities.copyright](/terminologycapabilities-definitions#TerminologyCapabilities.copyright)** [0..1]: [markdown](/markdown) Notice about intellectual property ownership, can include restrictions on use
- **[TerminologyCapabilities.copyrightLabel](/terminologycapabilities-definitions#TerminologyCapabilities.copyrightLabel)** [0..1]: [string](/string) Copyright holder and year(s)
- **[TerminologyCapabilities.kind](/terminologycapabilities-definitions#TerminologyCapabilities.kind)** [1..1]: [code](/code) required:[capability-statement-kind](/valueset-capability-statement-kind) instance | capability | requirements
- **[TerminologyCapabilities.software](/terminologycapabilities-definitions#TerminologyCapabilities.software)** [0..1]: [BackboneElement](/BackboneElement) Software that is covered by this terminology capability statement
- **[TerminologyCapabilities.software.name](/terminologycapabilities-definitions#TerminologyCapabilities.software.name)** [1..1]: [string](/string) A name the software is known by
- **[TerminologyCapabilities.software.version](/terminologycapabilities-definitions#TerminologyCapabilities.software.version)** [0..1]: [string](/string) Version covered by this statement
- **[TerminologyCapabilities.implementation](/terminologycapabilities-definitions#TerminologyCapabilities.implementation)** [0..1]: [BackboneElement](/BackboneElement) If this describes a specific instance
- **[TerminologyCapabilities.implementation.description](/terminologycapabilities-definitions#TerminologyCapabilities.implementation.description)** [1..1]: [markdown](/markdown) Describes this specific instance
- **[TerminologyCapabilities.implementation.url](/terminologycapabilities-definitions#TerminologyCapabilities.implementation.url)** [0..1]: [url](/url) Base URL for the implementation
- **[TerminologyCapabilities.lockedDate](/terminologycapabilities-definitions#TerminologyCapabilities.lockedDate)** [0..1]: [boolean](/boolean) Whether lockedDate is supported
- **[TerminologyCapabilities.codeSystem](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem)** [0..*]: [BackboneElement](/BackboneElement) A code system supported by the server
- **[TerminologyCapabilities.codeSystem.uri](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.uri)** [0..1]: [canonical](/canonical) Canonical identifier for the code system, represented as a URI (no version portion)
- **[TerminologyCapabilities.codeSystem.supplement](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.supplement)** [0..*]: [canonical](/canonical) Canonical identifier for a supported supplement to this code system (including supplement version)
- **[TerminologyCapabilities.codeSystem.version](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.version)** [0..*]: [BackboneElement](/BackboneElement) Version of Code System supported
- **[TerminologyCapabilities.codeSystem.version.code](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.version.code)** [0..1]: [string](/string) Version identifier for this version
- **[TerminologyCapabilities.codeSystem.version.isDefault](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.version.isDefault)** [0..1]: [boolean](/boolean) If this is the default version for this code system
- **[TerminologyCapabilities.codeSystem.version.supplement](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.version.supplement)** [0..*]: [canonical](/canonical) Canonical identifier for a supported supplement to this code system version (including supplement version)
- **[TerminologyCapabilities.codeSystem.version.compositional](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.version.compositional)** [0..1]: [boolean](/boolean) If compositional grammar is supported
- **[TerminologyCapabilities.codeSystem.version.language](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.version.language)** [0..*]: [code](/code) required:[all-languages](/valueset-all-languages) Language Displays supported
- **[TerminologyCapabilities.codeSystem.version.filter](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.version.filter)** [0..*]: [BackboneElement](/BackboneElement) Filter Properties supported
- **[TerminologyCapabilities.codeSystem.version.filter.code](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.version.filter.code)** [1..1]: [code](/code) Code of the property supported
- **[TerminologyCapabilities.codeSystem.version.filter.op](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.version.filter.op)** [1..*]: [code](/code) Operations supported for the property
- **[TerminologyCapabilities.codeSystem.version.property](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.version.property)** [0..*]: [code](/code) Properties supported for $lookup
- **[TerminologyCapabilities.codeSystem.content](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.content)** [1..1]: [code](/code) required:[codesystem-content-mode|6.0.0](/valueset-codesystem-content-mode|6.0.0) not-present | example | fragment | complete | supplement
- **[TerminologyCapabilities.codeSystem.subsumption](/terminologycapabilities-definitions#TerminologyCapabilities.codeSystem.subsumption)** [0..1]: [boolean](/boolean) Whether subsumption is supported
- **[TerminologyCapabilities.supplements](/terminologycapabilities-definitions#TerminologyCapabilities.supplements)** [0..1]: [BackboneElement](/BackboneElement) Supplement Support Information
- **[TerminologyCapabilities.supplements.globals](/terminologycapabilities-definitions#TerminologyCapabilities.supplements.globals)** [0..1]: [code](/code) required:[global-langpack-support](/valueset-global-langpack-support) not-supported | explicit | implicit
- **[TerminologyCapabilities.expansion](/terminologycapabilities-definitions#TerminologyCapabilities.expansion)** [0..1]: [BackboneElement](/BackboneElement) Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
- **[TerminologyCapabilities.expansion.hierarchical](/terminologycapabilities-definitions#TerminologyCapabilities.expansion.hierarchical)** [0..1]: [boolean](/boolean) Whether the server can return nested value sets
- **[TerminologyCapabilities.expansion.paging](/terminologycapabilities-definitions#TerminologyCapabilities.expansion.paging)** [0..1]: [boolean](/boolean) Whether the server supports paging on expansion
- **[TerminologyCapabilities.expansion.incomplete](/terminologycapabilities-definitions#TerminologyCapabilities.expansion.incomplete)** [0..1]: [boolean](/boolean) Allow request for incomplete expansions?
- **[TerminologyCapabilities.expansion.parameter](/terminologycapabilities-definitions#TerminologyCapabilities.expansion.parameter)** [0..*]: [BackboneElement](/BackboneElement) Supported expansion parameter
- **[TerminologyCapabilities.expansion.parameter.name](/terminologycapabilities-definitions#TerminologyCapabilities.expansion.parameter.name)** [1..1]: [code](/code) Name of the supported expansion parameter
- **[TerminologyCapabilities.expansion.parameter.documentation](/terminologycapabilities-definitions#TerminologyCapabilities.expansion.parameter.documentation)** [0..1]: [markdown](/markdown) Description of support for parameter
- **[TerminologyCapabilities.expansion.textFilter](/terminologycapabilities-definitions#TerminologyCapabilities.expansion.textFilter)** [0..1]: [markdown](/markdown) Documentation about text searching works
- **[TerminologyCapabilities.codeSearch](/terminologycapabilities-definitions#TerminologyCapabilities.codeSearch)** [0..1]: [code](/code) required:[code-search-support](/valueset-code-search-support) in-compose | in-expansion | in-compose-or-expansion
- **[TerminologyCapabilities.validateCode](/terminologycapabilities-definitions#TerminologyCapabilities.validateCode)** [0..1]: [BackboneElement](/BackboneElement) Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
- **[TerminologyCapabilities.validateCode.translations](/terminologycapabilities-definitions#TerminologyCapabilities.validateCode.translations)** [1..1]: [boolean](/boolean) Whether translations are validated
- **[TerminologyCapabilities.translation](/terminologycapabilities-definitions#TerminologyCapabilities.translation)** [0..1]: [BackboneElement](/BackboneElement) Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
- **[TerminologyCapabilities.translation.needsMap](/terminologycapabilities-definitions#TerminologyCapabilities.translation.needsMap)** [1..1]: [boolean](/boolean) Whether the client must identify the map

## Mappings

- [TerminologyCapabilities Mappings](/terminologycapabilities-mappings) — 13 mapping entries

## Resource Packs


### list-TerminologyCapabilities-packs.xml



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

<List xmlns="http://hl7.org/fhir" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hl7.org/fhir ../../publish/List.xsd">
  <id value="TerminologyCapabilities-packs"/>
  <status value="current"/>
  <mode value="working"/>
</List>
```


## Search Parameters

- [context](/terminologycapabilities-search#context) — **token** — A use context assigned to the terminology capabilities — `(TerminologyCapabilities.useContext.value.ofType(CodeableConcept))`
- [context-quantity](/terminologycapabilities-search#context-quantity) — **quantity** — A quantity- or range-valued use context assigned to the terminology capabilities — `(TerminologyCapabilities.useContext.value.ofType(Quantity)) | (TerminologyCapabilities.useContext.value.ofType(Range))`
- [context-type](/terminologycapabilities-search#context-type) — **token** — A type of use context assigned to the terminology capabilities — `TerminologyCapabilities.useContext.code`
- [context-type-quantity](/terminologycapabilities-search#context-type-quantity) — **composite** — A use context type and quantity- or range-based value assigned to the terminology capabilities — `TerminologyCapabilities.useContext`
- [context-type-value](/terminologycapabilities-search#context-type-value) — **composite** — A use context type and value assigned to the terminology capabilities — `TerminologyCapabilities.useContext`
- [date](/terminologycapabilities-search#date) — **date** — The terminology capabilities publication date — `TerminologyCapabilities.date`
- [description](/terminologycapabilities-search#description) — **string** — The description of the terminology capabilities — `TerminologyCapabilities.description`
- [identifier](/terminologycapabilities-search#identifier) — **token** — External identifier for the terminology capabilities — `TerminologyCapabilities.identifier`
- [jurisdiction](/terminologycapabilities-search#jurisdiction) — **token** — Jurisdiction of the authority that maintains the the terminology capabilities — `TerminologyCapabilities.jurisdiction`
- [name](/terminologycapabilities-search#name) — **string** — Computationally friendly name of the terminology capabilities — `TerminologyCapabilities.name`
- [publisher](/terminologycapabilities-search#publisher) — **string** — Name of the publisher of the terminology capabilities — `TerminologyCapabilities.publisher`
- [status](/terminologycapabilities-search#status) — **token** — The current status of the terminology capabilities — `TerminologyCapabilities.status`
- [title](/terminologycapabilities-search#title) — **string** — The human-friendly name of the terminology capabilities — `TerminologyCapabilities.title`
- [url](/terminologycapabilities-search#url) — **uri** — The uri that identifies the terminology capabilities — `TerminologyCapabilities.url`
- [version](/terminologycapabilities-search#version) — **token** — The business version of the terminology capabilities — `TerminologyCapabilities.version`
- [experimental](/terminologycapabilities-search#experimental) — **token** — Whether the TerminologyCapabilities is experimental — `TerminologyCapabilities.experimental`

[Full Search Parameters](/terminologycapabilities-search)

## Examples

- [example](/terminologycapabilities-example-example) — terminologycapabilities-example — General Terminology Capability Example
- [example-terminology-server](/terminologycapabilities-example-example-terminology-server) — terminologycapabilities-terminology-server — Terminology Server Base TerminologyCapabilities
- [terminologycapabilities-example](/terminologycapabilities-example-terminologycapabilities-example) — terminologycapabilities-example
- [terminologycapabilities-examples-header](/terminologycapabilities-example-terminologycapabilities-examples-header) — terminologycapabilities-examples-header

[Full Examples](/terminologycapabilities-examples)

## Mapping Exceptions


### terminologycapabilities-fivews-mapping-exceptions.xml

### Unmapped Elements
- **FiveWs.what** — Unknown
- **FiveWs.author** — Unknown
- **FiveWs.actor** — Unknown
- **FiveWs.cause** — Unknown
- **FiveWs.where** — Unknown
- **FiveWs.context** — Unknown
- **FiveWs.init** — Unknown
- **FiveWs.source** — Unknown
- **FiveWs.who** — Unknown
- **FiveWs.grade** — Unknown
- **FiveWs.planned** — Unknown
- **FiveWs.done** — Unknown
- **FiveWs.subject** — Unknown