Skip to main content

A minimalistic FHIR server for resources as files

Project description

fhirsnake Image

fhirsnake: turn static files to a FHIR server

image

What is it?

fhirsnake is a minimalistic FHIR server that serve yaml and json files as FHIR resources

How it works?

The server reads all yaml and json files from resources directory. Rsources directory should have subdirectories with names equal resource types:

resources/
├── Patient/
│   ├── example.yaml
│   ├── john-doe.json
│   └── patient3.yaml
├── Questionnaire/
│   ├── questionnaire1.yaml
│   ├── questionnaire2.yaml
│   └── questionnaire3.yaml

Supported operations

[!IMPORTANT] All created and updated resources persist in runtime only. All changes are vanished after service restart

  • read, create and update operations are supported
  • search - limied support without any search params
  • GET /$index operation returns a map of all resources in format <resource_type>:<id>

How to use?

  1. Organize resources in a directory
  2. Adjust source destination in Dockerfile.resources if required
  3. Option A: Run a container
    docker run -p 8002:8000 -v ./resources:/app/resources  bedasoftware/fhirsnake
    
  4. Option B: Build an image using the base image
    docker build -t fhirsnake-resources:latest -f Dockerfile.resources .
    docker run -p 8000:8000 fhirsnake-resources 
    

Contribution and feedback

Please, use Issues

Development

Format and fix with ruff

ruff format
ruff check . --fix

Issue new version - run semantic release locally

npx semantic-release --no-ci

Publish to pypi

poetry build
poetry publish

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fhirsnake-1.1.0.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

fhirsnake-1.1.0-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file fhirsnake-1.1.0.tar.gz.

File metadata

  • Download URL: fhirsnake-1.1.0.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.3 Darwin/23.6.0

File hashes

Hashes for fhirsnake-1.1.0.tar.gz
Algorithm Hash digest
SHA256 ac5d6d4ff9e0c72cdba66fb6a3b762146c91cf4a59cb1e188b0ba6991bfe4736
MD5 145818f8fe9709db31e3c5c9614e6b1a
BLAKE2b-256 58fad75484bcf3dc6d4e2d621f3c639c845448cc09be29aaec6945abc384d435

See more details on using hashes here.

File details

Details for the file fhirsnake-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: fhirsnake-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.3 Darwin/23.6.0

File hashes

Hashes for fhirsnake-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c0f0cbb98e9f0dd4520ce161b6374a5bba91db427d6fc39f24d3c94c78d26372
MD5 e1546bfd0d1d108c5ec41e642a75b417
BLAKE2b-256 150d053e88ae28f632154a2d46bbda9702155d33d19aa586f6b7d333d4ddf786

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page