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 by using the capabilities API:

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 for this.
• The CodeSystem resource documents the inherent structure and capabilities of code system, whereas the TerminologyCapabilities resource documents what a server hosting the code system is capable of

StructureDefinition

Elements (Simplified)

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

Mappings

• TerminologyCapabilities Mappings — 13 mapping entries

Resource Packs

list-TerminologyCapabilities-packs.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 — token — A use context assigned to the terminology capabilities — (TerminologyCapabilities.useContext.value.ofType(CodeableConcept))
• 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 — token — A type of use context assigned to the terminology capabilities — TerminologyCapabilities.useContext.code
• context-type-quantity — composite — A use context type and quantity- or range-based value assigned to the terminology capabilities — TerminologyCapabilities.useContext
• context-type-value — composite — A use context type and value assigned to the terminology capabilities — TerminologyCapabilities.useContext
• date — date — The terminology capabilities publication date — TerminologyCapabilities.date
• description — string — The description of the terminology capabilities — TerminologyCapabilities.description
• identifier — token — External identifier for the terminology capabilities — TerminologyCapabilities.identifier
• jurisdiction — token — Jurisdiction of the authority that maintains the the terminology capabilities — TerminologyCapabilities.jurisdiction
• name — string — Computationally friendly name of the terminology capabilities — TerminologyCapabilities.name
• publisher — string — Name of the publisher of the terminology capabilities — TerminologyCapabilities.publisher
• status — token — The current status of the terminology capabilities — TerminologyCapabilities.status
• title — string — The human-friendly name of the terminology capabilities — TerminologyCapabilities.title
• url — uri — The uri that identifies the terminology capabilities — TerminologyCapabilities.url
• version — token — The business version of the terminology capabilities — TerminologyCapabilities.version
• experimental — token — Whether the TerminologyCapabilities is experimental — TerminologyCapabilities.experimental

Full Search Parameters

Examples

• example — terminologycapabilities-example — General Terminology Capability Example
• example-terminology-server — terminologycapabilities-terminology-server — Terminology Server Base TerminologyCapabilities
• terminologycapabilities-example — terminologycapabilities-example
• terminologycapabilities-examples-header — terminologycapabilities-examples-header

Full 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