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
| Active as of 2026-11-22 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="compact"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition compact</b></p><a name="compact"> </a><a name="hccompact"> </a><p>URL: [base]/$compact</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>database</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td><a href="ValueSet-Database.html">Database Value Set</a> (Required)</td><td><div><p>The name of the database holding the column family.</p>
</div></td></tr><tr><td>IN</td><td>column-family</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td><a href="ValueSet-ColumnFamily.html">Column Family Value Set</a> (Required)</td><td><div><p>The name of the column family to compact. Which column families exist depends on the database.</p>
</div></td></tr></table></div>
</text>
<url value="https://blaze-server.org/fhir/OperationDefinition/compact"/>
<version value="main"/>
<name value="Compact"/>
<title value="Compact a Database Column Family"/>
<status value="active"/>
<kind value="operation"/>
<date value="2026-11-22T10:48:55+00:00"/>
<publisher value="The Samply Community"/>
<contact>
<name value="The Samply Community"/>
<telecom>
<system value="url"/>
<value value="https://samply.de"/>
</telecom>
</contact>
<description
value="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."/>
<affectsState value="true"/>
<code value="compact"/>
<system value="true"/>
<type value="false"/>
<instance value="false"/>
<parameter>
<name value="database"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The name of the database holding the column family."/>
<type value="code"/>
<binding>
<strength value="required"/>
<valueSet value="https://blaze-server.org/fhir/ValueSet/Database"/>
</binding>
</parameter>
<parameter>
<name value="column-family"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The name of the column family to compact. Which column families exist depends on the database."/>
<type value="code"/>
<binding>
<strength value="required"/>
<valueSet value="https://blaze-server.org/fhir/ValueSet/ColumnFamily"/>
</binding>
</parameter>
</OperationDefinition>