Esempi per HealthLake con AWS CLI - AWS Command Line Interface
Operazioni

Esempi per HealthLake con AWS CLI

Gli esempi di codice seguenti mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface con HealthLake.

Le operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, dove è possibile trovare le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Operazioni

L’esempio di codice seguente mostra come utilizzare create-fhir-datastore.

AWS CLI

Esempio 1: per creare un datastore HealthLake abilitato per SigV4

Nell’esempio seguente create-fhir-datastore crea un nuovo datastore in AWS HealthLake.

aws healthlake create-fhir-datastore \
    --datastore-type-version R4 \
    --datastore-name "FhirTestDatastore"

Output:

{
    "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/",
    "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)",
    "DatastoreStatus": "CREATING",
    "DatastoreId": "(Data store ID)"
}

Esempio 2: per creare un datastore HealthLake abilitato per la piattaforma SMART on FHIR

Nell’esempio seguente create-fhir-datastore crea un nuovo datastore abilitato per SMART on FHIR in AWS HealthLake.

aws healthlake create-fhir-datastore \
    --datastore-name "your-data-store-name" \
    --datastore-type-version R4 \
    --preload-data-config PreloadDataType="SYNTHEA" \
    --sse-configuration '{ "KmsEncryptionConfig": {  "CmkType": "CUSTOMER_MANAGED_KMS_KEY", "KmsKeyId": "arn:aws:kms:us-east-1:your-account-id:key/your-key-id" } }' \
    --identity-provider-configuration  file://identity_provider_configuration.json

Contenuto di identity_provider_configuration.json.

{
    "AuthorizationStrategy": "SMART_ON_FHIR_V1",
    "FineGrainedAuthorizationEnabled": true,
    "IdpLambdaArn": "arn:aws:lambda:your-region:your-account-id:function:your-lambda-name",
    "Metadata": "{\"issuer\":\"https://ehr.example.com\", \"jwks_uri\":\"https://ehr.example.com/.well-known/jwks.json\",\"authorization_endpoint\":\"https://ehr.example.com/auth/authorize\",\"token_endpoint\":\"https://ehr.token.com/auth/token\",\"token_endpoint_auth_methods_supported\":[\"client_secret_basic\",\"foo\"],\"grant_types_supported\":[\"client_credential\",\"foo\"],\"registration_endpoint\":\"https://ehr.example.com/auth/register\",\"scopes_supported\":[\"openId\",\"profile\",\"launch\"],\"response_types_supported\":[\"code\"],\"management_endpoint\":\"https://ehr.example.com/user/manage\",\"introspection_endpoint\":\"https://ehr.example.com/user/introspect\",\"revocation_endpoint\":\"https://ehr.example.com/user/revoke\",\"code_challenge_methods_supported\":[\"S256\"],\"capabilities\":[\"launch-ehr\",\"sso-openid-connect\",\"client-public\"]}"
}

Output:

{
    "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/",
    "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)",
    "DatastoreStatus": "CREATING",
    "DatastoreId": "(Data store ID)"
}

Per ulteriori informazioni, consulta Creating and monitoring a FHIR data store nella Guida per sviluppatori di AWS HealthLake.

  • Per informazioni dettagliate sull’API, consulta CreateFHIRDatastore in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare delete-fhir-datastore.

AWS CLI

Come eliminare un datastore FHIR

Nell’esempio seguente delete-fhir-datastore mostra come eliminare un datastore e tutto il relativo contenuto in AWS HealthLake.

aws healthlake delete-fhir-datastore \
    --datastore-id (Data store ID)

Output:

{
    "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/",
    "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)",
    "DatastoreStatus": "DELETING",
    "DatastoreId": "(Data store ID)"
}

Per ulteriori informazioni, consulta “Creating and monitoring a FHIR data store” <https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html> nella Guida per sviluppatori di AWS HealthLake.

  • Per informazioni dettagliate sull’API, consulta DeleteFHIRDatastore in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare describe-fhir-datastore.

AWS CLI

Come descrivere un datastore FHIR

Nell’esempio seguente describe-fhir-datastore cerca le proprietà di un datastore in AWS HealthLake.

aws healthlake describe-fhir-datastore \
    --datastore-id "1f2f459836ac6c513ce899f9e4f66a59"

Output:

{
    "DatastoreProperties": {
        "PreloadDataConfig": {
            "PreloadDataType": "SYNTHEA"
        },
        "SseConfiguration": {
            "KmsEncryptionConfig": {
                "CmkType": "CUSTOMER_MANAGED_KMS_KEY",
                "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
            }
        },
        "DatastoreName": "Demo",
        "DatastoreArn": "arn:aws:healthlake:us-east-1:<AWS Account ID>:datastore/<Data store ID>",
        "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Data store ID>/r4/",
        "DatastoreStatus": "ACTIVE",
        "DatastoreTypeVersion": "R4",
        "CreatedAt": 1603761064.881,
        "DatastoreId": "<Data store ID>",
        "IdentityProviderConfiguration": {
            "AuthorizationStrategy": "AWS_AUTH",
            "FineGrainedAuthorizationEnabled": false
        }
    }
}

Per ulteriori informazioni, consulta Creating and monitoring a FHIR data stores nella Guida per sviluppatori di AWS HealthLake.

L’esempio di codice seguente mostra come utilizzare describe-fhir-export-job.

AWS CLI

Come descrivere un processo di esportazione FHIR

Nell’esempio seguente describe-fhir-export-job cerca le proprietà di un processo di esportazione FHIR in AWS HealthLake.

aws healthlake describe-fhir-export-job \
    --datastore-id (Data store ID) \
    --job-id 9b9a51943afaedd0a8c0c26c49135a31

Output:

{
    "ExportJobProperties": {
        "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
        "JobStatus": "IN_PROGRESS",
        "JobId": "9009813e9d69ba7cf79bcb3468780f16",
        "SubmitTime": "2024-11-20T11:31:46.672000-05:00",
        "EndTime": "2024-11-20T11:34:01.636000-05:00",
        "OutputDataConfig": {
            "S3Configuration": {
            "S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
            "KmsKeyId": "arn:aws:kms:us-east-1:012345678910:key/d330e7fc-b56c-4216-a250-f4c43ef46e83"
        }

        },
        "DatastoreId": "(Data store ID)"
    }
}

Per ulteriori informazioni, consulta Exporting files from a FHIR data store nella Guida per sviluppatori di AWS HealthLake.

L’esempio di codice seguente mostra come utilizzare describe-fhir-import-job.

AWS CLI

Come descrivere un processo di importazione FHIR

Nell’esempio seguente describe-fhir-import-job recupera le proprietà di un processo di importazione FHIR utilizzando AWS HealthLake.

aws healthlake describe-fhir-import-job \
    --datastore-id (Data store ID) \
    --job-id c145fbb27b192af392f8ce6e7838e34f

Output:

{
    "ImportJobProperties": {
    "InputDataConfig": {
        "S3Uri": "s3://(Bucket Name)/(Prefix Name)/"
        { "arrayitem2": 2 }
    },
    "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
    "JobStatus": "COMPLETED",
    "JobId": "c145fbb27b192af392f8ce6e7838e34f",
    "SubmitTime": 1606272542.161,
    "EndTime": 1606272609.497,
    "DatastoreId": "(Data store ID)"
    }
}

Per ulteriori informazioni, consulta Importing files from a FHIR data store nella Guida per sviluppatori di AWS HealthLake.

L’esempio di codice seguente mostra come utilizzare list-fhir-datastores.

AWS CLI

Come elencare i datastore FHIR

Nell’esempio seguente del comando list-fhir-datastores viene mostrato come utilizzare il comando e come gli utenti possono filtrare i risultati in base allo stato del datastore in AWS HealthLake.

aws healthlake list-fhir-datastores \
    --filter DatastoreStatus=ACTIVE

Output:

{
    "DatastorePropertiesList": [
    {
        "PreloadDataConfig": {
            "PreloadDataType": "SYNTHEA"
        },
        "SseConfiguration": {
            "KmsEncryptionConfig": {
                "CmkType": "CUSTOMER_MANAGED_KMS_KEY",
                "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
            }
        },
        "DatastoreName": "Demo",
        "DatastoreArn": "arn:aws:healthlake:us-east-1:<AWS Account ID>:datastore/<Data store ID>",
        "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Data store ID>/r4/",
        "DatastoreStatus": "ACTIVE",
        "DatastoreTypeVersion": "R4",
        "CreatedAt": 1603761064.881,
        "DatastoreId": "<Data store ID>",
        "IdentityProviderConfiguration": {
            "AuthorizationStrategy": "AWS_AUTH",
            "FineGrainedAuthorizationEnabled": false
        }
    }
    ]
}

Per ulteriori informazioni, consulta Creating and monitoring a FHIR data store nella Guida per sviluppatori di AWS HealthLake.

  • Per informazioni dettagliate sull’API, consulta ListFHIRDatastores in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-fhir-export-jobs.

AWS CLI

Come elencare tutti i processi di esportazione FHIR

Nell’esempio seguente del comando list-fhir-export-jobs viene mostrato come utilizzare il comando per visualizzare un elenco di processi di esportazione associati a un account.

aws healthlake list-fhir-export-jobs \
    --datastore-id (Data store ID) \
    --submitted-before (DATE like 2024-10-13T19:00:00Z)\
    --submitted-after (DATE like 2020-10-13T19:00:00Z )\
    --job-name "FHIR-EXPORT" \
    --job-status SUBMITTED  \
    --max-results (Integer between 1 and 500)

Output:

{
    "ExportJobPropertiesList": [
        {
            "ExportJobProperties": {
                "OutputDataConfig": {
                    "S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
                    "S3Configuration": {
                        "S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
                        "KmsKeyId": "(KmsKey Id)"
                    }
                },
                "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
                "JobStatus": "COMPLETED",
                "JobId": "c145fbb27b192af392f8ce6e7838e34f",
                "JobName": "FHIR-EXPORT",
                "SubmitTime": "2024-11-20T11:31:46.672000-05:00",
                "EndTime": "2024-11-20T11:34:01.636000-05:00",
                "DatastoreId": "(Data store ID)"
            }
        }
    ]
}

Per ulteriori informazioni, consulta Exporting files from a FHIR data store nella Guida per sviluppatori di AWS HealthLake.

  • Per informazioni dettagliate sull’API, consulta ListFHIRExportJobs in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-fhir-import-jobs.

AWS CLI

Come elencare tutti i processi di importazione FHIR

Nell’esempio seguente del comando list-fhir-import-jobs viene mostrato come utilizzare il comando per visualizzare un elenco di tutti i processi di importazione associati a un account.

aws healthlake list-fhir-import-jobs \
    --datastore-id (Data store ID) \
    --submitted-before (DATE like 2024-10-13T19:00:00Z) \
    --submitted-after (DATE like 2020-10-13T19:00:00Z ) \
    --job-name "FHIR-IMPORT" \
    --job-status SUBMITTED  \
    -max-results (Integer between 1 and 500)

Output:

{
    "ImportJobPropertiesList": [
        {
            "JobId": "c0fddbf76f238297632d4aebdbfc9ddf",
            "JobStatus": "COMPLETED",
            "SubmitTime": "2024-11-20T10:08:46.813000-05:00",
            "EndTime": "2024-11-20T10:10:09.093000-05:00",
            "DatastoreId": "(Data store ID)",
            "InputDataConfig": {
                "S3Uri": "s3://(Bucket Name)/(Prefix Name)/"
            },
            "JobOutputDataConfig": {
                "S3Configuration": {
                    "S3Uri": "s3://(Bucket Name)/import/6407b9ae4c2def3cb6f1a46a0c599ec0-FHIR_IMPORT-c0fddbf76f238297632d4aebdbfc9ddf/",
                    "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/b7f645cb-e564-4981-8672-9e012d1ff1a0"
                }
            },
            "JobProgressReport": {
                "TotalNumberOfScannedFiles": 1,
                "TotalSizeOfScannedFilesInMB": 0.001798,
                "TotalNumberOfImportedFiles": 1,
                "TotalNumberOfResourcesScanned": 1,
                "TotalNumberOfResourcesImported": 1,
                "TotalNumberOfResourcesWithCustomerError": 0,
                "TotalNumberOfFilesReadWithCustomerError": 0,
                "Throughput": 0.0
            },
            "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)"
        }
    ]
}

Per ulteriori informazioni, consulta Importing files from a FHIR data store nella Guida per sviluppatori di AWS HealthLake.

  • Per informazioni dettagliate sull’API, consulta ListFHIRImportJobs in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-tags-for-resource.

AWS CLI

Come elencare i tag di un datastore

Nell’esempio seguente list-tags-for-resource elenca i tag associati al datastore specificato.

aws healthlake list-tags-for-resource \
    --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe"

Output:

{
    "tags": {
        "key": "value",
        "key1": "value1"
    }
}

Per ulteriori informazioni, consulta Tagging resources with AWS HealthLake nella Guida per sviluppatori di AWS HealthLake.

  • Per informazioni dettagliate sull'API, consulta ListTagsForResource nella Documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare start-fhir-export-job.

AWS CLI

Come avviare un processo di esportazione FHIR

Nell’esempio seguente del comando start-fhir-export-job viene mostrato come avviare un processo di esportazione FHIR in AWS HealthLake.

aws healthlake start-fhir-export-job \
    --output-data-config '{"S3Configuration": {"S3Uri":"s3://(Bucket Name)/(Prefix Name)/","KmsKeyId":"arn:aws:kms:us-east-1:012345678910:key/d330e7fc-b56c-4216-a250-f4c43ef46e83"}}' \
    --datastore-id (Data store ID) \
    --data-access-role-arn arn:aws:iam::(AWS Account ID):role/(Role Name)

Output:

{
    "DatastoreId": "(Data store ID)",
    "JobStatus": "SUBMITTED",
    "JobId": "9b9a51943afaedd0a8c0c26c49135a31"
}

Per ulteriori informazioni, consulta Exporting files from a FHIR data store nella Guida per sviluppatori di AWS HealthLake.

  • Per informazioni dettagliate sull’API, consulta StartFHIRExportJob in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare start-fhir-import-job.

AWS CLI

Come avviare un processo di importazione FHIR

Nell’esempio seguente del comando start-fhir-import-job viene mostrato come avviare un processo di importazione FHIR in AWS HealthLake.

aws healthlake start-fhir-import-job \
    --input-data-config S3Uri="s3://(Bucket Name)/(Prefix Name)/" \
    --job-output-data-config '{"S3Configuration": {"S3Uri":"s3://(Bucket Name)/(Prefix Name)/","KmsKeyId":"arn:aws:kms:us-east-1:012345678910:key/d330e7fc-b56c-4216-a250-f4c43ef46e83"}}' \
    --datastore-id (Data store ID) \
    --data-access-role-arn "arn:aws:iam::(AWS Account ID):role/(Role Name)"

Output:

{
    "DatastoreId": "(Data store ID)",
    "JobStatus": "SUBMITTED",
    "JobId": "c145fbb27b192af392f8ce6e7838e34f"
}

Per ulteriori informazioni, consulta Importing files from a FHIR data store nella Guida per sviluppatori di AWS HealthLake.

  • Per informazioni dettagliate sull’API, consulta StartFHIRImportJob in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare tag-resource.

AWS CLI

Come aggiungere un tag al datastore

Nell’esempio seguente tag-resource viene utilizzato per aggiungere un tag al datastore.

aws healthlake tag-resource \
    --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \
    --tags '[{"Key": "key1", "Value": "value1"}]'

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Adding a tag to a data store nella Guida per sviluppatori di AWS HealthLake.

  • Per informazioni dettagliate sulle API, consulta TagResource nel Riferimento ai comandi AWS CLI.

L’esempio di codice seguente mostra come utilizzare untag-resource.

AWS CLI

Come rimuovere i tag da un datastore

Nell’esempio seguente del comando untag-resource viene mostrato come rimuovere i tag da un datastore.

aws healthlake untag-resource \
    --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/b91723d65c6fdeb1d26543a49d2ed1fa" \
    --tag-keys '["key1"]'

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Removing tags from a data store nella Guida per sviluppatori di AWS HealthLake.

  • Per i dettagli dell'API, consulta UntagResource in Riferimento ai comandi della AWS CLI.