Skip to main content

Crate fhir_terminology

Crate fhir_terminology 

Source
Expand description

The terminology engine.

Implements the FHIR terminology operations ($lookup, $validate-code, $expand, $subsumes, $translate) over the code system provider seam, dispatched per FHIR version against the generated fhir-types contracts. SNOMED CT is the first provider; every other code system reaches the operations through the same seam. No specification governs the seam itself (our own design); the FHIR CodeSystem metadata is the capability declaration a provider returns (https://hl7.org/fhir/R4B/codesystem.html).

Modules§

artifact
What an artifact directory holds, before a provider opens it.
capabilities
TerminologyCapabilities from the loaded providers’ declarations (https://hl7.org/fhir/R4B/terminologycapabilities.html, https://hl7.org/fhir/R5/terminologycapabilities.html).
classification
The classification provider: one ClaML or ICD-10-CM release read from its artifact directory (store.redb, hierarchy.bin, text.bin, and manifest.json with kind = classification).
clock
The one place the engine reads the wall clock for a FHIR dateTime.
compose
The compose layer: ValueSet.compose evaluated once, above every provider.
conceptmap
ConceptMap resources as $translate evaluates them.
fhir_codesystem
The generic provider for any code system published as a FHIR CodeSystem resource: HL7 Terminology, custom systems, and supplements.
fhir_core
The terminology the FHIR specification itself defines, per served version.
icd11
The ICD-11 provider: one of the three WHO code systems (the MMS and ICF linearizations, the Foundation) read from its artifact directory.
language
The display language of a request: a language range list resolved against the languages a code system carries.
loinc
The LOINC provider: one release read from its artifact directory (store.redb, hierarchy.bin, text.bin, and manifest.json).
normal_form
The Necessary Normal Form of a concept, rendered in SNOMED CT Compositional Grammar.
operations
The FHIR terminology operations over the seam, one module each.
position
Positions inside a refused value: a parser’s byte offset, carried back through percent-encoding and counted as the column a client reads.
provider
The code system provider seam.
registries
The registry and grammar code systems: BCP 47 language tags, BCP 13 media types, and ISO 3166-1 country codes.
registry
The loaded code system versions, by system URI, with the default-version rule.
rxnorm
The RxNorm provider: one release read from its artifact directory (store.redb, text.bin, relations.bin, atoms.bin, and manifest.json).
snomed
The SNOMED CT provider: one built edition version read from its artifact directory (store.redb, hierarchy.bin, text.bin, and manifest.json).
stored
The code systems the server reads from a built artifact, served as one provider.
supplement
Code system supplements applied to a provider’s designations and properties (CodeSystem.content = supplement, https://hl7.org/fhir/R4B/codesystem.html#supplements).
text_match
Word-prefix matching over designations without a built text index.
valueset
ValueSet resources as the compose layer evaluates them.
versioned
A store of canonical resources by url and version, with the default-version rule the value sets and concept maps share.