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

  • read, create and update operations are supported
  • ❗all created and updated resources persist in runtime only
  • ❗all changes are vanished after service restart
  • 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.0.1.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fhirsnake-1.0.1.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.5.0

File hashes

Hashes for fhirsnake-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b017e5aba0c3f05b1a7da2d42fc8731d651925087fbe1a3587bdc3772987ce1b
MD5 7b0242df458ff6210f9eaceaacf56c4e
BLAKE2b-256 a05bef9a279555de438749c6ea4959314ee6184e32f8bfc3f89377e102b51d23

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fhirsnake-1.0.1-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.5.0

File hashes

Hashes for fhirsnake-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 60e162aab3255be5ed6b61e5a5dfdfb8c8728ea913e5682bd0c6d5821988078a
MD5 58371675d3d8049d6f690f15ddb50cd3
BLAKE2b-256 47c50d161ab940d816ae59205288fc2e75af77f9b67947bce3d7984f5001d2cd

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