Server API
The FUME server API combines a small number of endpoint patterns with two different documentation layers: guide pages for workflow decisions and OpenAPI pages for the exact contract.
Use this section to choose the right entry point before you wire an integration, debug request behavior, or open the product-specific contract.
Choose the right surface
| If you need to... | Start here | Why this is the right first stop |
|---|---|---|
| Evaluate a one-off expression against runtime input | Execution patterns | POST / lets the caller supply the FUME expression directly in the request. |
| Run a published mapping by a stable ID | Execution patterns | POST /Mapping/{mappingId} assumes the deployment owns the mapping and the caller supplies only the business input. |
| Build route-aware HTTP behavior around a saved mapping | Execution patterns | Routed mapping endpoints expose path, method, query, and sanitized headers through $fumeHttpInvocation. |
| Check server state, refresh caches, or manage saved mappings | Operations and management | These endpoints sit beside execution and support operational workflows. |
| Confirm exact fields, parameters, or response schemas | OpenAPI | The OpenAPI pages are the contract source for Community and Enterprise. |
Saved-mapping routes under /Mapping/* are available only when the deployment has at least one mapping source configured through FHIR_SERVER_BASE or MAPPINGS_FOLDER. If both sources are disabled, ad-hoc evaluation through POST / still works, but /Mapping/* returns 405.
Read the guide in order
Start with Execution patterns when the main question is which endpoint the caller should use.
Move to Operations and management when the question is about server metadata, health probing, cache refresh, or the lifecycle of saved mappings.
Use the OpenAPI when the workflow choice is already clear and you need the exact request and response contract.
Guide pages versus API contracts
The guide pages stay focused on semantics: when to send an ad-hoc expression, when to call a saved mapping, what prerequisites can disable an endpoint, and which operational surfaces exist only in Enterprise.
The OpenAPI pages stay focused on precision: payload shapes, parameters, status codes, and product-specific schema details.
Enterprise keeps the shared execution model and adds write-side mapping management plus template endpoints. The guide pages flag those extensions where they matter, and the Enterprise OpenAPI contract carries the exact write and template details.