FHIR Tooling Extensions IG
1.1.2 - Release 1.1 International bandera

FHIR Tooling Extensions IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/fhir-tools-ig/ and changes regularly. See the Directory of published versions

OperationDefinition: Terminology Cache Control

URL oficial: http://hl7.org/fhir/tools/OperationDefinition/cache-control Versión: 1.1.2
Standards status: Informative Nivel de madurez: 1 Nombre computable: CacheControl
Otros identificadores: OID:2.16.840.1.113883.4.642.40.1.33.1

Manage a terminology client cache on the server. A client that repeatedly validates or expands against the same value sets and code systems can register those resources with the server once, under a server-issued cache-id, and then refer to them by url on subsequent calls instead of re-sending them each time.

The protocol is explicit: the client calls this operation with mode=start to create a cache; the server allocates the cache and returns its identifier in the cache-id output parameter. The client then sends that identifier as the X-Cache-Id HTTP header on subsequent $validate-code and $expand requests. Resources are populated into the cache by sending them (as tx-resource, or as the primary valueSet/codeSystem) on those requests, or by front-loading them in the mode=start call. When finished, the client calls mode=end to release the cache (the server will otherwise time it out).

Because the server owns the cache-id, it can authoritatively report when a client refers to a cache it does not have (never created, expired, or released): such requests fail with an OperationOutcome whose issue carries the code cache-id-unknown from http://hl7.org/fhir/tools/CodeSystem/tx-issue-type. This is distinct from a value set or code system genuinely not being found, so a client can tell a stale cache from an authoring error.

This operation affects server state and SHOULD be invoked with POST; servers MAY also accept GET for convenience.

Language: es

URL: [base]/$cache-control

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INmode1..1code

What to do: 'start' creates a new cache and returns its id; 'end' releases the cache identified by the X-Cache-Id header; 'check' (where supported) reports whether the cache identified by the X-Cache-Id header is still valid, and may return statistics about it.

INtx-resource0..*Resource

Optional resources (CodeSystem, ValueSet, ConceptMap) to front-load into the cache when mode=start, so they are immediately in scope for subsequent calls that carry the cache-id. Resources may also be added incrementally on later $validate-code / $expand calls.

OUTcache-id0..1id

The server-issued cache identifier, returned by mode=start. The client sends this value as the X-Cache-Id HTTP header on subsequent requests that should use the cache. Absent if no cache was created.