HealthLake exemplos usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface with HealthLake.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

Ações

O código de exemplo a seguir mostra como usar create-fhir-datastore.

AWS CLI

Exemplo 1: Criar um armazenamento de dados habilitado para SIGv4 HealthLake

O create-fhir-datastore exemplo a seguir demonstra como criar um novo armazenamento de dados em AWS HealthLake.


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

Saída:


{
    "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)"
}

Exemplo 2: Crie um SMART no armazenamento de dados habilitado para FHIR HealthLake

O create-fhir-datastore exemplo a seguir demonstra como criar um novo SMART no armazenamento de dados habilitado para FHIR em. 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

Conteúdo de 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\"]}"
}

Saída:


{
    "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)"
}

Para obter mais informações, consulte Criação e monitoramento de um armazenamento de dados FHIR no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte Create FHIRDatastore in AWS CLI Command Reference.

O código de exemplo a seguir mostra como usar delete-fhir-datastore.

AWS CLI

Como excluir um datastore FHIR

O delete-fhir-datastore exemplo a seguir demonstra como excluir um armazenamento de dados e todo o seu conteúdo em AWS HealthLake.


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

Saída:


{
    "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)"
}

Para obter mais informações, consulte Criação e monitoramento de um armazenamento de dados FHIR < https://docs.aws.amazon.com/healthlake/ latest/devguide/working -with-FHIR-Healthlake.html> no Guia do desenvolvedor.AWS HealthLake

Para obter detalhes da API, consulte Excluir FHIRDatastore na Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-fhir-datastore.

AWS CLI

Como descrever um datastore FHIR

O describe-fhir-datastore exemplo a seguir demonstra como encontrar as propriedades de um armazenamento de dados em AWS HealthLake.


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

Saída:


{
    "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
        }
    }
}

Para obter mais informações, consulte Criação e monitoramento de um armazenamento de dados FHIR no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte Descrever FHIRDatastore na Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-fhir-export-job.

AWS CLI

Descrever um serviço de exportação do FHIR

O describe-fhir-export-job exemplo a seguir mostra como encontrar as propriedades de um trabalho de exportação FHIR em. AWS HealthLake


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

Saída:


{
    "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)"
    }
}

Para obter mais informações, consulte Exportação de arquivos de um armazenamento de dados FHIR no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte Descreve FHIRExport Job in AWS CLI Command Reference.

O código de exemplo a seguir mostra como usar describe-fhir-import-job.

AWS CLI

Descrever um serviço de importação do FHIR

O describe-fhir-import-job exemplo a seguir mostra como aprender as propriedades de uma tarefa de importação do FHIR usando. AWS HealthLake


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

Saída:


{
    "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)"
    }
}

Para obter mais informações, consulte Importação de arquivos para um armazenamento de dados FHIR no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte Descreve FHIRImport Job in AWS CLI Command Reference.

O código de exemplo a seguir mostra como usar list-fhir-datastores.

AWS CLI

Como listar datastores FHIR

O list-fhir-datastores exemplo a seguir mostra como usar o comando e como os usuários podem filtrar os resultados com base no status do armazenamento de dados em AWS HealthLake.


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

Saída:


{
    "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
        }
    }
    ]
}

Para obter mais informações, consulte Criação e monitoramento de um armazenamento de dados FHIR no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte Lista FHIRDatastores na Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-fhir-export-jobs.

AWS CLI

Listar todos os serviços de exportação do FHIR

O exemplo list-fhir-export-jobs a seguir mostra como usar o comando para exibir uma lista de serviços de exportação associados a uma conta.


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)

Saída:


{
    "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)"
            }
        }
    ]
}

Para obter mais informações, consulte Exportação de arquivos de um armazenamento de dados FHIR no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte Listar FHIRExport trabalhos na Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-fhir-import-jobs.

AWS CLI

Listar todos os serviços de importação do FHIR

O exemplo list-fhir-import-jobs a seguir mostra como usar o comando para visualizar uma lista de todos os serviços de importação associados a uma conta.


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)

Saída:


{
    "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)"
        }
    ]
}

Para obter mais informações, consulte Importação de arquivos para o armazenamento de dados FHIR no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte Listar FHIRImport trabalhos na Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Como listar tags para um datastore

O exemplo de list-tags-for-resource a seguir lista as tags associadas ao datastore especificado.


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

Saída:


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

Para obter mais informações, consulte Como marcar recursos AWS HealthLake no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte ListTagsForResourceem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar start-fhir-export-job.

AWS CLI

Iniciar um serviço de exportação do FHIR

O start-fhir-export-job exemplo a seguir mostra como iniciar um trabalho de exportação do FHIR usando o. 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)

Saída:


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

Para obter mais informações, consulte Exportação de arquivos de um armazenamento de dados FHIR no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte Start FHIRExport Job in AWS CLI Command Reference.

O código de exemplo a seguir mostra como usar start-fhir-import-job.

AWS CLI

Iniciar um trabalho de importação do FHIR

O start-fhir-import-job exemplo a seguir mostra como iniciar um trabalho de importação do FHIR usando o. 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)"

Saída:


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

Para obter mais informações, consulte Importação de arquivos para um armazenamento de dados FHIR no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte Start FHIRImport Job in AWS CLI Command Reference.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Como adicionar uma tag ao datastore

O exemplo de tag-resource a seguir mostra como adicionar uma tag a um datastore.


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

Este comando não produz saída.

Para obter mais informações, consulte Adicionar uma tag a um armazenamento de dados no Guia do AWS HealthLake desenvolvedor. .

Para obter detalhes da API, consulte TagResourceem Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Como remover tags de um datastore.

O exemplo de untag-resource a seguir mostra como remover tags de um datastore.


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

Este comando não produz saída.

Para obter mais informações, consulte Remoção de tags de um armazenamento de dados no Guia do AWS HealthLake desenvolvedor.

Para obter detalhes da API, consulte UntagResourceem Referência de AWS CLI Comandos.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

HealthImaging

HealthOmics