https://github.com/awslabs/fhir-works-on-aws-search-es

An Elasticsearch implementation of the FHIR Works on AWS framework, enabling users to search for FHIR resources

https://github.com/awslabs/fhir-works-on-aws-search-es

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 19 committers (5.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.8%) to scientific vocabulary

Keywords

aws fhir fhir-works healthcare hl7 nodejs typescript

Keywords from Contributors

diagram dynamodb-cli video-stream interactive embedding climate-model labels
Last synced: 5 months ago · JSON representation

Repository

An Elasticsearch implementation of the FHIR Works on AWS framework, enabling users to search for FHIR resources

Basic Info
  • Host: GitHub
  • Owner: awslabs
  • License: apache-2.0
  • Language: TypeScript
  • Default Branch: mainline
  • Homepage:
  • Size: 978 KB
Statistics
  • Stars: 32
  • Watchers: 7
  • Forks: 26
  • Open Issues: 0
  • Releases: 0
Archived
Topics
aws fhir fhir-works healthcare hl7 nodejs typescript
Created over 5 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Codeowners

README.md

fhir-works-on-aws-search-es

This GitHub repository has been migrated. You can now find FHIR Works on AWS at https://github.com/aws-solutions/fhir-works-on-aws.

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 search interface from the FHIR Works interface. It queries Elasticsearch to find the results. 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:

  • Elasticsearch - The Elasticsearch cluster is indexed by ResourceType & the domain is defined by the environment variable ELASTICSEARCHDOMAINENDPOINT
  • DynamoDB stream - To keep our Elasticsearch cluster in sync with the source of truth (DynamoDB) we expect the persistence component to have a DynamoDB stream, which will stream the table's updates to the Elasticsearch cluster

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:

FHIR search features supported

Search Parameter Types

| Feature | Supported? | Notes | |---------------|:----------:|-------| | Number | ✔ | | | Date/DateTime | ✔ | | | String | ✔ | | | Token | ✔ | | | Reference | ✔ | | | Composite | - | | | Quantity | ✔ | | | URI | ✔ | | | Special | - | |

Search modifiers

| Feature | Supported? | Notes | |---------------------|:----------:|-------| | :missing | - | | | :exact | ✔ | | | :contains | ✔* | *only works for alphanumeric search values. search values with whitespaces or punctuation characters won't work| | :text | - | | | :in (token) | - | | | :below (token) | - | | | :above (token) | - | | | :not-in (token) | - | | | :[type] (reference) | - | | | :below (uri) | - | | | :not | - | | | :above (uri) | - | |

Parameters for all resources

| Feature | Supported? | Notes | |--------------|:----------:|--- | | _id | ✔ | | | _lastUpdated | ✔ | | | _tag | ✔ | | | _profile | ✔ | | | _security | ✔ | | | _text | | | | _content | - | | | _list | - | | | _has | - | | | _type | - | | | _query | - | | | _filter | - | |

Search result parameters

| Feature | Supported? | Notes | |----------------|:----------:|-----------------------------------------------| | _sort | ✔* | * Only supports sorting by date parameters | | _count | ✔ | | | _include | ✔ | _include:iterate is limited to a search depth of 5 | | _revinclude | ✔ | _revinclude:iterate is limited to a search depth of 5 | | _summary | - | | | _total | - | | | _elements | - | | | _contained | - | | | _containedType | - | | | _score | - | |

Other

| Feature | Supported? | Notes | |-------------- |:----------:|--- | | OR search parameter | ✔ | This refers to the use of a comma. e.g. /Patient?language=FR,NL | | AND search parameter| ✔ | This refers to repeating search parameters e.g. /Patient?language=FR&language=NL | | Chained parameters | ✔ | This refers to the use of a dot. e.g. /Patient?organization.name=HL7 * The inner query must match no more than 100 results or the search returns an error. This functionality is suitable for queries where the inner query is highly selective. | | Reverse Chaining | - | |

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.

Owner

  • Name: Amazon Web Services - Labs
  • Login: awslabs
  • Kind: organization
  • Location: Seattle, WA

AWS Labs

GitHub Events

Total
  • Fork event: 1
Last Year
  • Fork event: 1

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 143
  • Total Committers: 19
  • Avg Commits per committer: 7.526
  • Development Distribution Score (DDS): 0.643
Past Year
  • Commits: 10
  • Committers: 7
  • Avg Commits per committer: 1.429
  • Development Distribution Score (DDS): 0.7
Top Committers
Name Email Commits
Nestor Carvantes c****s@g****m 51
Robert Smayda s****4@g****m 23
Sukeerth Vegaraju s****u@y****n 14
Yanyu Zheng y****0@c****u 12
dependabot[bot] 4****]@u****m 11
Tim Nguyen n****2@u****m 8
rsmayda r****a@u****m 5
smayda s****a@a****m 3
Emil Diaz e****z@u****m 2
justinusmenzel 6****l@u****m 2
Sukeerth Vegaraju s****u@g****m 2
kcadette 7****e@u****m 2
Sanket Dharwadkar s****d@a****m 2
carvantes c****s@u****m 1
github-actions[bot] 4****]@u****m 1
awsbakha 7****a@u****m 1
nisankep 1****p@u****m 1
Amazon GitHub Automation 5****o@u****m 1
sevu1 1****1@u****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 19
  • Total pull requests: 81
  • Average time to close issues: 8 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 10
  • Total pull request authors: 12
  • Average comments per issue: 2.89
  • Average comments per pull request: 0.43
  • Merged pull requests: 73
  • Bot issues: 0
  • Bot pull requests: 7
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • medhost-bfindeisen (4)
  • medhost-gkersting (4)
  • rsmayda (3)
  • lquanx (2)
  • Zambonilli (1)
  • vvedantham (1)
  • gopalp19 (1)
  • christopher-watanabe-snkeos (1)
  • adamfara24 (1)
  • justinusmenzel (1)
Pull Request Authors
  • carvantes (27)
  • ssvegaraju (13)
  • nguyen102 (10)
  • rsmayda (9)
  • Bingjiling (8)
  • dependabot[bot] (4)
  • kcadette (3)
  • github-actions[bot] (2)
  • SanketD92 (1)
  • nisankep (1)
  • lquanx (1)
  • sevu1 (1)
Top Labels
Issue Labels
enhancement (10) bug (6) Review One (3) Review Two (3) customer-inquiry (3) closing-soon-if-no-response (2) duplicate (1)
Pull Request Labels
size/s (22) size/xs (20) size/m (13) size/xl (10) auto-release-pr (9) dependencies (5) size/l (4) documentation (3) bug (3)

Packages

  • Total packages: 2
  • Total downloads:
    • npm 243 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 5
    (may contain duplicates)
  • Total versions: 72
  • Total maintainers: 3
proxy.golang.org: github.com/awslabs/fhir-works-on-aws-search-es
  • Versions: 39
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.7%
Dependent repos count: 5.9%
Last synced: 6 months ago
npmjs.org: fhir-works-on-aws-search-es

FHIR Works on AWS search Elasticsearch implementation

  • Versions: 33
  • Dependent Packages: 1
  • Dependent Repositories: 5
  • Downloads: 243 Last month
Rankings
Forks count: 4.8%
Dependent repos count: 5.1%
Downloads: 5.7%
Stargazers count: 7.0%
Average: 8.7%
Dependent packages count: 21.1%
Last synced: 12 months ago

Dependencies

package.json npm
  • @elastic/elasticsearch-mock ^0.3.1 development
  • @types/flat ^5.0.2 development
  • @types/jest ^26.0.19 development
  • @types/lodash ^4.14.161 development
  • @types/nearley ^2.11.1 development
  • @types/node ^12 development
  • @types/qs ^6.9.7 development
  • @types/uuid ^8.3.4 development
  • @typescript-eslint/eslint-plugin ^4.33.0 development
  • @typescript-eslint/parser ^4.33.0 development
  • eslint ^7.32.0 development
  • eslint-config-airbnb-base ^14.2.1 development
  • eslint-config-prettier ^8.3.0 development
  • eslint-plugin-import ^2.24.2 development
  • eslint-plugin-prettier ^4.0.0 development
  • jest ^26.6.3 development
  • jest-each ^26.4.2 development
  • jest-mock-extended ^1.0.8 development
  • json-stringify-pretty-compact ^2.0.0 development
  • prettier ^2.4.1 development
  • standard-version ^9.3.2 development
  • ts-jest ^26.4.4 development
  • typescript ^4.1.3 development
  • @aws-sdk/client-sns ^3.50.0
  • @aws-sdk/node-http-handler ^3.52.0
  • @elastic/elasticsearch 7.13
  • @types/aws-lambda ^8.10.92
  • aws-elasticsearch-connector ^8.2.0
  • aws-sdk ^2.1072.0
  • aws-xray-sdk ^3.3.4
  • date-fns ^2.19.0
  • fhir-works-on-aws-interface ^12.0.0
  • flat ^5.0.2
  • lodash ^4.17.20
  • nearley ^2.20.0
  • qs ^6.10.3
  • uuid ^8.3.2
yarn.lock npm
  • 871 dependencies
.github/workflows/code-coverage.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v1 composite
  • codecov/codecov-action v1 composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v2 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/init v1 composite
.github/workflows/labeler.yml actions
  • codelytv/pr-size-labeler v1 composite
.github/workflows/release-pr.yml actions
  • actions/checkout v2.3.4 composite
  • actions/setup-node v1 composite
  • repo-sync/pull-request v2 composite
.github/workflows/tag-and-publish.yml actions
  • JS-DevTools/npm-publish v1 composite
  • actions/checkout v2.3.4 composite
  • actions/setup-node v1 composite
.github/workflows/unit-test.yaml actions
  • actions/checkout v2 composite
  • actions/setup-node v1 composite