Skip to main content

A minimalistic FHIR server for resources as files

Project description

Example 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. Build an image using the base fhirsnake image
    docker build -t fhirsnake-resources:latest -f Dockerfile.resources .
    
  4. Run a container
    docker run -p 8000:8000 fhirsnake-resources 
    

Contribution and feedback

Plaease, 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

poetry build

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.0.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

fhirsnake-1.0.0-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fhirsnake-1.0.0.tar.gz
  • Upload date:
  • Size: 3.2 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.0.tar.gz
Algorithm Hash digest
SHA256 f72a303a47fd324450e8ad8b95f4da769262e9137382d501e502765640025909
MD5 a7065d8a3e16db12b22de2de1a1b30e6
BLAKE2b-256 871bd39747217de643af7798d8f9191e7345be769c892f802aecf5ca0dd18400

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fhirsnake-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.8 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 50912a4a32f5992d8483b882d5630cb3de4bc6c1888b975b32cb692338bcc708
MD5 b2ba22710070ff54752a5c630ba01e13
BLAKE2b-256 7f441810d9b42aec35bada0d4960faf5cc2d20cb244ae84f6b2124cba01c868b

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