Skip to content

Commit

Permalink
tests done
Browse files Browse the repository at this point in the history
  • Loading branch information
meyertst-aws committed Nov 21, 2024
1 parent a8c173c commit 722b4b5
Show file tree
Hide file tree
Showing 8 changed files with 700 additions and 625 deletions.
2 changes: 1 addition & 1 deletion .doc_gen/metadata/healthlake_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ healthlake_CreateFHIRDatastore:
- python.example_code.healthlake.HealthLakeWrapper.decl
- python.example_code.healthlake.CreateFHIRDatastore
- description: >
The following code shows the parameters for SMART on
The following code shows an example of parameters for a SMART on
FHIR-enabled HealthLake data store.
snippet_tags:
- python.example_code.healthlake.CreateFHIRDatastore.smart
Expand Down
127 changes: 19 additions & 108 deletions python/example_code/healthlake/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# HealthImaging code examples for the SDK for Python
# HealthLake code examples for the SDK for Python

## Overview

Shows how to use the AWS SDK for Python (Boto3) to work with AWS HealthImaging.
Shows how to use the AWS SDK for Python (Boto3) to work with AWS HealthLake.

<!--custom.overview.start-->
<!--custom.overview.end-->

_HealthImaging is a HIPAA-eligible service that helps health care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images._
_HealthLake _

## ⚠ Important

Expand All @@ -34,42 +34,23 @@ python -m pip install -r requirements.txt
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->

### Get started

- [Hello HealthImaging](imaging_set_and_frames_workflow/hello.py#L4) (`ListDatastores`)


### Single actions

Code excerpts that show you how to call individual service functions.

- [CopyImageSet](health_lake_wrapper.py#L417)
- [CreateDatastore](health_lake_wrapper.py#L31)
- [DeleteDatastore](health_lake_wrapper.py#L104)
- [DeleteImageSet](health_lake_wrapper.py#L489)
- [GetDICOMImportJob](health_lake_wrapper.py#L158)
- [GetDatastore](health_lake_wrapper.py#L54)
- [GetImageFrame](health_lake_wrapper.py#L318)
- [GetImageSet](health_lake_wrapper.py#L241)
- [GetImageSetMetadata](health_lake_wrapper.py#L274)
- [ListDICOMImportJobs](health_lake_wrapper.py#L183)
- [ListDatastores](health_lake_wrapper.py#L79)
- [ListImageSetVersions](health_lake_wrapper.py#L350)
- [ListTagsForResource](health_lake_wrapper.py#L556)
- [SearchImageSets](health_lake_wrapper.py#L211)
- [StartDICOMImportJob](health_lake_wrapper.py#L124)
- [TagResource](health_lake_wrapper.py#L514)
- [UntagResource](health_lake_wrapper.py#L534)
- [UpdateImageSetMetadata](health_lake_wrapper.py#L381)

### Scenarios

Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.

- [Get started with image sets and image frames](imaging_set_and_frames_workflow/imaging_set_and_frames.py)
- [Tagging a data store](tagging_data_stores.py)
- [Tagging an image set](tagging_image_sets.py)
- [CreateFHIRDatastore](health_lake_wrapper.py#L42)
- [DeleteFHIRDatastore](health_lake_wrapper.py#L136)
- [DescribeFHIRDatastore](health_lake_wrapper.py#L84)
- [DescribeFHIRExportJob](health_lake_wrapper.py#L310)
- [DescribeFHIRImportJob](health_lake_wrapper.py#L197)
- [ListFHIRDatastoreImportJobs](health_lake_wrapper.py#L222)
- [ListFHIRDatastores](health_lake_wrapper.py#L106)
- [ListFHIRExportJobs](health_lake_wrapper.py#L335)
- [ListTagsForResource](health_lake_wrapper.py#L404)
- [StartFHIRExportJob](health_lake_wrapper.py#L272)
- [StartFHIRImportJob](health_lake_wrapper.py#L154)
- [TagResource](health_lake_wrapper.py#L385)
- [UntagResource](health_lake_wrapper.py#L426)


<!--custom.examples.start-->
Expand All @@ -83,77 +64,7 @@ functions within the same service.
<!--custom.instructions.start-->
<!--custom.instructions.end-->

#### Hello HealthImaging

This example shows you how to get started using HealthImaging.

```
python imaging_set_and_frames_workflow/hello.py
```


#### Get started with image sets and image frames

This example shows you how to import DICOM files and download image frames in HealthImaging.</para>
<para>The implementation is structured as a workflow command-line
application.


- Set up resources for a DICOM import.
- Import DICOM files into a data store.
- Retrieve the image set IDs for the import job.
- Retrieve the image frame IDs for the image sets.
- Download, decode and verify the image frames.
- Clean up resources.

<!--custom.scenario_prereqs.medical-imaging_Scenario_ImageSetsAndFrames.start-->
<!--custom.scenario_prereqs.medical-imaging_Scenario_ImageSetsAndFrames.end-->

Start the example by running the following at a command prompt:

```
python imaging_set_and_frames_workflow/imaging_set_and_frames.py
```


<!--custom.scenarios.medical-imaging_Scenario_ImageSetsAndFrames.start-->
<!--custom.scenarios.medical-imaging_Scenario_ImageSetsAndFrames.end-->

#### Tagging a data store

This example shows you how to tag a HealthImaging data store.


<!--custom.scenario_prereqs.medical-imaging_Scenario_TaggingDataStores.start-->
<!--custom.scenario_prereqs.medical-imaging_Scenario_TaggingDataStores.end-->

Start the example by running the following at a command prompt:

```
python tagging_data_stores.py
```


<!--custom.scenarios.medical-imaging_Scenario_TaggingDataStores.start-->
<!--custom.scenarios.medical-imaging_Scenario_TaggingDataStores.end-->

#### Tagging an image set

This example shows you how to tag a HealthImaging image set.


<!--custom.scenario_prereqs.medical-imaging_Scenario_TaggingImageSets.start-->
<!--custom.scenario_prereqs.medical-imaging_Scenario_TaggingImageSets.end-->

Start the example by running the following at a command prompt:

```
python tagging_image_sets.py
```


<!--custom.scenarios.medical-imaging_Scenario_TaggingImageSets.start-->
<!--custom.scenarios.medical-imaging_Scenario_TaggingImageSets.end-->

### Tests

Expand All @@ -170,9 +81,9 @@ in the `python` folder.

## Additional resources

- [HealthImaging Developer Guide](https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html)
- [HealthImaging API Reference](https://docs.aws.amazon.com/healthimaging/latest/APIReference/Welcome.html)
- [SDK for Python HealthImaging reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/medical-imaging.html)
- [HealthLake Developer Guide](https://docs.aws.amazon.com/healthlake/latest/devguide/what-is-amazon-health-lake.html)
- [HealthLake API Reference](https://docs.aws.amazon.com/healthlake/latest/APIReference/Welcome.html)
- [SDK for Python HealthLake reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/medical-imaging.html)

<!--custom.resources.start-->
<!--custom.resources.end-->
Expand Down
Loading

0 comments on commit 722b4b5

Please sign in to comment.