TerminologyCapabilities

ResourceFoundation · TerminologyTrial useMaturity 0

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

12 of 14 parameters tested

Structure

Show inherited elements (38)

Element	Card.	Type	Description
urlΣ	0..1	uri	Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
versionΣ	0..1	string	Business version of the terminology capabilities
nameΣ	0..1	string	Name for this terminology capabilities (computer friendly)
titleΣ	0..1	string	Name for this terminology capabilities (human friendly)
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
experimentalΣ	0..1	boolean	For testing purposes, not real usage
dateRequiredΣ	1..1	dateTime	Date last changed
publisherΣ	0..1	string	Name of the publisher (organization or individual)
contactΣ	0..*	ContactDetail	Contact details for the publisher
description	0..1	markdown	Natural language description of the terminology capabilities
useContextΣ	0..*	UsageContext	The context that the content is intended to support
jurisdictionΣ	0..*	CodeableConcept	Intended jurisdiction for terminology capabilities (if applicable)Binding (extensible): jurisdiction
purpose	0..1	markdown	Why this terminology capabilities is defined
copyrightΣ	0..1	markdown	Use and/or publishing restrictions
kindRequiredΣ	1..1	code	instance | capability | requirementsBinding (required): capability-statement-kind
softwareΣ	0..1	BackboneElement	Software that is covered by this terminology capability statement
nameRequiredΣ	1..1	string	A name the software is known by
versionΣ	0..1	string	Version covered by this statement
implementationΣ	0..1	BackboneElement	If this describes a specific instance
descriptionRequiredΣ	1..1	string	Describes this specific instance
urlΣ	0..1	url	Base URL for the implementation
lockedDateΣ	0..1	boolean	Whether lockedDate is supported
codeSystem	0..*	BackboneElement	A code system supported by the server
uri	0..1	canonical(CodeSystem)	URI for the Code System
version	0..*	BackboneElement	Version of Code System supported
codeΣ	0..1	string	Version identifier for this version
isDefaultΣ	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
filter	0..*	BackboneElement	Filter Properties supported
codeRequired	1..1	code	Code of the property supported
opRequired	1..*	code	Operations supported for the property
property	0..*	code	Properties supported for $lookup
subsumption	0..1	boolean	Whether subsumption is supported
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
nameRequired	1..1	code	Expansion Parameter name
documentation	0..1	string	Description of support for parameter
textFilter	0..1	markdown	Documentation about text searching works
codeSearch	0..1	code	explicit | allBinding (required): code-search-support
validateCode	0..1	BackboneElement	Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
translationsRequired	1..1	boolean	Whether translations are validated
translation	0..1	BackboneElement	Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
needsMapRequired	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

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/TerminologyCapabilities?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
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
jurisdiction	token	Intended jurisdiction for 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

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition