Termbox Docs

FHIR API

Termbox supports all R4, R5, and R6 normative operations on ValueSets and CodeSystems[^4]

[!NOTE] Support Legend

  • ✅ Full support - Complete implementation with all parameters
  • 🏗️ In development - Under development, expect partial support in the meantime
  • ❌ No support - In our roadmap
  • 🚫 Won't support - Not in our roadmap

Operations

OperationDescriptionSupport
CodeSystem/$lookupGiven a code/system, get additional details about the concept. See docs✅
CodeSystem/$validate-codeValidates a coded value. See docs✅
CodeSystem/$subsumesTest the subsumption relationship between A and B. See docs✅
CodeSystem/$find-matchesGiven a set of properties (and text), return one or more possible matching codes. See docs❌
ValueSet/$expandReturns an expansion of concepts according to the value set definition. See docs✅
ValueSet/$validate-codeValidate that a coded value is in the set of codes allowed by a value set. See docs✅
ConceptMap/$translateTranslate a code from one terminology to another. See docs🏗️
ConceptMap/$closureMaintenance of a client-side transitive closure table. See docs❌

Features

FeatureDescriptionSupport
Capability Statements+ TerminologyCapabilities✅
CRUD of Terminology resourcesCreate, Read, Update, Delete operations🏗️
Pre-coordinated codesStandard coded concepts✅
Post-coordinated codesComplex expressions not yet supported❌
Intensional ValueSetsFilter-based ValueSet definitions✅
Extensional ValueSetsExplicit concept enumeration✅
ValueSet expansionFull expansion with pagination✅
ValueSet validationCode membership validation✅
ValueSet inclusion/exclusionDeep set operations support✅
Lookup displays, designation, and propertiesAll concept attributes✅
Full text search filterPrefix, stemming, phrase matching✅
FTS rankingFull text search ranking based on relevance✅
Property filtersProperty-based filtering: =, in, regex, etc✅
Subsumption filteringis-a, generalizes, ancestors, etc✅
Active/Inactive filteringVia status, inactive, notSelectable, etc✅
Multi-language supportTranslations via displaylanguage, HTTP header, designation, etc✅
Hierarchy via propertiese.g.: parent, child, PAR, CHD, etc✅
Nested conceptsHierarchy via concept.concept✅
Supplemental CodeSystemsAdditional concept properties and designations🏗️
Implicit ValueSetsSystem-generated ValueSets✅
ConceptMap translationsCode mapping between terminology systems🏗️
Multiple ConceptMap matchesReturns all applicable mappings for source code🏗️
Transitive closure table$closure❌
Syntax-based code systemsUCUM, BCP-47, HGVS, etc❌
tx-resource parameterInline resource definitions✅
Ad-hoc ValueSetsValueSet as a Parameter✅
R4/R5/R6 format conversionOne server, one database, multiple FHIR versions❌
Batch validationValidation of many codes in one request🏗️

FHIR Versions

Termbox runs one endpoint for each major FHIR version[^5] and a default endpoint (currently R5, users will be able to configure this in upcoming releases)

  • Default: /fhir/
  • Version specific: /fhir/:version/

Examples:

  • R6: GET /fhir/r6/ValueSet/$expand
  • R4B: GET /fhir/r4b/metadata

Last updated: