Skip to main content

Crate ferrobridge_term

Crate ferrobridge_term 

Source
Expand description

The FerroBRIDGE FHIR terminology client for $lookup, $translate, $validate-code, $expand and $subsumes.

Five operations on one configured server: client::Client::lookup resolves a code’s display, client::Client::translate maps a code into another system, client::Client::validate_code tests membership of a value set, client::Client::expand lists the codes of a value set, and client::Client::subsumes tests how two codes relate in their code system. client::Client::code_system_count asks whether the server serves a code system at all. client::Client::batch sends several of them as one batch Bundle and answers them by position.

A negative answer an operation states in its own out parameters is an outcome (outcome); an answer the server refused is a typed error carrying the upstream status, the body, and any tx-issue-type coding the OperationOutcome holds. A missing display is LookupOutcome::NotFound, never an empty string.

The request and response contracts come from the generated fhir-types operation modules; this crate models no FHIR of its own. The release is configured (WireVersion) because a server that serves several releases side by side puts the release in the base path.

Modules§

client
The client itself: one configured terminology server, one request at a time.
concept
The values the operations answer with, in one shape for every wire version; Designation is shared with the ValueSet/$expand entries.
config
How a client is pointed at one terminology server: its versioned base URL, its wire version, its budget, and its credentials.
error
What can go wrong on the wire, as types that carry the upstream answer.
outcome
What each operation answers, as one enum per operation.

Constants§

BATCH
The batch interaction, a POST of a Bundle to the service base (https://hl7.org/fhir/R4/http.html#transaction).
CODE_SYSTEM_SEARCH
The CodeSystem search by canonical URL that asks only for the count of matches (https://hl7.org/fhir/R4/search.html#summary).
EXPAND
ValueSet/$expand (https://hl7.org/fhir/R4/valueset-operation-expand.html).
FHIR_VERSION
The HL7 FHIR release this crate targets.
LOOKUP
CodeSystem/$lookup, as the operation is invoked (https://hl7.org/fhir/R4/codesystem-operation-lookup.html).
SUBSUMES
CodeSystem/$subsumes (https://hl7.org/fhir/R4/codesystem-operation-subsumes.html).
TRANSLATE
ConceptMap/$translate (https://hl7.org/fhir/R4/conceptmap-operation-translate.html).
VALIDATE_CODE
ValueSet/$validate-code (https://hl7.org/fhir/R4/valueset-operation-validate-code.html).