API-Struktur

Auf dieser Seite wird die Struktur der Cloud Healthcare API-Pfade und -Vorgänge erläutert. Außerdem wird beschrieben, wie sie zum Abrufen und Verwalten von Daten verwendet werden können.

Überblick

Gesundheitsdaten in Datasets und Datenspeichern können über eine REST API aufgerufen und verwaltet werden, die jeden Datenspeicher anhand folgender Date identifiziert:

  • Ein Google Cloud-Projekt
  • Ein Google Cloud-Standort
  • Die Dataset-ID
  • Der Datenspeichertyp
  • Die Datenspeicher-ID

Die API implementiert außerdem modalitätsspezifische Standards für den Zugriff, die den Branchenstandards für die jeweilige Modalität entsprechen.

Verwaltungsvorgänge

Verwaltungsvorgänge stehen für Datasets und alle Datenspeicher zur Verfügung. Hauptsächlich beinhalten sie das Erstellen, Lesen, Aktualisieren und Löschen von Datasets und Datenspeichern. Die Verwaltungsvorgänge sind bei den meisten Google Cloud APIs (Google Cloud) einheitlich und erfordern keine Einhaltung bestimmter Modalitätsstandards.

Beispiele für Verwaltungsvorgänge:

  • Erstellen, Löschen, Abrufen, Auflisten und Patchen von Datasets und Datenspeichern
  • Festlegen, Abrufen und Testen von IAM-Berechtigungen

Ressourcennamen

Ein Ressourcenname besteht mindestens aus einer Projekt-ID und einem Standort. Außerdem kann er ein Dataset, einen Datenspeicher und alle untergeordneten Ressourcen eines Datenspeichers umfassen.

Das Format eines Ressourcennamens für einen Datenspeicher, der sich in einem Cloud Healthcare API-Dataset befindet, sieht so aus:

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

Der Ressourcenname für einen HL7v2-Speicher namens clinical-store1 sieht beispielsweise so aus:

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

Dieser Ressourcenname zeigt ein Projekt namens my-project in der Region us-central1 an. Das Projekt enthält ein Dataset namens my-dataset und das Dataset enthält einen HL7v2-Speicher namens clinical-store1.

Für Änderungen eines Standorts, eines Datasets, eines Datenspeichers oder einer der untergeordneten Ressourcen eines Datenspeichers muss ein Ressourcenname im REST-Pfad oder in der gRPC-Anfrage angegeben werden.

Modalitätspfade für modalitätsspezifische Vorgänge

Vorgänge, die auf Daten in einem modalitätsspezifischen Datenspeicher zugreifen, verwenden einen Anfragepfad, der aus zwei Teilen besteht: dem Ressourcennamen (zum Identifizieren des Datenspeichers, auf den zugegriffen werden soll) und einem Modalitätspfad (zum Identifizieren der tatsächlichen Daten, die abgerufen werden sollen).

Modalitätspfade für FHIR-Ressourcen

Der vollständige Anfragepfad zum Lesen einer bestimmten FHIR-Patientenressource mithilfe der Patienten-ID könnte z. B. so aussehen:

RESOURCE_NAME/resources/Patient/PATIENT_ID

Dabei ist /Patient/PATIENT_ID der Modalitätspfad (strukturiert gemäß FHIR-Standard) für die Patientenressource, deren Kennzeichnung durch PATIENT_ID angegeben wird.

Modalitätspfade für DICOMweb

DICOMweb-Anfragen zum Abrufen aller Studien für einen bestimmten Patienten würden so aussehen:

RESOURCE_NAME/dicomWeb/studies?PatientName=PATIENT_NAME

Eine Anfrage zum Abrufen aller Instanzen in einer bestimmten Studie und Serie würde so aussehen:

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

Eine Anfrage zum Abrufen einer Instanz würde so aussehen:

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

In allen diesen Beispielen entspricht die Angabe des Modalitätspfads der Pfadstruktur des DICOMweb-Standards.