Skip to main content

Terminology

Use these functions to expand ValueSets, check terminology membership, and translate codes and Codings.

Terminology assets are always resolved inside the FHIR package context and FHIR server configuration available in the environment where FUME is running, not against the global internet.

Identifier forms​

Terminology helpers accept three identifier forms for both ValueSet and ConceptMap lookup:

  • canonical URL
  • resource id
  • resource name

Canonical URL is the FHIR-preferred form and is usually the best choice when you want the most deterministic resolution. FUME also supports id and name because they are often shorter and easier to read in controlled package or server contexts.

If a helper accepts packageFilter or sourcePackage, use it when you need package-scoped deterministic resolution.

The terminology examples in this section intentionally mix URL, id, and name forms so you can see all supported lookup styles in realistic expressions.

ConceptMap resolution​

$translate(), $translateCode(), and $translateCoding() resolve ConceptMap resources this way when you pass a string identifier:

  1. If a FHIR server is configured and no packageFilter is supplied, FUME tries the server first.
  2. If server resolution does not succeed, FUME falls back to FHIR packages.
  3. If packageFilter is supplied, FUME skips server resolution and uses packages only.

Within package resolution, FUME tries canonical URL first, then resource id, then resource name.

ValueSet resolution​

$expandValueSet() and $inValueSet() resolve ValueSet resources from FHIR packages.

Within package resolution, FUME tries canonical URL first, then resource id, then resource name. sourcePackage narrows package resolution; it does not redirect ValueSet lookup to the server.

Functions

5 primary matchs in this category.

Primary matches

Start here when this is the main kind of work you need to do.