@abacus-insights/fhir-works-on-aws-routing 中文文档教程
fhir-works-on-aws-routing
Purpose
请访问 fhir-works-on-aws-deployment 了解项目的整体愿景和更多信息语境。
此包是 FHIR Works 接口 路由的实现。 它负责获取基于 FHIR 的 HTTP 请求并将其路由到正确的子组件。 它还通过 JSON 模式 进行所有资源验证。 最后，该组件负责生成Capability Statement，用于描述 FHRI API 可以做什么。 要使用和部署此组件（与其他“开箱即用”组件），请遵循总体README< /a>
Infrastructure
这个包假设有一定的基础设施：
- API Gateway - We expect all the routing to invoke the FHIR Works Lambda
- Lambda - We expect the input to be entering our function in a certain way
Usage
为了使用，请将这个包添加到你的 package.json 文件中，并作为依赖项安装。 使用示例请看部署组件的package.json
Dependency tree
这个包取决于每个子组件的类型：
- interface component
- This package defines the interface we are trying to use
- An authorization component that is responsible for saying if the request is allowed or not
- Example: fhir-works-on-aws-authz-rbac
- A persistence component that is responsible for handing CRUD based requests
- Example: fhir-works-on-aws-persistence-ddb
- A bundle based component that is responsible for handling batches & transactions
- Example: fhir-works-on-aws-persistence-ddb
- A search component that is responsible for handling the search based requests
- Example: fhir-works-on-aws-search-es
- A history component that is responsible for handling the historical search requests
- No example
- Finally a deployment component to deploy this to AWS
- Example: fhir-works-on-aws-deployment
注意：如果您的用例不需要上述功能/组件之一，请设置您的配置，路由器将相应地路由
Known issues
已知问题请跟踪 GitHub 存储库中的问题有关
Security
详细信息，请参阅CONTRIBUTING。
License
这个项目是在 Apache-2.0 许可证下获得许可的。
fhir-works-on-aws-routing
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 routing of the FHIR Works interface. It is responsible for taking a FHIR based HTTP request and routing it to the correct sub-component. It also does all the resource validatation by way of JSON schemas. Finally, This component is responsible for generating the Capability Statement, which is used to describe what a FHRI API can do. To use and deploy this component (with the other 'out of the box' components) please follow the overall README
Infrastructure
This package assumes certain infrastructure:
- API Gateway - We expect all the routing to invoke the FHIR Works Lambda
- Lambda - We expect the input to be entering our function in a certain way
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 a type of each subcomponent:
- interface component
- This package defines the interface we are trying to use
- An authorization component that is responsible for saying if the request is allowed or not
- Example: fhir-works-on-aws-authz-rbac
- A persistence component that is responsible for handing CRUD based requests
- Example: fhir-works-on-aws-persistence-ddb
- A bundle based component that is responsible for handling batches & transactions
- Example: fhir-works-on-aws-persistence-ddb
- A search component that is responsible for handling the search based requests
- Example: fhir-works-on-aws-search-es
- A history component that is responsible for handling the historical search requests
- No example
- Finally a deployment component to deploy this to AWS
- Example: fhir-works-on-aws-deployment
NOTE: if your use-case does not require one of the above features/components, please set the your configuration as such and the router will route accordingly
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.
