FUME Server API Guide: Choosing Endpoints and Understanding Contracts
Server API - FUME - FHIR Converter
Summary
This guide details the FUME server API for FHIR conversion. Developers must select appropriate API endpoints based on their workflow or goal (e.g., ad-hoc expression evaluation, mapping execution). It also clarifies the distinction between guide pages and OpenAPI contracts.
Details
This document provides a comprehensive guide to utilizing the FUME server API. Developers are advised that selecting the correct entry point is crucial, depending on the specific use case—whether it's evaluating a one-off expression (`POST /`), running a published mapping by stable ID (`POST /Mapping/{mappingId}`), or checking route-aware HTTP behavior for saved mappings. The API structure relies on two layers: guide pages and OpenAPI contracts. Guide pages focus on semantics, helping developers decide *when* to use an ad-hoc expression versus calling a saved mapping. Conversely, the OpenAPI pages provide technical precision, detailing payload shapes, parameters, and status codes (the exact contract). Furthermore, Enterprise versions extend the shared execution model by adding write-side mapping management and template endpoints, supporting advanced operational workflows. Understanding these different 'surfaces' is key for successful integration.
Original content copyright by respective publishers