fhir-works-on-aws-persistence-facade v1.0.0

fhir-works-on-aws-persistence-facade

Purpose

Please visit fhir-works-on-aws-deployment for overall vision of the project and for more context.

This package is an implementation of the persistence components of the FHIR Works interface. It is responsible for executing CRUD based requests from the router by proxying the requests to an Integration Transform microservice.

The Integration Transform microservice should implement authentication by using API Gateway resource policy.

The Integration Transform microservice should also implement the persistence APIs as defined here. Routes that should be implemented

• POST /persistence/{resourceType}
• GET /persistence/{resourceType}/{id}
• PUT /persistence/{resourceType}/{id}

• DELETE /persistence/{resourceType}/{id}

For more details about the Integration Transform and how to set it up, please refer to here

To use and deploy fhir-works-on-aws-persistence-facade (with the other 'out of the box' components) please follow the overall README in the API branch of the deployment package.

Usage

For usage please add this package to your package.json file and install as a dependency. For usage examples please see the deployment component's package.json

Dependency tree

This package is dependent on:

• interface component
  • This package defines the interface we are trying to use
• deployment component
  • This package deploys this and all the default components

Known issues

For known issues please track the issues on the GitHub repository

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.