HealthRecordCommunity
FHIR🌏 International整理済

FUMEサーバーAPIの利用ガイド:エンドポイント選択と契約理解

Server API - FUME - FHIR Converter

2026年5月28日

サマリー

本記事は、FHIRコンバーターであるFUMEのサーバーAPIについて解説している。開発者は、ワークフローや目的(例:アドホックな式評価、マッピング実行)に応じて適切なAPIのエンドポイントを選択する必要があることがわかる。また、ガイドページとOpenAPI契約の違いも理解できる。

詳細

本ドキュメントは、FUMEサーバーAPIの利用方法を包括的に解説している。開発者は、単発の式評価(`POST /`)、安定IDによるマッピング実行(`POST /Mapping/{mappingId}`)、または保存されたマッピング周りのルーティング動作確認など、目的別に適切なエントリーポイントを選ぶ必要がある。さらに、サーバーの状態確認やキャッシュ管理といった運用ワークフローのためのエンドポイントも提供されている。 APIの利用においては、「ガイドページ」と「OpenAPI契約」という二層構造が重要となる。ガイドページはセマンティクス(いつアドホックな式を送るかなど)に焦点を当て、開発者がどのエンドポイントを使うべきかを判断するのに役立つ一方、OpenAPIページはペイロードの形状、パラメータ、ステータスコードといった正確な技術契約を提供する。 Enterprise版では、共有実行モデルに加え、書き込み側のマッピング管理やテンプレートエンドポイントが追加されており、より高度なワークフローに対応している。開発者は自身のユースケースに応じて、これらの表面(Surface)を理解し、適切なAPIを利用することが求められる。

📰
原文を読む
fume.health
→

Original content copyright by respective publishers