Skip to main content
info
This documentation is for version v2.4 of the product.
For the latest version(v2.7) documentation click here
Version: v2.4 print this page

HealthImaging

Amazon HealthImaging is a new HIPAA-eligible capability that makes it easy to store, access, and analyze medical images at petabyte scale. In Amorphic, this functionality allows medical images within the Amorphic dataset to be processed through AWS HealthImaging service.

Note

To use HealthImaging, HCLS should be enabled in the environment.

How to create a HealthImaging store?

  1. Click on + New Imaging Datastore.
  2. Fill in the required fields (Details listed below).

Create HealthImaging

Following fields are needed to create a new Imaging Datastore:

  • StoreName: The name for the HealthImaging data store.
  • Description: A brief description about the HealthImaging data store.
  • Keywords: Optional keywords for the HealthImaging data store. This can be used to flag related stores.

Two API-only attributes, IsAutoTerminateEnabled and AutoTerminationTime, are available. Users can utilize these attributes to set an auto-termination time during creation, limited to API usage for now.

IsAutoTerminateEnabled(true/false): This enables Imaging Store termination based on the time value provided by the user.

AutoTerminationTime: Time at which the system auto terminates the Imaging store. Eg: "2023-12-01 18:30:00"

After entering the details, click the Create button to initiate the HealthImaging data store creation.

HealthImaging Store details

Once the store creation is triggered, the store details will appear in the page in this format.

HealthImaging Details

How to import data into HealthImaging Datastore?

  1. Under the Import Jobs tab, click on the + New Job button.
  2. In the following form, specify a dataset which contains the DICOM data.

Import Data into HealthImaging

Note

Only files of .dcm format will be imported into HealthImaging Datastore.

The prerequisite for creating an import job is,

  1. User must first create a dataset in Amorphic with S3 target type and set the file type as 'others'.
  2. Upload the required DICOM file (.dcm format) into that dataset.
  3. Create a job by selecting this dataset name from the drop-down list and initiate the job.

Scheduling functionality is currently available exclusively as an API feature, allowing automation and execution of import jobs at desired intervals.

Upon successful completion, the user can view the imageset created from those files in the imageset tab. This is an asynchronous process and will take a while to complete.

If an import job has either succeeded or failed, user can download the respective success and failure files, along with the manifest file, directly from the Job details tab, as shown below. HealthImaging Job Details

What is Imagesets?

An imageset is automatically generated upon successful completion of an import job. Users can view the metadata and preview of the imageset, and they also have the ability to edit the imageset metadata. For each imageset updation, a new version of the imageset will be created.

However, when a user updates any imageset metadata, that imageset will go into a LOCKED state, preventing the user from viewing it. After the updation, the user can see the imageset in the list.

When utilizing the AWS HealthImaging service, there are specific constraints for updating the imageset. Users must refer to the documentation to identify and update the correct fields. If a user attempts to update any non-editable attributes, the imageset update status will be marked as failed.

An example of imageset updating is shown below: HealthImaging imageset

Note

Imagesets are dependent on datastores. To delete datastore, all associated imagesets must be deleted.

How to filter Imagesets (API only)

Users can filter the imagesets with different search criteria. This helps the user to list only the imagesets they are interested in.

There are two operators(equal, between) which used to filter imagesets. Possible search filters are given below based on the supported operator.

1. Equal
1. PatientId
2. AccessionNumber
3. StudyId
4. StudyInstanceUID
2. Between
1. StudyDateAndTime
2. CreatedAt

API's list & Request payload details

  1. To retrieve list of imagesets with the search filter.

    /hcls/health-imaging/<store_id> & GET method

    Response depends on query parameters(if any).

    Query parameterResponse
    actionValue: list_imageset. This will returns list of imagesets in healthimage store.
    operationPossible values: equal/between. To specify the operator required for the search criteria.
    filterKeyPossible values:
    • when operation=equal
      1. PatientId
      2. AccessionNumber
      3. StudyId
      4. StudyInstanceUID
    • when operation=between
      1. StudyDateAndTime
      2. CreatedAt
    filterValueValue for the filterKey to search for imagesets. Required only when operation is between.
    startTimeStartTime to search the imagesets in the format yyyy-mm-ddThh:mm:ss in UTC. Required only when operation is between.
    endTimeEndTime to search the imagesets in the format yyyy-mm-ddThh:mm:ss in UTC. Required only when operation is between.

How to view the medical images in HealthImaging store using image viewer?

Users can view the medical images that are upload to HealthImaging using image preview option.

All imagesets in a HealthImaging store will have a key called StudyInstanceUID. Imagessets that are having the same StudyInstanceUID will be grouped together to view the images in the image viewer.

Following are the step to view HealthImaging images in the image viewer:

  1. Select the HealthImaging store from which you want to view the images.
  2. Go to image preview tab and click on the Connect to Imageviewer button.
  3. You can optionally click on Recheck status button to check the connection status of HealthImaging store with Image viewer.

Below image shows how view medical images in HealthImaging store with image viewer. Connect HealthImaging store with image viewer

Users have the option to disconnect HealthImaging store from image viewer if image viewing is no longer required. To do that, click on Disconnect from Imageviewer from the three dot button on the top right corner of HealthImaging store. Disconnect HealthImaging store from image viewer

Note

Customer first need to set up image viewer inorder to use this feature. Contact Amorphic support setting up image viewer in Amorphic.