Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
# Esportazione di HealthLake dati con FHIR `$export`
Puoi esportare i dati in blocco dal tuo archivio HealthLake dati utilizzando l'operazione FHIR $export. HealthLake supporta l'utilizzo e le richieste di FHIR`$export`. `POST` `GET` Per effettuare una richiesta di esportazione`POST`, devi disporre di un utente, gruppo o ruolo IAM con le autorizzazioni richieste, specificarlo `$export` come parte della richiesta e includere i parametri desiderati nel corpo della richiesta.
**Nota**
Tutte le richieste di HealthLake esportazione effettuate utilizzando FHIR `$export` vengono restituite in `ndjson` formato ed esportate in un bucket Amazon S3, dove ogni oggetto Amazon S3 contiene un solo tipo di risorsa FHIR.
Puoi mettere in coda le richieste di esportazione in base alle quote di servizio dell'account. AWS Per ulteriori informazioni, consulta [Service Quotas](reference-healthlake-endpoints-quotas.md#reference-healthlake-quotas).
HealthLake supporta i seguenti tre tipi di richieste endpoint di esportazione in blocco.
**HealthLake tipi in blocco `$export`**
| Tipo di esportazione | Description | Sintassi |
| --- | --- | --- |
| Sistema | Esporta tutti i dati dal server HealthLake FHIR. | `POST https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/$export` |
| Tutti i pazienti | Esporta tutti i dati relativi a tutti i pazienti, compresi i tipi di risorse associati al tipo di risorsa Paziente. | `POST https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/Patient/$export`
`GET https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/Patient/$export` |
| Gruppo di pazienti | Esporta tutti i dati relativi a un gruppo di pazienti specificato con un ID di gruppo. | `POST https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/Group/{{id}}/$export`
`GET https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/Group/{{id}}/$export` |
## Prima di iniziare
Soddisfa i seguenti requisiti per effettuare una richiesta di esportazione utilizzando l'API REST FHIR per HealthLake.
+ È necessario aver impostato un utente, un gruppo o un ruolo con le autorizzazioni necessarie per effettuare la richiesta di esportazione. Per ulteriori informazioni, consulta [Autorizzazione di una richiesta `$export`](#export-rest-auth).
+ Devi aver creato un ruolo di servizio che garantisca HealthLake l'accesso al bucket Amazon S3 in cui desideri esportare i tuoi dati. Il ruolo di servizio deve inoltre essere specificato HealthLake come principale del servizio. Per ulteriori informazioni sulla configurazione delle autorizzazioni, vedere[Impostazione delle autorizzazioni per i lavori di esportazione](getting-started-setting-up.md#setting-up-export-permissions).
## Autorizzazione di una richiesta `$export`
Per effettuare correttamente una richiesta di esportazione utilizzando l'API REST FHIR, autorizza il tuo utente, gruppo o ruolo utilizzando IAM o .0. OAuth2 È inoltre necessario avere un ruolo di servizio.
**Autorizzazione di una richiesta tramite IAM**
Quando effettui una `$export` richiesta, l'utente, il gruppo o il ruolo devono includere azioni IAM nella policy. Per ulteriori informazioni, consulta [Impostazione delle autorizzazioni per i lavori di esportazione](getting-started-setting-up.md#setting-up-export-permissions).
**Autorizzazione di una richiesta utilizzando SMART on FHIR (2.0) OAuth**
Quando si effettua una `$export` richiesta su un HealthLake data store compatibile con SMART on FHIR, è necessario assegnare gli ambiti appropriati. Per ulteriori informazioni, consulta [SMART sugli ambiti di risorse FHIR per HealthLake](reference-smart-on-fhir-oauth-scopes.md#smart-on-fhir-scopes-rest).
**Nota**
Le FHIR `$export` con `GET` richieste richiedono lo stesso metodo di autenticazione o lo stesso token portatore (nel caso di SMART su FHIR) per richiedere l'esportazione e il recupero dei file. I file esportati utilizzando FHIR `$export` con `GET` sono disponibili per il download per 48 ore.
## Effettuare una richiesta `$export`
Questa sezione descrive i passaggi necessari da eseguire quando si effettua una richiesta di esportazione utilizzando l'API REST FHIR.
Per evitare addebiti accidentali sul tuo AWS account, ti consigliamo di testare le tue richieste effettuando una `POST` richiesta senza fornire la `$export` sintassi.
Per effettuare la richiesta, devi fare quanto segue:
1. Specificare `$export` nell'URL della `POST` richiesta per un endpoint supportato.
1. Specificate i parametri di intestazione richiesti.
1. Specificate un corpo della richiesta che definisca i parametri richiesti.
### Passo 1: Specificare `$export` nell'URL della `POST` richiesta un [endpoint](reference-healthlake-endpoints-quotas.md#reference-healthlake-endpoints) supportato.
HealthLake supporta tre tipi di richieste endpoint di esportazione in blocco. Per effettuare una richiesta di esportazione in blocco, è necessario effettuare una richiesta `POST` basata su uno dei tre endpoint supportati. Gli esempi seguenti mostrano dove specificare `$export` nell'URL della richiesta.
+ `POST https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/$export`
+ `POST https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/Patient/$export`
+ `POST https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/Group/{{id}}/$export`
È possibile utilizzare i seguenti parametri di ricerca supportati nella stringa di `POST` richiesta.
#### Parametri di ricerca supportati
HealthLake supporta i seguenti modificatori di ricerca nelle richieste di esportazione in blocco.
I seguenti esempi includono caratteri speciali che devono essere codificati prima di inviare la richiesta.
| Nome | Obbligatorio? | Description | Esempio |
| --- | --- | --- | --- |
| \_outputFormat | No | Il formato per i file Bulk Data richiesti da generare. I valori accettati sonoapplication/fhir\+ndjson,application/ndjson,ndjson. | |
| \_type | No | Una stringa di tipi di risorse FHIR delimitati da virgole da includere nel processo di esportazione. Ti consigliamo di includerla \_type perché ciò può avere un impatto sui costi quando tutte le risorse vengono esportate. | &\_type=MedicationStatement, Observation |
| \_since | No | Tipi di risorse modificati in o dopo la data e l'ora. Se un tipo di risorsa non ha l'ora dell'ultimo aggiornamento, verranno inclusi nella risposta. | &\_since=2024-05-09T00%3A00%3A00Z |
| \_until | No | Tipi di risorse modificati in data e ora o prima. Utilizzato in combinazione con \_since per definire un intervallo di tempo specifico per l'esportazione. Se un tipo di risorsa non ha un'ora dell'ultimo aggiornamento, verrà escluso dalla risposta. | &\_until=2024-12-31T23%3A59%3A59Z |
| \_security | No | Filtra le risorse esportate in base ai valori di meta.security codifica. Usa il formato. system\|code Quando vengono forniti più valori, le risorse devono corrispondere a tutti (e alla semantica). Usa system\| (trailing pipe, no code) per abbinare qualsiasi codice di un determinato sistema. | &\_security=https://myorg.com/tenant%7Cclinic-A |
| \_tag | No | Filtra le risorse esportate in base ai valori di meta.tag codifica. Utilizza lo stesso system\|code formato e la stessa semantica AND di. \_security Quando \_tag vengono specificati entrambi \_security i filtri, le risorse devono corrispondere a entrambi i filtri. | &\_tag=https://myorg.com/dept%7Ccardiology |
### Fase 2: Specificare i parametri di intestazione richiesti
Per effettuare una richiesta di esportazione utilizzando l'API REST FHIR, è necessario specificare i seguenti parametri di intestazione.
+ Tipo di contenuto: `application/fhir+json`
+ Preferisco: `respond-async`
Successivamente, è necessario specificare gli elementi richiesti nel corpo della richiesta.
### Fase 3: Specificare un corpo della richiesta e definire i parametri richiesti.
La richiesta di esportazione richiede anche un corpo in `JSON` formato. Il corpo può includere i seguenti parametri.
| Chiave | Obbligatorio? | Description | Valore |
| --- | --- | --- | --- |
| DataAccessRoleArn | Sì | Un ARN di un ruolo di HealthLake servizio. Il ruolo di servizio utilizzato deve essere specificato HealthLake come principale del servizio. | arn:aws:iam::444455556666:role/your-healthlake-service-role |
| JobName | No | Il nome della richiesta di esportazione. | your-export-job-name |
| S3Uri | Sì | Parte di una OutputDataConfig chiave. L'URI S3 del bucket di destinazione in cui verranno scaricati i dati esportati. | s3://amzn-s3-demo-bucket/EXPORT-JOB/ |
| KmsKeyId | Sì | Parte di una chiave. OutputDataConfig L'ARN della AWS KMS chiave utilizzata per proteggere il bucket Amazon S3. | arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab |
**Example Corpo di una richiesta di esportazione effettuata utilizzando l'API REST FHIR**
Per effettuare una richiesta di esportazione utilizzando l'API REST FHIR, è necessario specificare un corpo, come illustrato di seguito.
```
{
"DataAccessRoleArn": "arn:aws:iam::444455556666:role/your-healthlake-service-role",
"JobName": "your-export-job",
"OutputDataConfig": {
"S3Configuration": {
"S3Uri": "s3://amzn-s3-demo-bucket/EXPORT-JOB",
"KmsKeyId": "arn:aws:kms:region-of-bucket:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab"
}
}
}
```
Quando la richiesta avrà esito positivo, riceverai la seguente risposta.
*Intestazione della risposta*
```
content-location: https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/export/your-export-request-job-id
```
*Corpo di risposta*
```
{
"datastoreId": "your-data-store-id",
"jobStatus": "SUBMITTED",
"jobId": "your-export-request-job-id"
}
```
## Gestione della richiesta di esportazione
Dopo aver effettuato una richiesta di esportazione corretta, puoi gestirla descrivendo `$export` lo stato di una richiesta di esportazione corrente e `$export` annullando una richiesta di esportazione corrente.
Quando annulli una richiesta di esportazione utilizzando l'API REST, ti viene fatturata solo la parte dei dati che sono stati esportati fino al momento in cui hai inviato la richiesta di annullamento.
I seguenti argomenti descrivono come visualizzare lo stato o annullare una richiesta di esportazione corrente.
### Annullamento di una richiesta di esportazione
Per annullare una richiesta di esportazione, effettua una `DELETE` richiesta e fornisci l'ID del lavoro nell'URL della richiesta.
```
DELETE https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/export/your-export-request-job-id
```
Quando la richiesta ha esito positivo, riceverai quanto segue.
```
{
"exportJobProperties": {
"jobId": "your-original-export-request-job-id",
"jobStatus": "CANCEL_SUBMITTED",
"datastoreId": "your-data-store-id"
}
}
```
Quando la tua richiesta non va a buon fine, ricevi quanto segue.
```
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "error",
"code": "not-supported",
"diagnostics": "Interaction not supported."
}
]
}
```
### Descrizione di una richiesta di esportazione
Per conoscere lo stato di una richiesta di esportazione, effettua una `GET` richiesta utilizzando `export` and your`export-request-job-id`.
```
GET https://healthlake.{{region}}.amazonaws.com/datastore/{{datastoreId}}/r4/export/your-export-request-id
```
La risposta JSON conterrà un `ExportJobProperties` oggetto. Può contenere le seguenti coppie chiave:valore.
| Nome | Obbligatorio? | Description | Valore |
| --- | --- | --- | --- |
| DataAccessRoleArn | No | Un ARN di un ruolo di HealthLake servizio. Il ruolo di servizio utilizzato deve essere specificato HealthLake come principale del servizio. | arn:aws:iam::444455556666:role/your-healthlake-service-role |
| SubmitTime | No | La data e l'ora in cui è stato inviato un processo di esportazione. | Apr 21, 2023 5:58:02 |
| EndTime | No | L'ora in cui è stato completato un processo di esportazione. | Apr 21, 2023 6:00:08 PM |
| JobName | No | Il nome della richiesta di esportazione. | your-export-job-name |
| JobStatus | No | | I valori validi sono:SUBMITTED | IN_PROGRESS | COMPLETED_WITH_ERRORS | COMPLETED |
FAILED
|
| S3Uri | Sì | Parte di un [OutputDataConfig](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_OutputDataConfig.html)oggetto. L'URI Amazon S3 del bucket di destinazione in cui verranno scaricati i dati esportati. | s3://amzn-s3-demo-bucket/EXPORT-JOB/ |
| KmsKeyId | Sì | Parte di un oggetto. [OutputDataConfig](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_OutputDataConfig.html) L'ARN della AWS KMS chiave utilizzata per proteggere il bucket Amazon S3. | arn:aws:kms:region-of-bucket:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab |
**Example : corpo di una richiesta di descrizione dell'esportazione effettuata utilizzando l'API REST FHIR**
In caso di successo, riceverai la seguente risposta JSON.
```
{
"exportJobProperties": {
"jobId": "your-export-request-id",
"JobName": "your-export-job",
"jobStatus": "SUBMITTED",
"submitTime": "Apr 21, 2023 5:58:02 PM",
"endTime": "Apr 21, 2023 6:00:08 PM",
"datastoreId": "your-data-store-id",
"outputDataConfig": {
"s3Configuration": {
"S3Uri": "s3://amzn-s3-demo-bucket/EXPORT-JOB",
"KmsKeyId": "arn:aws:kms:region-of-bucket:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab""
}
},
"DataAccessRoleArn": "arn:aws:iam::444455556666:role/your-healthlake-service-role",
}
}
```