FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

4.12 Resource TerminologyCapabilities - Content

Terminology Infrastructure icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: No defined compartments

A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

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

4.12.2 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

4.12.3 References to this Resource

No references for this Resource.

4.12.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. TerminologyCapabilities TU DomainResource A statement of system capabilities
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: A Terminology Capability statement SHALL have at least one of description, software, or implementation element
+ Rule: If kind = instance, implementation must be present and software may be present
+ Rule: If kind = capability, implementation must be absent, software must be present
+ Rule: If kind = requirements, implementation and software must be absent
+ Rule: Each instance of the codeSystem element must represent a distinct code system.

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC 0..1 uri Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the terminology capabilities

... version Σ 0..1 string Business version of the terminology capabilities
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this terminology capabilities (computer friendly)
... title ΣT 0..1 string Name for this terminology capabilities (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing only - never for real usage
... date Σ 1..1 dateTime Date last changed
... publisher ΣT 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... description TC 0..1 markdown Natural language description of the terminology capabilities
... useContext Σ 0..* UsageContext The context that the content is intended to support

... jurisdiction ΣXD 0..* CodeableConcept Intended jurisdiction for terminology capabilities (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T 0..1 markdown Why this terminology capabilities is defined
... copyright ΣT 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T 0..1 string Copyright holder and year(s)
... kind ΣC 1..1 code instance | capability | requirements
Binding: Capability Statement Kind (Required)
... software ΣC 0..1 BackboneElement Software that is covered by this terminology capability statement
.... name Σ 1..1 string A name the software is known by
.... version Σ 0..1 string Version covered by this statement
... implementation ΣC 0..1 BackboneElement If this describes a specific instance
.... description ΣT 1..1 markdown Describes this specific instance
.... url Σ 0..1 url Base URL for the implementation
... lockedDate Σ 0..1 boolean Whether lockedDate is supported
... codeSystem C 0..* BackboneElement A code system supported by the server
+ Rule: If there is more than one version, a version code must be defined
+ Rule: Each version.code element must be distinct for a particular code system.
+ Rule: A codeSystem element instance may have at most one version.isDefault element with a value of 'true'.

.... uri C 0..1 canonical(CodeSystem) Canonical identifier for the code system, represented as a URI
.... version C 0..* BackboneElement Version of Code System supported

..... code ΣC 0..1 string Version identifier for this version
..... isDefault ΣC 0..1 boolean If this is the default version for this code system
..... compositional 0..1 boolean If compositional grammar is supported
..... language 0..* code Language Displays supported
Binding: All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set


..... filter 0..* BackboneElement Filter Properties supported

...... code 1..1 code Code of the property supported
...... op 1..* code Operations supported for the property

..... property 0..* code Properties supported for $lookup

.... content Σ 1..1 code not-present | example | fragment | complete | supplement
Binding: Code System Content Mode (Required)
.... subsumption 0..1 boolean Whether subsumption is supported
... supplements 0..1 BackboneElement Supplement Support Information
.... globals 0..1 code not-supported | explicit | implicit
Binding: Global LangPack Support VS (Required)
... expansion 0..1 BackboneElement Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
.... hierarchical 0..1 boolean Whether the server can return nested value sets
.... paging 0..1 boolean Whether the server supports paging on expansion
.... incomplete 0..1 boolean Allow request for incomplete expansions?
.... parameter 0..* BackboneElement Supported expansion parameter

..... name 1..1 code Name of the supported expansion parameter
..... documentation 0..1 markdown Description of support for parameter
.... textFilter 0..1 markdown Documentation about text searching works
... codeSearch 0..1 code in-compose | in-expansion | in-compose-or-expansion
Binding: Code Search Support (Required)
... validateCode 0..1 BackboneElement Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
.... translations 1..1 boolean Whether translations are validated
... translation 0..1 BackboneElement Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
.... needsMap 1..1 boolean Whether the client must identify the map
... closure 0..1 BackboneElement Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
.... translation 0..1 boolean If cross-system closure is supported

doco Documentation for this format icon

See the Extensions for this resource

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

4.12.4.1 Terminology Bindings

Path ValueSet Type Documentation
TerminologyCapabilities.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.
TerminologyCapabilities.status PublicationStatus Required

The lifecycle status of an artifact.
TerminologyCapabilities.jurisdiction JurisdictionValueSet Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
TerminologyCapabilities.kind CapabilityStatementKind Required

How a capability statement is intended to be used.
TerminologyCapabilities.codeSystem.version.language AllLanguages (a valid code from Tags for the Identification of Languages icon) Required

This value set includes all possible codes from BCP-47 (see http://tools.ietf.org/html/bcp47)
  Common Languages starter
TerminologyCapabilities.codeSystem.content CodeSystemContentMode Required

The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
TerminologyCapabilities.supplements.globals GlobalLangPackSupportVS Required

How a server supports global language packs
TerminologyCapabilities.codeSearch CodeSearchSupport Required

The degree to which the server supports the code search parameter on ValueSet, if it is supported.

4.12.4.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img cnl-1Warning TerminologyCapabilities.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
img tcp-1Rule TerminologyCapabilities.codeSystemIf there is more than one version, a version code must be definedversion.count() > 1 implies version.all(code.exists())
img tcp-2Rule (base)A Terminology Capability statement SHALL have at least one of description, software, or implementation element(description.count() + software.count() + implementation.count()) > 0
img tcp-3Rule (base)If kind = instance, implementation must be present and software may be present(kind != 'instance') or implementation.exists()
img tcp-4Rule (base)If kind = capability, implementation must be absent, software must be present(kind != 'capability') or (implementation.exists().not() and software.exists())
img tcp-5Rule (base)If kind = requirements, implementation and software must be absent(kind!='requirements') or (implementation.exists().not() and software.exists().not())
img tcp-6Rule (base)Each instance of the codeSystem element must represent a distinct code system.codeSystem.uri.isDistinct()
img tcp-7Rule TerminologyCapabilities.codeSystemEach version.code element must be distinct for a particular code system.version.code.isDistinct()
img tcp-8Rule TerminologyCapabilities.codeSystemA codeSystem element instance may have at most one version.isDefault element with a value of 'true'.version.where(isDefault = true).count() <= 1

4.12.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
context token A use context assigned to the terminology capabilities (TerminologyCapabilities.useContext.value.ofType(CodeableConcept)) 30 Resources
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)) 30 Resources
context-type token A type of use context assigned to the terminology capabilities TerminologyCapabilities.useContext.code 30 Resources
context-type-quantity composite A use context type and quantity- or range-based value assigned to the terminology capabilities On TerminologyCapabilities.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)		 30 Resources
context-type-value composite A use context type and value assigned to the terminology capabilities On TerminologyCapabilities.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)		 30 Resources
date date The terminology capabilities publication date TerminologyCapabilities.date 31 Resources
description string The description of the terminology capabilities TerminologyCapabilities.description 29 Resources
identifier token External identifier for the terminology capabilities TerminologyCapabilities.identifier 35 Resources
jurisdiction token Intended jurisdiction for the terminology capabilities TerminologyCapabilities.jurisdiction 27 Resources
name string Computationally friendly name of the terminology capabilities TerminologyCapabilities.name 28 Resources
publisher string Name of the publisher of the terminology capabilities TerminologyCapabilities.publisher 31 Resources
status token The current status of the terminology capabilities TerminologyCapabilities.status 35 Resources
title string The human-friendly name of the terminology capabilities TerminologyCapabilities.title 28 Resources
url uri The uri that identifies the terminology capabilities TerminologyCapabilities.url 34 Resources
version token The business version of the terminology capabilities TerminologyCapabilities.version 32 Resources