steveruckdashel/fhir

Generic FHIR server implementation in GoLang.

Intervention Engine FHIR Server

This project provides HL7 FHIR DSTU2 models and server components implemented in Go and using MongoDB as storage. Other versions of FHIR are also supported on other branches within this repository:

• stu3_mar2017 - Official FHIR STU3 Release
• stu3_jan2017 - FHIR 1.8 (San Antonio)
• stu3_aug2016 - FHIR 1.6 (Baltimore)
• stu3_mar2016 - FHIR 1.4 (Montreal)

This is a library that can be embedded into other server applications. The library is not a complete implementation of FHIR, as features that are selected are driven by the Intervention Engine, eCQM Engine, Patient Matching Test Harness and Synthetic Mass projects.

Currently, this server library supports:

• JSON representations of all resources
• Create/Read/Update/Delete (CRUD) operations
• Conditional update and delete
• Some but not all search features
  • All defined resource-specific search parameters except composite types and contact (email/phone) searches
  • Chained searches
  • _include and _revinclude searches (without _recurse)
• Batch bundle uploads (POST, PUT, and DELETE entries)

Currently, this server does not support the following major features:

• XML representations of resources
• History (versions, etc.)
• Extension of primitive types and resource sub-components

As mentioned above, this repository contains a library. It does not build into a stand alone application. If you would like to build a server application, please see fhir-server project.

NOTE: Most of the fhir source code is generated by the fhir-golang-generator. In most cases, updates to source code in the fhir repository need to be accompanied by corresponding updates in the fhir-golang-generator.

Development

This project uses Go 1.7 and MongoDB. To test the library, first, install all of the dependencies:

$ go get -t ./...

Once the dependencies are installed, you should make sure that MongoDB is also running. The test suite will create a fhir-test database in a local instance of MongoDB to execute some tests. You can then run the test suite with the following:

$ go test ./...

Usage

Users of this library should work with the FHIRServer struct. Web request handlers in this library are implemented using Gin.

Examples of usage can be found in the server set up of the eCQM Engine or the server set up of Intervention Engine.

License

Copyright 2017 The MITRE Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.