Blaze FHIR Server
main - ci-build

Blaze FHIR Server - Local Development build (vmain) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Compact a Database Column Family

Compacts a column family of one of the RocksDB databases of Blaze. RocksDB compacts automatically, but in certain situations a manual compaction can be useful. The response is always async according to the Asynchronous Interaction Request Pattern. The progress is also available from the underlying CompactJob Task resource.

Measure Disk Performance

Measures the performance of the disk volume of one of the database directories with an I/O profile similar to the one Blaze's RocksDB databases produce. The response is always async according to the Asynchronous Interaction Request Pattern. The results are also available as outputs of the underlying DiskPerfJob Task resource.

Resource Totals

The operation is experimental. It may change in a future version without prior deprecation. Retrieves the total number of resources by resource type. The response is a Parameters resource with one parameter per resource type with at least one resource. The name of the parameter is the resource type and its valueUnsignedInt is the number of resources of that type. Because the names of the parameters are the resource types, the parameters aren't declared individually.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

TaskInput

Reference to inputs of a task.

TaskOutput

Reference to outputs of a task.

Structures: Graph Definitions

These define collections of interrelated resources that are useful to pass around as a group.

Patient Purge

The resources the Patient $purge operation erases together with the patient. Contains one reverse link per resource type, using only the reference search parameter for the patient the resource is about.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

AsyncInteractionJob

A job executing a request of the Asynchronous Interaction Request Pattern. Its input references the request bundle and its output the response bundle.

AsyncInteractionRequestBundle

The batch bundle holding the request of an asynchronous interaction job.

AsyncInteractionResponseBundle

The batch-response bundle holding the response of an asynchronous interaction job.

CompactJob

A job compacting one column family of one of the databases of Blaze.

DiskPerfJob

A job measuring the performance of the disk volume of one of the database directories of Blaze.

Job

The base profile of all jobs Blaze executes. A job is a Task with a type, the time it was authored and, if it failed, an error.

ReIndexJob

A job (re)indexing all resources of one search parameter.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Bloom Filter Ratio

The number of Bloom filters available over the number of Bloom filters requested by the evaluation of the measure. With the CQL expression cache enabled, a Bloom filter lets the evaluation skip the patients for which an expression is certainly false. A filter that isn't available yet is calculated in the background, so a lower ratio means a slower evaluation. Without the CQL expression cache, no Bloom filters are requested, so both numbers are 0.

Disk Performance Concurrency

The number of concurrent readers of one run of the random read sweep of the disk performance benchmark.

Evaluation Duration

The duration the evaluation of the measure took, in seconds.

Grand Total

The number of entries of a history bundle that exceeds the range of Bundle.total, which is an unsignedInt and so can't hold numbers higher than 2^31-1. In that case, Bundle.total has no value and carries this extension instead, holding the number as decimal string.

Return Preference

The return preference of the Prefer header of an asynchronous request, one of minimal, representation and OperationOutcome. The request is executed later, without its HTTP headers, so the preference is kept with the request in the request bundle.

Validation Outcome

References the contained OperationOutcome produced by the external validation of a resource. The referenced resource's id is opaque and not fixed; follow this reference to locate the OperationOutcome instead of assuming a well-known id.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Column Family Value Set

All column families of the databases Blaze stores its data in.

Database Value Set

All databases Blaze stores its data in.

Disk Performance Phase Value Set

All phases of the disk performance benchmark.

Disk Performance Rating Value Set

All ratings of the overall disk performance score.

Error Category Value Set

All categories of the error a failed job reports.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

(Re)Index Job Output

Types of the outputs of a (re)index job.

(Re)Index Job Parameter

Types of the inputs of a (re)index job.

Access Control

Codes Blaze labels the resources it owns itself with, in order to protect them against changes by clients. The codes belong to Blaze alone. Clients can't create or update resources carrying them.

Async Interaction Job Output

Types of the outputs of an asynchronous interaction job.

Async Interaction Job Parameter

Types of the inputs of an asynchronous interaction job.

Column Family

The column families of the databases Blaze stores its data in.

Compact Job Output

Types of the outputs of a compact job.

Compact Job Parameter

Types of the inputs of a compact job.

Database

The databases Blaze stores its data in.

Disk Performance Job Output

Types of the outputs of a disk performance job.

Disk Performance Job Parameter

Types of the inputs of a disk performance job.

Disk Performance Phase

The phases of the disk performance benchmark.

Disk Performance Rating

The ratings of the overall disk performance score.

Error Category

The categories of the error a failed job reports.

Job Cancelled Sub Status

The sub status of a cancelled job, telling whether the cancellation was only requested or is already finished.

Job Output

Types of the outputs all jobs share.

Job Status Reason

The reasons for the status of a job.

Job Type

The types of jobs Blaze executes.

Validation Status

The status of a resource as determined by the external validation. Carried as tag in Resource.meta.tag.

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide.

JobNumberNamingSystem

The naming system of the number every job in Blaze is identified by.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

AsyncInteractionJobSearchObservationCancellationRequestedExample

An asynchronous interaction job counting Observations whose cancellation was requested.

AsyncInteractionJobSearchObservationReadyExample

An asynchronous interaction job counting Observations that is ready to be executed.

AsyncInteractionJobSearchObservationRequestBundleExample

The request bundle of an asynchronous interaction job counting Observations.

AsyncInteractionJobSearchObservationResponseBundleExample

The response bundle of an asynchronous interaction job counting Observations.

CompactJobExample

A compact job of the search param value index that is ready to be executed.

DiskPerfJobExample

A disk performance job of the index database that is ready to be executed.

JobSearchParameterBundle

The search parameters Blaze adds to Task in order to search jobs by the resources their inputs and outputs reference.

ReIndexJobFailedExample

A (re)index job that failed.

ReIndexJobInProgressExample

A (re)index job that is in progress.

ReIndexJobReadyExample

A (re)index job that is ready to be executed.