View a markdown version of this page

HealthLake ejemplos que utilizan AWS CLI - AWS Ejemplos de código de SDK
Acciones

Hay más ejemplos de AWS SDK disponibles en el GitHub repositorio de ejemplos de AWS Doc SDK.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

HealthLake ejemplos que utilizan AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso del AWS Command Line Interface with HealthLake.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.

En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.

Acciones

En el siguiente ejemplo de código, se muestra cómo utilizar create-fhir-datastore.

AWS CLI

Ejemplo 1: Crear un almacén de datos SigV4-enabled HealthLake

El siguiente create-fhir-datastore ejemplo muestra cómo crear un nuevo banco de datos en AWS HealthLake.

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

Salida:

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

Ejemplo 2: Crear un SMART en un almacén FHIR-enabled HealthLake de datos

El siguiente create-fhir-datastore ejemplo muestra cómo crear un nuevo SMART on FHIR-enabled data store en 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

Contenido 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\"]}"
}

Salida:

{
    "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 obtener más información, consulte Creación y supervisión de un banco de datos del FHIR en la Guía para AWS HealthLake desarrolladores.

  • Para obtener información sobre la API, consulte CreateFHIRDatastore en la Referencia de comandos de la AWS CLI .

En el siguiente ejemplo de código, se muestra cómo utilizar delete-fhir-datastore.

AWS CLI

Eliminación de un almacén de datos de FHIR

En el siguiente delete-fhir-datastore ejemplo se muestra cómo eliminar un almacén de datos y todo su contenido. AWS HealthLake

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

Salida:

{
    "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 obtener más información, consulte Creación y supervisión de un banco de datos del FHIR < https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html > en la Guía para AWS HealthLake desarrolladores.

  • Para obtener información sobre la API, consulte DeleteFHIRDatastore en la Referencia de comandos de la AWS CLI .

En el siguiente ejemplo de código, se muestra cómo utilizar describe-fhir-datastore.

AWS CLI

Descripción de un almacén de datos de FHIR

En el siguiente describe-fhir-datastore ejemplo se muestra cómo encontrar las propiedades de un banco de datos en. AWS HealthLake

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

Salida:

{
    "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 obtener más información, consulte Creación y supervisión de un banco de datos del FHIR en la Guía para AWS HealthLake desarrolladores.

  • Para obtener información sobre la API, consulte DescribeFHIRDatastore en la Referencia de comandos de la AWS CLI .

En el siguiente ejemplo de código, se muestra cómo utilizar describe-fhir-export-job.

AWS CLI

Para describir un trabajo de exportación de FHIR

El siguiente describe-fhir-export-job ejemplo muestra cómo encontrar las propiedades de un trabajo de exportación FHIR en. AWS HealthLake

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

Salida:

{
    "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 obtener más información, consulte Exportación de archivos desde un banco de datos del FHIR en la Guía para AWS HealthLake desarrolladores.

  • Para obtener más información sobre la API, consulte DescribeFHIRExportJobla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar describe-fhir-import-job.

AWS CLI

Para describir un trabajo de importación de FHIR

El siguiente describe-fhir-import-job ejemplo muestra cómo aprender las propiedades de un trabajo de importación FHIR utilizando. AWS HealthLake

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

Salida:

{
    "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 obtener más información, consulte Importación de archivos a un banco de datos del FHIR en la Guía para AWS HealthLake desarrolladores.

  • Para obtener más información sobre la API, consulte DescribeFHIRImportJobla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar list-fhir-datastores.

AWS CLI

Muestra de los almacenes de datos de FHIR

El siguiente list-fhir-datastores ejemplo muestra cómo utilizar el comando y cómo los usuarios pueden filtrar los resultados en función del estado del almacén de datos en. AWS HealthLake

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

Salida:

{
    "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 obtener más información, consulte Creación y supervisión de un banco de datos del FHIR en la Guía para AWS HealthLake desarrolladores.

  • Para obtener información sobre la API, consulte ListFHIRDatastores en la Referencia de comandos de la AWS CLI .

En el siguiente ejemplo de código, se muestra cómo utilizar list-fhir-export-jobs.

AWS CLI

Para enumerar todos los trabajos de exportación de FHIR

En el siguiente ejemplo de list-fhir-export-jobs, se muestra cómo utilizar el comando para ver una lista de trabajos de exportación asociados a una cuenta.

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)

Salida:

{
    "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 obtener más información, consulte Exportación de archivos desde un banco de datos del FHIR en la Guía para desarrolladores. AWS HealthLake

  • Para obtener más información sobre la API, consulte ListFHIRExportJobsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar list-fhir-import-jobs.

AWS CLI

Para enumerar todos los trabajos de importación de FHIR

En el siguiente ejemplo de list-fhir-import-jobs, se muestra cómo utilizar el comando para ver una lista de todos los trabajos de importación asociados a una cuenta.

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)

Salida:

{
    "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 obtener más información, consulte Importación de archivos al almacén de datos del FHIR en la Guía para desarrolladores. AWS HealthLake

  • Para obtener más información sobre la API, consulte ListFHIRImportJobsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar list-tags-for-resource.

AWS CLI

Muestra de las etiquetas para un almacén de datos

En el siguiente ejemplo de list-tags-for-resource, se muestran las etiquetas asociadas al almacén de datos especificado:

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

Salida:

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

Para obtener más información, consulta Cómo etiquetar los recursos AWS HealthLake en la Guía para AWS HealthLake desarrolladores.

  • Para obtener más información sobre la API, consulte ListTagsForResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar start-fhir-export-job.

AWS CLI

Para iniciar un trabajo de exportación de FHIR

El siguiente start-fhir-export-job ejemplo muestra cómo iniciar un trabajo de exportación del FHIR utilizando. 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)

Salida:

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

Para obtener más información, consulte Exportación de archivos desde un banco de datos del FHIR en la Guía para AWS HealthLake desarrolladores.

  • Para obtener más información sobre la API, consulte StartFHIRExportJobla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar start-fhir-import-job.

AWS CLI

Para iniciar un trabajo de importación de FHIR

El siguiente start-fhir-import-job ejemplo muestra cómo iniciar un trabajo de importación de FHIR utilizando. 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)"

Salida:

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

Para obtener más información, consulte Importación de archivos a un banco de datos del FHIR en la Guía para AWS HealthLake desarrolladores.

  • Para obtener más información sobre la API, consulte StartFHIRImportJobla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar tag-resource.

AWS CLI

Agregación de una etiqueta al almacén de datos

En el siguiente ejemplo de tag-resource, se muestra cómo agregar una etiqueta a un almacén de datos.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Añadir una etiqueta a un banco de datos en la Guía para AWS HealthLake desarrolladores. .

  • Para obtener más información sobre la API, consulte TagResourcela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar untag-resource.

AWS CLI

Eliminación de etiquetas de un almacén de datos.

En el siguiente ejemplo de untag-resource, se muestra cómo eliminar etiquetas de un almacén de datos.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Eliminar etiquetas de un banco de datos en la Guía para AWS HealthLake desarrolladores.

  • Para obtener más información sobre la API, consulte UntagResourcela Referencia de AWS CLI comandos.