# ohif-aws-healthimaging

> Support reading tree structured metadata

Latest version **0.12.2** (published 2025-04-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install ohif-aws-healthimaging
pnpm add ohif-aws-healthimaging
yarn add ohif-aws-healthimaging
bun add ohif-aws-healthimaging
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.12.2 |
| Published | 2025-04-02 |
| First published | 2023-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=14 |
| Dependencies | 3 |
| Unpacked size | 135.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 28 |
| Author | Bill Wallace, Mateus Freira,Radical Imaging, Ibrahim Mohamed, Jefferson Tang |
| Maintainers | mateusfreira, brunoalvesdefaria, ibrahimcsae |
| Keywords | ohif-extension |

## Links

- npm: https://www.npmjs.com/package/ohif-aws-healthimaging
- Repository: https://github.com/RadicalImaging/ohif-aws-healthimaging
- Homepage: https://github.com/RadicalImaging/ohif-aws-healthimaging#readme
- Issues: https://github.com/RadicalImaging/ohif-aws-healthimaging/issues
- npm.io page: https://npm.io/package/ohif-aws-healthimaging

## Dependencies (3)

- [aws4fetch](https://npm.io/package/aws4fetch.md) ^1.0.17
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) 7.7.6
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.32.2

## Recent versions

- 0.12.2 (latest) — 2025-04-02
- 0.11.0 — 2024-12-13
- 0.10.0 — 2024-04-26
- 0.9.10 — 2024-01-17
- 0.9.9 — 2023-12-30
- 0.9.8 — 2023-11-15
- 0.9.7 — 2023-10-20
- 0.9.6 — 2023-10-20
- 0.9.5 — 2023-10-20
- 0.9.4 — 2023-10-20
- 0.9.2 — 2023-10-19
- 0.9.1 — 2023-09-29
- 0.9.0 — 2023-08-30
- 0.8.0 — 2023-08-30
- 0.7.0 — 2023-08-09
- … 6 more at https://npm.io/package/ohif-aws-healthimaging/versions

## README

# OHIF AWS HealthImaging adapter

Note - The official name for the service is "AWS HealthImaging".  Before GA it was called "Amazon HealthLake Imaging" and several references in the code and documentation still reference this old name.  These references will be updated shortly

# Setting up

## Prerequisites
* Node.js +18
* Yarn 1.22.22.  Note that OHIF uses a legacy version of yarn, you need to force yarn to use classic mode to build properly.  
  ``` bash
  > npm i -g yarn # install yarn
  > yarn set version classic # force yarn to use classic version.  Make sure you do this from your repo directories
  ```
* OHIF follow the [Getting started guide if needed](https://v3-docs.ohif.org/development/getting-started/).
* Checkout the latest release branch.  3.8 is known to work, master may be unstable so don't start there in case it is broken
  ```bash
  > git remote add upstream git@github.com:OHIF/Viewers.git # make sure your fork upstream is set properly
  > git fetch upstream # get the list of branches from upstream repo
  > git checkout release/3.8 # switch to a specific branch
  ```
* Install ohif-aws-healthimaging package:
* Create an access key in the AWS portal
* Follow AWS documentation on how to create an AWS Health Imaging Datastore and load it with DICOM data
* Start the proxy to secure your access keys
```bash
# AWS_HOST
docker run -p 8089:8089 -e AWS_ACCESS_KEY_ID='YOUR_KEY' -e AWS_SECRET_ACCESS_KEY='YOUR_SECRET' -e AWS_REGION='YOUR_REGION' flexview/ohif-aws-healthimaging-proxy
```
* Add healthimaging as a dependency 
```bash
yarn cli add-extension ohif-aws-healthimaging
```
* Add healthimaging adapter as an OHIF plugin `platform/viewer/pluginConfig.json`
```json
  "extensions": [
    //....
    {
      "packageName": "ohif-aws-healthimaging"
    }
  ],

```
* Configure the data source to access healthimaging via the proxy

platform/app/public/config/default.js
```js
  //...
  dataSources: [{
    friendlyName: 'AWS HealthImaging',
    namespace: 'ohif-aws-healthimaging.dataSourcesModule.healthlake',
    sourceName: 'healthlake',
    configuration: {
      name: 'healthlake',
      healthlake: {
        datastoreID: $YOUR_DATASTORE_ID,
        endpoint: 'http://localhost:8089',// Add here the address to you proxy
      },
      singlepart: 'bulkdata,video,pdf,image/jphc',
    }
  }
  ],

```
* Run OHIF
```bash
yarn start # in the OHIF platform/viewer folder
```
* Opening your first exam
```
http://localhost:3000/viewers?StudyInstanceUIDs=$DICOMStudyUIDHere&ImageSetID=$ImageSetIDHere
```

# How to use a local version of ohif-aws-healthimaging

Fork the repository and make a local clone

From your ohif-aws-healthimaging directory

```bash
yarn install
yarn watch # auto rebuild on change to source
```

From the OHIF Viewers directory
```bash
yarn cli remove-extension ohif-aws-healthimaging
yarn cli link-extension $PATH_TO_YOUR_OHIF_AWS_HEALTHIMAGING_DIR
yarn run dev
```

## Description 
Support metadata and imaging data loading from AWS HealthImaging

## Advance config option
```javascript
.dataSources[].groupSeriesBy // Change the field used to grup series by, the default value is `seriesNumber`. Ps grouping by SeriesInstanceUID will result into one series per Image Set
```

## Known Issues
* StudyList does not support querying on the following fields: Patient Name, Study Date, Description, Modality

## FAQ
## Why do we need the proxy server?
* You should never expose your AWS keys to the client. We created this tiny proxy with the only purpose of hiding the AWS keys in the backend.
* The Proxy server available here is meant to be for development only. In actual use cases, we encourage you to implement authentication on top of the proxy so you secure access to your data.


## Authors 
Bill Wallace, Mateus Freira, Radical Imaging, Chris Hafey, Ibrahim Mohamed, Jefferson Tang

## License 
MIT

---
_Source: https://npm.io/package/ohif-aws-healthimaging · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._