HealthLake exemples utilisant AWS CLI - AWS Command Line Interface
Actions

Cette documentation concerne AWS CLI uniquement la version 1 du. Pour la documentation relative à la version 2 du AWS CLI, consultez le guide de l'utilisateur de la version 2.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

HealthLake exemples utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du AWS Command Line Interface with HealthLake.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

L'exemple de code suivant montre comment utilisercreate-fhir-datastore.

AWS CLI

Exemple 1 : créer un magasin de données compatible SIGv4 HealthLake

L'create-fhir-datastoreexemple suivant montre comment créer un nouveau magasin de données dans AWS HealthLake.

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

Sortie :

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

Exemple 2 : créer un magasin de données compatible SMART sur FHIR HealthLake

L'create-fhir-datastoreexemple suivant montre comment créer un nouveau magasin de données compatible SMART on FHIR dans. 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

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

Sortie :

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

Pour plus d'informations, voir Création et surveillance d'un magasin de données FHIR dans le Guide du AWS HealthLake développeur.

L'exemple de code suivant montre comment utiliserdelete-fhir-datastore.

AWS CLI

Pour supprimer un magasin de données FHIR

L'delete-fhir-datastoreexemple suivant montre comment supprimer un magasin de données et tout son contenu dans AWS HealthLake.

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

Sortie :

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

Pour plus d'informations, voir Création et surveillance d'un magasin de données FHIR < https://docs.aws.amazon.com/healthlake/ latest/devguide/working -with-fhir-healthlake.html> dans le guide du développeur.AWS HealthLake

L'exemple de code suivant montre comment utiliserdescribe-fhir-datastore.

AWS CLI

Pour décrire un magasin de données FHIR

L'describe-fhir-datastoreexemple suivant montre comment rechercher les propriétés d'un magasin de données dans AWS HealthLake.

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

Sortie :

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

Pour plus d'informations, voir Création et surveillance d'un magasin de données FHIR dans le Guide du AWS HealthLake développeur.

L'exemple de code suivant montre comment utiliserdescribe-fhir-export-job.

AWS CLI

Pour décrire une tâche d'exportation FHIR

L'describe-fhir-export-jobexemple suivant montre comment rechercher les propriétés d'une tâche d'exportation FHIR dans AWS HealthLake.

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

Sortie :

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

Pour plus d'informations, consultez la section Exportation de fichiers depuis un magasin de données FHIR dans le Guide du AWS HealthLake développeur.

L'exemple de code suivant montre comment utiliserdescribe-fhir-import-job.

AWS CLI

Pour décrire une tâche d'importation FHIR

L'describe-fhir-import-jobexemple suivant montre comment apprendre les propriétés d'une tâche d'importation FHIR à l'aide AWS HealthLake de.

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

Sortie :

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

Pour plus d'informations, consultez la section Importation de fichiers dans un magasin de données FHIR dans le Guide du AWS HealthLake développeur.

L'exemple de code suivant montre comment utiliserlist-fhir-datastores.

AWS CLI

Pour répertorier les magasins de données FHIR

L'list-fhir-datastoresexemple suivant montre comment utiliser la commande et comment les utilisateurs peuvent filtrer les résultats en fonction de l'état du magasin de données dans AWS HealthLake.

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

Sortie :

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

Pour plus d'informations, voir Création et surveillance d'un magasin de données FHIR dans le Guide du AWS HealthLake développeur.

L'exemple de code suivant montre comment utiliserlist-fhir-export-jobs.

AWS CLI

Pour répertorier tous les emplois d'exportation FHIR

L'list-fhir-export-jobsexemple suivant montre comment utiliser la commande pour afficher la liste des tâches d'exportation associées à un compte.

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)

Sortie :

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

Pour plus d'informations, consultez la section Exportation de fichiers depuis un magasin de données FHIR dans le Guide du AWS HealthLake développeur.

L'exemple de code suivant montre comment utiliserlist-fhir-import-jobs.

AWS CLI

Pour répertorier toutes les tâches d'importation FHIR

L'list-fhir-import-jobsexemple suivant montre comment utiliser la commande pour afficher la liste de toutes les tâches d'importation associées à un compte.

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)

Sortie :

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

Pour plus d'informations, consultez la section Importation de fichiers dans le magasin de données FHIR dans le guide du AWS HealthLake développeur.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier les balises d'un magasin de données

L'list-tags-for-resourceexemple suivant répertorie les balises associées au magasin de données spécifié. :

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

Sortie :

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

Pour plus d'informations, consultez la section consacrée au balisage des ressources AWS HealthLake dans le guide du AWS HealthLake développeur.

  • Pour plus de détails sur l'API, voir ListTagsForResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-fhir-export-job.

AWS CLI

Pour démarrer une tâche d'exportation FHIR

L'start-fhir-export-jobexemple suivant montre comment démarrer une tâche d'exportation FHIR en utilisant 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)

Sortie :

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

Pour plus d'informations, consultez la section Exportation de fichiers depuis un magasin de données FHIR dans le Guide du AWS HealthLake développeur.

L'exemple de code suivant montre comment utiliserstart-fhir-import-job.

AWS CLI

Pour démarrer une tâche d'importation FHIR

L'start-fhir-import-jobexemple suivant montre comment démarrer une tâche d'importation FHIR en utilisant 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)"

Sortie :

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

Pour plus d'informations, consultez la section Importation de fichiers dans un magasin de données FHIR dans le Guide du AWS HealthLake développeur.

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour ajouter une balise au magasin de données

L'tag-resourceexemple suivant montre comment ajouter une balise à un magasin de données.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Ajout d'une balise à un magasin de données dans le Guide du AWS HealthLake développeur. .

  • Pour plus de détails sur l'API, voir TagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer des balises d'un magasin de données.

L'untag-resourceexemple suivant montre comment supprimer des balises d'un magasin de données.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Suppression de balises d'un magasin de données dans le Guide du AWS HealthLake développeur.

  • Pour plus de détails sur l'API, voir UntagResourcela section Référence des AWS CLI commandes.