# Ejemplos de HealthLake que utilizan la AWS CLI
En los siguientes ejemplos de código, se muestra cómo realizar acciones e implementar escenarios comunes usando AWS Command Line Interface con 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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `create-fhir-datastore`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-fhir-datastore`.
**AWS CLI**
**Ejemplo 1: creación de un almacén de datos de HealthLake compatible con SigV4**
En el siguiente ejemplo de `create-fhir-datastore`, se muestra cómo crear un nuevo almacén 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: creación de SMART en un almacén de datos de HealthLake compatible con FHIR**
En el siguiente ejemplo de `create-fhir-datastore`, se muestra cómo crear un nuevo SMART en el almacén de datos habilitado por FHIR 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 almacén de datos de FHIR](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html) en la *Guía para desarrolladores de AWS HealthLake*.
+ Para obtener información sobre la API, consulte [CreateFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/create-fhir-datastore.html) en la *Referencia de comandos de la AWS CLI*.
### `delete-fhir-datastore`
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 ejemplo de `delete-fhir-datastore`, se muestra cómo eliminar un almacén de datos y todo su contenido en 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 almacén de datos de FHIR en la *Guía para desarrolladores de AWS HealthLake*.
+ Para obtener información sobre la API, consulte [DeleteFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/delete-fhir-datastore.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-fhir-datastore`
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 ejemplo de `describe-fhir-datastore`, se muestra cómo encontrar las propiedades de un almacén 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::datastore/",
"DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore//r4/",
"DatastoreStatus": "ACTIVE",
"DatastoreTypeVersion": "R4",
"CreatedAt": 1603761064.881,
"DatastoreId": "",
"IdentityProviderConfiguration": {
"AuthorizationStrategy": "AWS_AUTH",
"FineGrainedAuthorizationEnabled": false
}
}
}
```
Para obtener más información, consulte [Creación y supervisión de un almacén de datos de FHIR](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html) en la *Guía para desarrolladores de AWS HealthLake*.
+ Para obtener información sobre la API, consulte [DescribeFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-datastore.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-fhir-export-job`
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**
En el siguiente ejemplo de `describe-fhir-export-job`, se muestra cómo encontrar las propiedades de un trabajo de exportación de 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 de un almacén de datos de FHIR](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html) en la *Guía para desarrolladores de AWS HealthLake*.
+ Para obtener información sobre la API, consulte [DescribeFHIRExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-export-job.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-fhir-import-job`
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**
En el siguiente ejemplo de `describe-fhir-import-job`, se muestra cómo obtener información sobre las propiedades de un trabajo de importación de FHIR mediante 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 almacén de datos de FHIR](https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html) en la *Guía para desarrolladores de AWS HealthLake*.
+ Para obtener información sobre la API, consulte [DescribeFHIRImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-import-job.html) en la *Referencia de comandos de la AWS CLI*.
### `list-fhir-datastores`
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**
En el siguiente ejemplo de `list-fhir-datastores`, se muestra cómo utilizar el comando y de qué manera 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::datastore/",
"DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore//r4/",
"DatastoreStatus": "ACTIVE",
"DatastoreTypeVersion": "R4",
"CreatedAt": 1603761064.881,
"DatastoreId": "",
"IdentityProviderConfiguration": {
"AuthorizationStrategy": "AWS_AUTH",
"FineGrainedAuthorizationEnabled": false
}
}
]
}
```
Para obtener más información, consulte [Creación y supervisión de un almacén de datos de FHIR](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html) en la *Guía para desarrolladores de AWS HealthLake*.
+ Para obtener información sobre la API, consulte [ListFHIRDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-datastores.html) en la *Referencia de comandos de la AWS CLI*.
### `list-fhir-export-jobs`
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 de un almacén de datos de FHIR](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html) en la Guía para desarrolladores de AWS HealthLake.
+ Para obtener información sobre la API, consulte [ListFHIRExportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-export-jobs.html) en la *Referencia de comandos de la AWS CLI*.
### `list-fhir-import-jobs`
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 a un almacén de datos de FHIR](https://docs.aws.amazon.com/healthlake/latest/devguide/import-examples.html) en la Guía para desarrolladores de AWS HealthLake.
+ Para obtener información sobre la API, consulte [ListFHIRImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-import-jobs.html) en la *Referencia de comandos de la AWS CLI*.
### `list-tags-for-resource`
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, consulte [Etiquetado de recursos en AWS HealthLake](https://docs.aws.amazon.com/healthlake/latest/devguide/tagging.html) en la Guía para desarrolladores de AWS HealthLake.
+ Para ver los detalles de la API, consulte [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-tags-for-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `start-fhir-export-job`
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**
En el siguiente ejemplo de `start-fhir-export-job`, se muestra cómo empezar un trabajo de exportación de FHIR con 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 de un almacén de datos de FHIR](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html) en la *Guía para desarrolladores de AWS HealthLake*.
+ Para obtener información sobre la API, consulte [StartFHIRExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/start-fhir-export-job.html) en la *Referencia de comandos de la AWS CLI*.
### `start-fhir-import-job`
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**
En el siguiente ejemplo de `start-fhir-import-job`, se muestra cómo empezar un trabajo de importación de FHIR con 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 almacén de datos de FHIR](https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html) en la *Guía para desarrolladores de AWS HealthLake*.
+ Para obtener información sobre la API, consulte [StartFHIRImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/start-fhir-import-job.html) en la *Referencia de comandos de la AWS CLI*.
### `tag-resource`
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 [Agregación de una etiqueta a un almacén de datos](https://docs.aws.amazon.com/healthlake/latest/devguide/add-a-tag.html) en la *Guía para desarrolladores de AWS HealthLake*.
+ Para ver los detalles de la API, consulte [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/tag-resource.html) en la *Referencia de comandos de la AWS CLI*.
### `untag-resource`
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 [Eliminación de etiquetas de un almacén de datos](https://docs.aws.amazon.com/healthlake/latest/devguide/remove-tags.html) en la *Guía para desarrolladores de AWS HealthLake*.
+ Para ver los detalles de la API, consulte [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/untag-resource.html) en la *Referencia de comandos de la AWS CLI*.