Beispiele für die Verwendung der AWS CLI mit HealthLake

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit HealthLake nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Aktionen

Das folgende Codebeispiel zeigt, wie create-fhir-datastore verwendet wird.

AWS CLI

Beispiel 1: So erstellen Sie einen SigV4-fähigen HealthLake-Datenspeicher

Das folgende create-fhir-datastore-Beispiel zeigt, wie Sie einen neuen Datenspeicher in AWS-HealthLake erstellen.


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

Ausgabe:


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

Beispiel 2: So erstellen Sie einen HealthLake-Datenspeicher, der SMART on FHIR unterstützt

Das folgende create-fhir-datastore-Beispiel zeigt, wie Sie einen neuen Datenspeicher in AWS-HealthLake erstellen, der SMART on FHIR unterstützt.


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

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

Ausgabe:


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

Weitere Informationen finden Sie unter Erstellen und Überwachen eines FHIR-Datenspeichers im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter CreateFHIRDatastore in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-fhir-datastore verwendet wird.

AWS CLI

So löschen Sie einen FHIR-Datenspeicher

Im folgenden delete-fhir-datastore-Beispiel wird gezeigt, wie Sie einen Datenspeicher und seinen gesamten Inhalt in AWS HealthLake löschen.


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

Ausgabe:


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

Weitere Informationen finden Sie unter „Erstellen und Überwachen eines FHIR-Datenspeichers“ <https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html> im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter DeleteFHIRDatastore in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-fhir-datastore verwendet wird.

AWS CLI

So beschreiben Sie einen FHIR-Datenspeicher

Das folgende describe-fhir-datastore-Beispiel zeigt, wie Sie die Eigenschaften eines Datenspeichers in AWS HealthLake finden.


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

Ausgabe:


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

Weitere Informationen finden Sie unter Erstellen und Überwachen eines FHIR-Datenspeichers im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter DescribeFHIRDatastore in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-fhir-export-job verwendet wird.

AWS CLI

So beschreiben Sie einen FHIR-Exportjob

Das folgende describe-fhir-export-job-Beispiel zeigt, wie Sie die Eigenschaften eines FHIR-Exportjobs in AWS HealthLake finden.


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

Ausgabe:


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

Weitere Informationen finden Sie unter Exportieren von Dateien aus einem FHIR-Datenspeicher im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter DescribeFHIRExportJob in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-fhir-import-job verwendet wird.

AWS CLI

So beschreiben Sie einen FHIR-Importjob

Das folgende describe-fhir-import-job-Beispiel zeigt, wie Sie die Eigenschaften eines FHIR-Importjobs mit AWS HealthLake finden.


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

Ausgabe:


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

Weitere Informationen finden Sie unter Importieren von Dateien in einen FHIR-Datenspeicher im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter DescribeFHIRImportJob in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-fhir-datastores verwendet wird.

AWS CLI

So listen Sie FHIR-Datenspeicher auf

Das folgende list-fhir-datastores-Beispiel zeigt, wie Sie den Befehl verwenden und wie Benutzer Ergebnisse basierend auf dem Datenspeicherstatus in AWS HealthLake filtern können.


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

Ausgabe:


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

Weitere Informationen finden Sie unter Erstellen und Überwachen eines FHIR-Datenspeichers im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter ListFHIRDatastores in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-fhir-export-jobs verwendet wird.

AWS CLI

So listen Sie alle FHIR-Exportjobs auf

Das folgende list-fhir-export-jobs-Beispiel zeigt, wie Sie mit dem Befehl eine Liste von Exportjobs anzeigen, die mit einem Konto verknüpft sind.


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)

Ausgabe:


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

Weitere Informationen finden Sie unter Exportieren von Dateien aus einem FHIR-Datenspeicher im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter ListFHIRExportJobs in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-fhir-import-jobs verwendet wird.

AWS CLI

So listen Sie alle FHIR-Importjobs auf

Das folgende list-fhir-import-jobs-Beispiel zeigt, wie Sie mit dem Befehl eine Liste aller Importjobs anzeigen, die mit einem Konto verknüpft sind.


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)

Ausgabe:


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

Weitere Informationen finden Sie unter Importieren von Dateien in einen FHIR-Datenspeicher im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter ListFHIRImportJobs in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-tags-for-resource verwendet wird.

AWS CLI

So listen Sie Tags für einen Datenspeicher auf

Das folgende list-tags-for-resource-Beispiel listet die Tags auf, die mit dem angegebenen Datenspeicher verknüpft sind:


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

Ausgabe:


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

Weitere Informationen finden Sie unter Markieren von Ressourcen in AWS HealthLake im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter ListTagsForResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie start-fhir-export-job verwendet wird.

AWS CLI

So starten Sie einen FHIR-Exportjob

Das folgende start-fhir-export-job-Beispiel zeigt, wie Sie einen FHIR-Exportjob mit AWS HealthLake starten.


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)

Ausgabe:


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

Weitere Informationen finden Sie unter Exportieren von Dateien aus einem FHIR-Datenspeicher im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter StartFHIRExportJob in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie start-fhir-import-job verwendet wird.

AWS CLI

So starten Sie einen FHIR-Importjob

Das folgende start-fhir-import-job-Beispiel zeigt, wie Sie einen FHIR-Importjob mit AWS HealthLake starten.


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

Ausgabe:


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

Weitere Informationen finden Sie unter Importieren von Dateien in einen FHIR-Datenspeicher im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter StartFHIRImportJob in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie tag-resource verwendet wird.

AWS CLI

So fügen Sie ein Tag zum Datenspeicher hinzu

Im folgenden tag-resource-Beispiel wird gezeigt, wie Sie ein Tag zu einem Datenspeicher hinzufügen.


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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Hinzufügen eines Tags zu einem Datenspeicher im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter TagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie untag-resource verwendet wird.

AWS CLI

So entfernen Sie Tags aus einem Datenspeicher.

Das folgende untag-resource-Beispiel zeigt, wie Sie Tags aus einem Datenspeicher entfernen.


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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Entfernen von Tags aus einem Datenspeicher im Entwicklerhandbuch zu AWS HealthLake.

API-Details finden Sie unter UntagResource in der AWS CLI-Befehlsreferenz.

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

HealthImaging

HealthOmics