# Ferrum

## Docs

- [Authentication](https://docs.ferrum.thalamiq.io/api-reference/authentication.md): How to authenticate with the FHIR API
- [Batch](https://docs.ferrum.thalamiq.io/api-reference/batch/batch.md): Execute multiple operations independently
- [Transaction](https://docs.ferrum.thalamiq.io/api-reference/batch/transaction.md): Execute multiple operations atomically
- [Content Negotiation](https://docs.ferrum.thalamiq.io/api-reference/content-negotiation.md): Request and response format handling
- [Create Resource](https://docs.ferrum.thalamiq.io/api-reference/endpoint/create.md): Create a new FHIR resource with server-assigned ID
- [Delete Resource](https://docs.ferrum.thalamiq.io/api-reference/endpoint/delete.md): Remove a FHIR resource
- [Patch Resource](https://docs.ferrum.thalamiq.io/api-reference/endpoint/patch.md): Partially update a FHIR resource using JSON Patch
- [Read Resource](https://docs.ferrum.thalamiq.io/api-reference/endpoint/read.md): Retrieve a FHIR resource by its type and ID
- [Update Resource](https://docs.ferrum.thalamiq.io/api-reference/endpoint/update.md): Replace an existing FHIR resource entirely
- [Error Handling](https://docs.ferrum.thalamiq.io/api-reference/errors.md): Understanding FHIR API error responses
- [Resource History](https://docs.ferrum.thalamiq.io/api-reference/history/resource.md): Get history of a specific resource instance
- [System History](https://docs.ferrum.thalamiq.io/api-reference/history/system.md): Get history of all resources in the system
- [Type History](https://docs.ferrum.thalamiq.io/api-reference/history/type.md): Get history of all resources of a specific type
- [Versioned Read (vread)](https://docs.ferrum.thalamiq.io/api-reference/history/versioned-read.md): Read a specific version of a resource
- [Introduction](https://docs.ferrum.thalamiq.io/api-reference/introduction.md): Overview of the Ferrum REST API
- [Capability Statement](https://docs.ferrum.thalamiq.io/api-reference/metadata/capability-statement.md): Get server capabilities and configuration
- [Instance-Level Operations](https://docs.ferrum.thalamiq.io/api-reference/operations/instance.md): Execute operations on a specific resource instance
- [System-Level Operations](https://docs.ferrum.thalamiq.io/api-reference/operations/system.md): Execute operations at the system level
- [Type-Level Operations](https://docs.ferrum.thalamiq.io/api-reference/operations/type.md): Execute operations on a resource type
- [Compartment Search](https://docs.ferrum.thalamiq.io/api-reference/search/compartment.md): Search resources within a compartment
- [System-Level Search](https://docs.ferrum.thalamiq.io/api-reference/search/system.md): Search across all resource types
- [Type-Level Search](https://docs.ferrum.thalamiq.io/api-reference/search/type.md): Search within a specific resource type
- [Configuration](https://docs.ferrum.thalamiq.io/getting-started/configuration.md): Configure Ferrum with config.yaml and environment variables.
- [FHIR Primer](https://docs.ferrum.thalamiq.io/getting-started/fhir-primer.md): A quick introduction to the FHIR standard — just enough to use Ferrum effectively.
- [Introduction](https://docs.ferrum.thalamiq.io/getting-started/index.md): A fast FHIR server built in Rust.
- [Quickstart](https://docs.ferrum.thalamiq.io/getting-started/quickstart.md): Get started with Ferrum.
- [Audit Logs](https://docs.ferrum.thalamiq.io/server/audit-logs.md): How Ferrum records, stores, and exposes FHIR AuditEvent logs.
- [Batch & Transactions](https://docs.ferrum.thalamiq.io/server/batch-and-transactions.md): Process multiple requests with batch or transaction Bundles.
- [Compartments](https://docs.ferrum.thalamiq.io/server/compartments.md): Scope queries to a compartment like Patient or Encounter.
- [CRUD](https://docs.ferrum.thalamiq.io/server/crud-operations.md): How Ferrum handles create, read, update, patch, and delete operations.
- [Indexing](https://docs.ferrum.thalamiq.io/server/indexing.md): How search indexes are built and kept up to date.
- [Operations](https://docs.ferrum.thalamiq.io/server/operations.md): FHIR operations (e.g. $validate) at system, type, or instance level.
- [Packages](https://docs.ferrum.thalamiq.io/server/packages.md): Working with FHIR packages (IGs) and conformance resources.
- [Referential Integrity](https://docs.ferrum.thalamiq.io/server/referential-integrity.md): How Ferrum validates references between FHIR resources on create, update, and delete.
- [Search](https://docs.ferrum.thalamiq.io/server/search.md): How to search resources with FHIR search parameters.
- [Versioning & History](https://docs.ferrum.thalamiq.io/server/versioning-history.md): How Ferrum handles resource versioning, history tracking, and version-aware operations.
- [Admin UI](https://docs.ferrum.thalamiq.io/ui/overview.md): Overview of the Ferrum Admin UI.

## OpenAPI Specs

- [openapi](https://docs.ferrum.thalamiq.io/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/thalamiq/ferrum)
- [FHIR Specification](https://hl7.org/fhir/)