Firely Server FHIR REST API

Every Firely Server (formerly Vonk) instance exposes the standard HL7 FHIR REST API contract — type-level and instance-level CRUD, search, history, batch/transaction, capability statement (/metadata), conditional operations, and conformance-driven validation — plus pluggable modules for Terminology Services, Bulk Data Access ($export), SMART on FHIR, CDS Hooks, Subscriptions/PubSub, FHIR Mapping Language, and custom search parameters. Firely Server supports FHIR R4, R4B, R5, and STU3 across MongoDB and SQL Server backends and is G10, ONC, and ISiK certified. The API contract is the HL7 FHIR specification itself; there is no public hosted multi-tenant base URL — customers self-host Firely Server on Windows, Linux, macOS, Docker, or Kubernetes.

Firely Server FHIR REST API is one of 2 APIs that Firely publishes on the APIs.io network.

Tagged areas include FHIR, REST, Healthcare, CRUD, and Search. The published artifact set on APIs.io includes API documentation.

API entry from apis.yml

apis.yml Raw ↑
aid: firely-server:firely-server-fhir-rest-api
name: Firely Server FHIR REST API
description: Every Firely Server (formerly Vonk) instance exposes the standard HL7 FHIR REST API contract
  — type-level and instance-level CRUD, search, history, batch/transaction, capability statement (/metadata),
  conditional operations, and conformance-driven validation — plus pluggable modules for Terminology Services,
  Bulk Data Access ($export), SMART on FHIR, CDS Hooks, Subscriptions/PubSub, FHIR Mapping Language, and
  custom search parameters. Firely Server supports FHIR R4, R4B, R5, and STU3 across MongoDB and SQL Server
  backends and is G10, ONC, and ISiK certified. The API contract is the HL7 FHIR specification itself;
  there is no public hosted multi-tenant base URL — customers self-host Firely Server on Windows, Linux,
  macOS, Docker, or Kubernetes.
humanURL: https://docs.fire.ly/projects/Firely-Server/
tags:
- FHIR
- REST
- Healthcare
- CRUD
- Search
- Terminology
- Bulk Data
- SMART on FHIR
- CDS Hooks
- Subscriptions
properties:
- type: Documentation
  url: https://docs.fire.ly/projects/Firely-Server/
  name: Firely Server Documentation
- type: Standards
  url: https://hl7.org/fhir/http.html
  name: HL7 FHIR RESTful API specification
- type: Standards
  url: https://hl7.org/fhir/
  name: HL7 FHIR Specification
- type: Documentation
  url: https://hl7.org/fhir/uv/bulkdata/
  name: FHIR Bulk Data Access IG
- type: Documentation
  url: https://hl7.org/fhir/smart-app-launch/
  name: SMART App Launch
- type: Sample
  url: https://github.com/FirelyTeam/firely-pubsub-sample
  name: Firely Server PubSub sample
- type: Sample
  url: https://github.com/FirelyTeam/Vonk.Facade.Starter
  name: Vonk Facade starter project
- type: Plugin
  url: https://github.com/FirelyTeam/Vonk.Plugin.DocumentOperation
  name: Vonk $document operation plugin
- type: Plugin
  url: https://github.com/FirelyTeam/Vonk.Plugin.ExampleOperation
  name: Vonk plugin template