Skip to content

Latest commit

 

History

History
136 lines (114 loc) · 5.09 KB

README.md

File metadata and controls

136 lines (114 loc) · 5.09 KB
Raw

Burni FHIR Server

English | 繁體中文
Burni is a user-friendly implementation of the FHIR server built using Node, Express, and MongoDB. It offers a straightforward way for developers to customize the HL7 FHIR® specification, with support for both Windows and Linux environments, making it easy to deploy a FHIR service. Burni allows you to import your Implementation Guide and store FHIR Resources, while also creating FHIR RESTful APIs.
Burni uses version 4.0.1 (R4) of the HL7 FHIR specification.

Conformance Statement

Burni has been tested by AEGIS Touchstone Basic-R4-Server. The conformance results show below:

features

This server supported FHIR RESTFul API below:

Don't remove Bundle.js in models/mongodb/FHIRTypeSchema

Requirements

  • node.js >= 16
  • MongoDB >= 4
  • Java JDK >= 11 (For validator)

Installation

npm install

configure

The resources config in config\config.js

module.exports = {
    // add the resource name that you need
    "Patient" : { 
        "interaction": {
            "read": true,
            "vread": true,
            "update": true,
            "delete": true,
            "history": true,
            "create": true,
            "search": true
        }
    }
}

dotenv in root path .env

MONGODB_NAME="dbName"
MONGODB_HOSTS=["mongodb"]
MONGODB_PORTS=[27017]
MONGODB_USER="myAdmin"
MONGODB_PASSWORD="MymongoAdmin1"
MONGODB_IS_SHARDING_MODE=false
MONGODB_SLAVEMODE=false

SERVER_PORT=8080 
SERVER_SESSION_SECRET_KEY="secretKey"

FHIRSERVER_HOST="localhost"
FHIRSERVER_PORT=8080 #use by creating bundle url
FHIRSERVER_APIPATH="fhir"

#If u want to use token auth, add below.
ENABLE_TOKEN_AUTH=true
ADMIN_LOGIN_PATH="adminLogin"  
ADMIN_USERNAME="adminUsername"
ADMIN_PASSWORD="adminPassword"

ENABLE_CHECK_ALL_RESOURCE_ID=false #true that want to check resource id cross all resource
ENABLE_CHECK_REFERENCE #true that want to check reference is exist in resource content
    
ENABLE_VALIDATOR=true

After configuration, run npm run build to generate resources

npm run build

TypeError: genParamFunc[type] is not a function mean that search parameter method not support

Usage

node server.js

RESTful API

  • get (search)
    • Number
    • Date (DateTime, Instance Not yet)
    • String
    • Token
    • Reference

GET http://example.com/fhir/Patient

  • getById (read)

GET http://example.com/fhir/Patient/123

  • getHistoryById (history, vread)

GET http://example.com/fhir/Patient/_history/

GET http://example.com/fhir/Patient/_history/1

  • putById (update)

PUT http://example.com/fhir/Patient/1

  • deleteById (delete)

DELETE http://example.com/fhir/Patient/1

Examples

The details of postman's request body and response: Examples Using Postman

Validation

Burni use the node-java-fhir-validator to do validation.

  • You can put IG's (package.tgz) or json (StructureDefinition) file in utils/validator/igs, and Burni will load it into the validator
  • You must configure ENABLE_VALIDATOR in .env(dotenv) to true to enable validation feature

TODO

  • Search parameters

    • composite
    • uri

  • Narrative generate

Special project

  • Raccoon - a noSQL-based DICOMWeb Server.
  • ngs2fhir - Convert the next generation sequencing (NGS) data to the FHIR Resources.