Hcls

APIs for HealthCare & Life Sciences (HCLS) resources including AWS HealthLake FHIR datastores, Omics storage (reference/sequence), Omics workflows/runs, HealthImaging datastores/imagesets, import jobs, and FlexView integration.

📄️ List user-accessible HCLS stores and workflows

Returns the list of HCLS stores or workflows that the caller can access. Behavior depends on hcls_name: healthlake / omics-storage / health-imaging return stores; omics-workflows returns workflows. For omics-workflows, action=get_presigned_url returns a workflow definition upload presigned URL instead of the list.

📄️ Create a new HCLS store or workflow

Creates a new HCLS resource based on hcls_name. omics-storage creates an Omics reference or sequence store (StoreType required: omics-reference or omics-sequence). healthlake / health-imaging create the corresponding datastore (IsAutoTerminateEnabled and Keywords required). omics-workflows creates an Omics workflow (WorkflowName, WorkflowEngine, StorageCapacity, WorkflowS3Path required; WorkflowEngine is WDL or NEXTFLOW).

📄️ Get details of an HCLS store or workflow

Returns details of a single HCLS store or workflow. When no query parameters are provided, returns the full store/workflow item including AccessType. Optional action query parameter selects nested resource operations (references, readsets, imagesets, dependent resources).

📄️ Search HealthImaging imagesets

Searches HealthImaging imagesets in the given datastore using Patient, Study, Series, CreatedAt, and/or StudyTimestamp filters. Only supported when hcls_name is health-imaging and action is search_imagesets. Request body must be a non-empty object whose keys are a subset of those filters. CreatedAt and StudyTimestamp each require StartTime and EndTime.

📄️ Update an HCLS store or workflow

Updates an HCLS store or workflow, or performs a related update action. omics-storage with action=activate_read_set activates an archived read set (read_set_id required). omics-workflows updates Description and/or DatasetAccess (Owner max 1 dataset). healthlake / health-imaging update store metadata (IsAutoTerminateEnabled, AutoTerminationTime, Description, Keywords, DisplayName), or with action=update_imageset update DICOM imageset metadata (imageset_id and latest_versionid required).

📄️ Delete an HCLS store or workflow

Deletes an HCLS store or workflow, or a nested resource within a store. With no query action, deletes the entire store/workflow (owner required). omics-storage supports action=delete_reference (reference_id) or delete_readset (readset_id). health-imaging supports action=delete_imageset (imageset_id). If dependent resources block deletion, returns HTTP 400 with DependentResources.

📄️ List user-accessible HCLS jobs

Returns import and related jobs for the given HCLS store that the caller can access (HealthLake, Omics Storage, or HealthImaging).

📄️ Start an HCLS data import job

Starts a data import job against the given store. omics-storage requires DatasetId, JobName, and ImportJobConfig (reference stores use ReferenceGenome and FileName; sequence stores also use ReadSetName, SampleId, SubjectId). healthlake requires DatasetId and JobName (dataset must have completed .ndjson files). health-imaging requires DatasetId and JobName (dataset must have completed .dcm files; JobName pattern ^[A-Za-z0-9_#.-]{1,64}$). Only one active HealthLake import job is allowed per store.

📄️ Get details of an HCLS job

Returns details of a single HCLS import/activation job. For healthlake and health-imaging, action=download_file with s3_file returns a presigned URL for the job manifest, failure, or success file.

📄️ List user-accessible HCLS workflow runs

Returns workflow runs associated with the given Omics workflow (hcls_name must be omics-workflows) that the caller can access.

📄️ Start an HCLS workflow run

Starts a new Omics workflow run for the given workflow. Only supported when hcls_name is omics-workflows and the workflow Status is active. Requires WorkflowRunName and WorkflowRunLogLevel (off, fatal, error, or all). StorageCapacity is optional (1-20000; defaults from workflow/store config). WorkflowRunParams is an optional object of workflow input parameters. Caller needs editor access on the workflow.

📄️ Get a specific HealthLake FHIR resource

Returns a specific FHIR resource by ResourceType and ResourceID from a HealthLake datastore. Only supported when hcls_name is healthlake.

📄️ Update a specific HealthLake FHIR resource

Updates a specific FHIR resource identified by ResourceType and ResourceID in a HealthLake datastore. Only supported when hcls_name is healthlake. Requires editor access. Request body HealthLakeQuery holds the FHIR resource payload; when Encoding is base64 the payload is base64-decoded before update.

📄️ Delete a specific HealthLake FHIR resource

Deletes a specific FHIR resource identified by ResourceType and ResourceID from a HealthLake datastore. Only supported when hcls_name is healthlake. Requires editor access.

📄️ Search HealthLake FHIR resources by type

Searches FHIR resources of the given ResourceType in a HealthLake datastore. Only supported when hcls_name is healthlake. All query string parameters (other than reserved API params) are forwarded as FHIR search parameters. Use the resources-metadata endpoint to discover supported search parameter names per resource type.

📄️ Create a HealthLake FHIR resource by type

Creates a FHIR resource of the given ResourceType in a HealthLake datastore. Only supported when hcls_name is healthlake. Requires editor access. Request body HealthLakeQuery holds the FHIR resource payload; when Encoding is base64 the payload is base64-decoded before create.

📄️ Get HealthLake resource types and search parameters

Returns all FHIR ResourceTypes and their corresponding search parameter names supported by the HealthLake datastore. Only supported when hcls_name is healthlake. Response is an object mapping resource type name to an array of search param names.

📄️ Get details of an HCLS workflow run

Returns details of a single Omics workflow run, or a related action result. With no action, returns the workflow run item. action=list_run_tasks lists tasks for the run (supports limit and marker). action=get_logs returns CloudWatch/S3 log content; with task_id returns a presigned URL for that task's logs, otherwise may trigger async log generation. action=download_logs returns a PresignedURL for the aggregated run log file (requires S3LogPath on the run).

📄️ Cancel a running HCLS workflow run

Cancels a running Omics workflow run. Requires query parameter action=stop. Only supported for omics-workflows runs that are currently running.

📄️ Delete an HCLS workflow run

Deletes an Omics workflow run record. The run must not be in a non-deletable running state (cancel first with action=stop if needed).

📄️ Perform FlexView connection-related GET requests

HealthImaging FlexView helpers. Only supported when hcls_name is health-imaging. When hcls_action is view and action=generate-token, generates a FlexView access token (and optionally a study viewer URL when studyInstanceUID is provided). When hcls_action is datasourcetoken, generates an AWS datasource token for FlexView.

📄️ Connect or disconnect a HealthImaging store from FlexView

Connects or disconnects a HealthImaging datastore from FlexView integration. Only supported when hcls_name is health-imaging and hcls_action is view. Requires action=connect or action=disconnect.