Struttura dell'API

Questa pagina descrive la struttura di percorsi e operazioni dell'API Cloud Healthcare e il loro utilizzo per accedere ai dati e gestirli.

Panoramica

È possibile accedere e gestire i dati sanitari in set di dati e datastore utilizzando un'API REST che identifica ogni datastore utilizzando:

  • Un progetto Google Cloud
  • Una località Google Cloud
  • L'ID del set di dati
  • Il tipo di datastore
  • ID datastore

L'API implementa per l'accesso anche standard specifici della modalità che sono coerenti con quelli di settore per tale modalità.

Operazioni amministrative

È possibile eseguire operazioni amministrative sui set di dati e su tutti i datastore. Consistono principalmente nella creazione, nella lettura, nell'aggiornamento e nell'eliminazione di set di dati e datastore (CRUD). Le operazioni amministrative sono coerenti con la maggior parte delle API di Google Cloud (Google Cloud) e non richiedono il rispetto di specifici standard di modalità.

Ecco alcuni esempi di operazioni amministrative:

  • Creazione, eliminazione, recupero, elenco e modifica di set di dati e datastore
  • Impostazione, recupero e test delle autorizzazioni IAM

Nomi delle risorse

Il nome di una risorsa è costituito almeno da un ID progetto e da una località. Può essere esteso in modo da includere un set di dati, un datastore e qualsiasi risorsa figlio di un datastore.

Il formato del nome di una risorsa per un datastore che si trova all'interno di un set di dati dell'API Cloud Healthcare è simile al seguente:

/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/DATA_STORE_TYPE/DATA_STORE_ID

Ad esempio, il nome della risorsa per un archivio HL7v2 chiamato clinical-store1 ha il seguente aspetto:

/projects/my-project/locations/us-central1/datasets/my-dataset/hl7V2Stores/clinical-store1

Questo nome risorsa mostra un progetto denominato my-project nella regione us-central1. Il progetto contiene un set di dati denominato my-dataset e il set di dati contiene un archivio HL7v2 denominato clinical-store1.

Le operazioni su località, set di dati, datastore o risorse figlio di un datastore richiedono tutte che venga fornito un nome risorsa nel percorso REST o nella richiesta gRPC.

Percorsi della modalità per operazioni specifiche della modalità

Le operazioni che accedono ai dati in un datastore specifico della modalità utilizzano un percorso di richiesta costituito da due parti: il nome della risorsa (per identificare il datastore al quale accedere) e un percorso della modalità (per identificare i dati effettivi da recuperare).

Percorsi della modalità per le risorse FHIR

Ad esempio, il percorso di richiesta completo per leggere una specifica risorsa FHIR Patient utilizzando l'ID del paziente potrebbe avere il seguente aspetto:

RESOURCE_NAME/resources/Patient/PATIENT_ID

dove /Patient/PATIENT_ID è il percorso della modalità (strutturato secondo lo standard FHIR) per la risorsa Patient il cui identificatore è specificato da PATIENT_ID.

Percorsi della modalità DICOMweb

Le richieste DICOMweb per recuperare tutti gli studi per un determinato paziente potrebbero avere questo aspetto:

RESOURCE_NAME/dicomWeb/studies?PatientName=PATIENT_NAME

L'esempio seguente mostra l'aspetto di una richiesta per recuperare tutte le istanze in una serie e in uno studio specifici:

RESOURCE_NAME/dicomWeb/studies/STUDY_UID/series/SERIES_UID/instances

Una richiesta per recuperare un'istanza avrebbe il seguente aspetto:

RESOURCE_NAME/dicomWeb/studies/STUDY_UID/series/SERIES_UID/instances/INSTANCE_UID

In tutti questi esempi, la specifica del percorso della modalità è coerente con la struttura dei percorsi per lo standard DICOMweb.