fhir-candle

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #golang #deep-learning #nodejs #macos #windows #awesome #kubernetes #security #mcp #open-source

(★ 22)

fhir-candle - A FHIR development and test server implemented in C#

fhir-candle 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# fhir-candle
[![Tests](https://github.com/FHIR/fhir-candle/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/FHIR/fhir-candle/actions/workflows/build-and-test.yml)
[![Publish dotnet tool](https://img.shields.io/nuget/v/fhir-candle.svg)](https://github.com/FHIR/fhir-candle/actions/workflows/nuget-tool.yml)
[![Publish Docker image to ghcr.io](https://github.com/FHIR/fhir-candle/actions/workflows/ghcr-docker.yml/badge.svg)](https://github.com/FHIR/fhir-candle/actions/workflows/ghcr-docker.yml)
[![Deploy to `argo.run`](https://github.com/FHIR/fhir-candle/actions/workflows/argo-ris.yml/badge.svg)](https://github.com/FHIR/fhir-candle/actions/workflows/argo-ris.yml)

When you need a small FHIR.

fhir-candle is a small in-memory FHIR server that can be used for testing and development. It is NOT intended to be used for production workloads.

The project is intended to serve as a platform for rapid development and testing for FHIR - both for features in the core specification as well as Implementation Guide development.

While there are many existing OSS FHIR servers, somewhere between most and all of them are intended to support production workloads.  In my own work on Reference Implementations, I often found it challenging to add the types of features I wanted due to the conflicts that causes.  To that end, here are some principles I generally use while developing this project:
* No database / persisted state
* Fast startup
* Dynamically apply changes (e.g., search parameters)
* House features that would not be appropriate in production
    * E.g., provide feedback on SMART tokens to help developers

## FHIR Foundation Project Statement
* Maintainers: Gino Canessa
* Issues / Discussion: Any issues should be submitted on [GitHub](https://github.com/FHIR/fhir-candle/issues). Discussion can be performed here on GitHub, or on the [dotnet stream on chat.fhir.org](https://chat.fhir.org/#narrow/stream/179171-dotnet).
* License: This software is offered under the [MIT License](LICENSE).
* Contribution Policy: See [Contributing](#contributing).
* Security Information: See [Security](#security).

## Contributing

There are many ways to contribute:
* [Submit bugs](https://github.com/FHIR/fhir-candle/issues) and help us verify fixes as they are checked in.
* Review the [source code changes](https://github.com/FHIR/fhir-candle/pulls).
* Engage with users and developers on the [dotnet stream on FHIR Zulip](https://chat.fhir.org/#narrow/stream/179171-dotnet)
* Contribute features or bug fixes - see [Contributing](CONTRIBUTING.MD) for details.

To ensure a welcoming environment, we follow the [HL7 Code of Conduct](https://www.hl7.org/legal/code-of-conduct.cfm) and expect contributors to do the same.

### Security

To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/FHIR/fhir-candle/security/advisories/new) tab.

For more information, please see the [Security Readme](SECURITY.MD).

# Documentation

Full documentation lives in the [`docs/`](docs/) tree:

- **Users** — running, configuring, and calling the server: [docs/user/](docs/user/)
  - [Getting started](docs/user/getting-started.md)
  - [FHIR tenants](docs/user/tenants.md)
  - [Loading initial data](docs/user/loading-data.md)
  - [Strict mode (`--strict`)](docs/user/strict-mode.md)
  - [Subscriptions reference implementation](docs/user/subscriptions-ri.md)
  - [Using OpenTelemetry](docs/user/opentelemetry.md)
  - [`$validate` operation](docs/user/operations/validate.md)
- **Contributors** — architecture and internals: [docs/technical/](docs/technical/)

The sections below are a quick-start; deeper detail lives in `docs/`.

## Get Started with .Net

[Install .NET 8 or newer](https://get.dot.net) and run this command:

```
dotnet tool install --global fhir-candle
```

Note that this software is still under heavy development.

Start a FHIR server and open the browser by running:

```
fhir-candle -o
```

## Get Started with Docker

[Install Docker](https://docs.docker.com/engine/install/) and run these commands:

```
docker pull ghcr.io/fhir/fhir-candle:latest
docker run -p 8080:5826 ghcr.io/fhir/fhir-candle:latest
```

This runs the Docker image with the default configuration, mapping port 5826 from the container to port 8080 on the host. Once running, access http://localhost:8080/ for the UI, or the default endpoints:
* http://localhost:8080/fhir/r4/ for FHIR R4
* http://localhost:8080/fhir/r4b/ for FHIR R4B
* http://localhost:8080/fhir/r5/ for FHIR R5

## Get Started by cloning this repository

```
dotnet run --project src/fhir-candle/fhir-candle.csproj
```

For arguments, build, and release-output details on all platforms, see
[Getting started](docs/user/getting-started.md).

## More configuration and features

- [FHIR tenants](docs/user/tenants.md) — choose FHIR versions/endpoints with `--r4` / `--r4b` / `--r5`.
- [Loading initial data](docs/user/loading-data.md) — seed resources with `--fhir-source`.
- [Strict mode (`--strict`)](docs/user/strict-mode.md) — strict spec-conformant REST posture for conformance testing.
- [Subscriptions reference implementation](docs/user/subscriptions-ri.md) — run the FHIR Subscriptions RI stack.
- [Using OpenTelemetry](docs/user/opentelemetry.md) — export traces via `--otel-otlp-endpoint`.
- [`$validate` operation](docs/user/operations/validate.md) — structural resource validation.

# To-Do
Note: items are unsorted within their priorities

## High priority
* Feature/module definitions for selective loading
    Build interfaces for Hosted Services, etc.
    Add module tag to Operation, etc.
    Conditional loading based on discovery within types
* Persistent 'unsubscribe' list
* Finish search evaluators (remaining modifier combinations)
* Save/restore points
* Resource display / edit in UI
* Resource editor design improvements
* Add loading packages/profiles to CapabilityStatement
* Configuration and content loading via GH repos
* SQL-on-FHIR ViewDefinition and runner support
* Additional MCP support

## Mid Priority
* Complete SMART support
* Additional Transaction support
* OpenAPI generation
* Contained resources
* Subscription websocket support
* Runtime Operation definitions with static/template or JS scripted responses.
* Minimal build (project and image) focused on size reduction
    * Use Native AOT deployment
* Add 'core' operations (e.g., `$meta-add`).
* Add support for operaions within `transaction` bundles
* CQL support

## The long tail
* Versioned Resource support
* Non-terminology validation
* Link to terminology server for full validation
* `_filter` support
* Runtime named queries
* GraphQL support

## More Information

FHIR&reg; is the registered trademark of HL7 and is used with the permission of HL7.

fhir-candle

fhir-candle 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

fhir-candle

fhir-candle 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README