Estructura de la API

En esta página, se describe la estructura de las rutas y operaciones de la API de Cloud Healthcare y cómo se pueden usar para acceder y administrar los datos.

Resumen

Se puede acceder a los datos de atención médica en conjuntos de datos y almacenes de datos mediante una API de REST que identifica cada almacén de datos mediante:

  • Un proyecto de Google Cloud
  • Una ubicación de Google Cloud
  • El ID del conjunto de datos
  • El tipo de almacén de datos
  • El ID del almacén de datos

La API también implementa estándares específicos de modalidad para el acceso que son coherentes con los estándares de la industria para esa modalidad.

Operaciones administrativas

Las operaciones administrativas están disponibles para los conjuntos de datos y todos los almacenes de datos. En esencia, consisten en crear, leer, actualizar y borrar (CRUD) conjuntos de datos y almacenes de datos. Las operaciones administrativas son coherentes con la mayoría de las API de Google Cloud (Google Cloud) y no requieren ningún cumplimiento de estándares de modalidad específica.

Estos son algunos ejemplos de operaciones administrativas:

  • Crear, borrar, obtener, enumerar y aplicar parches a los conjuntos de datos y almacenes de datos
  • Configurar, obtener y probar permisos de IAM

Nombres de recursos

Un nombre de recurso consiste, como mínimo, en un ID del proyecto y una ubicación. Se puede extender para incluir un conjunto de datos, un almacén de datos y cualquiera de los recursos secundarios de un almacén de datos.

El formato de un nombre de recurso para un almacén de datos que reside dentro de un conjunto de datos de la API de Cloud Healthcare se ve así:

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

Por ejemplo, el nombre del recurso para un almacén de HL7v2 llamado clinical-store1 se ve así:

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

Este nombre de recurso muestra un proyecto llamado my-project en la región us-central1. El proyecto contiene un conjunto de datos llamado my-dataset y el conjunto de datos contiene un almacén de HL7v2 llamado clinical-store1.

Las operaciones en una ubicación, conjunto de datos, almacén de datos o cualquiera de los recursos secundarios del almacén de datos requieren que se proporcione un nombre de recurso en la ruta de REST o en la solicitud de gRPC.

Rutas de acceso de modalidad para operaciones específicas de la modalidad

Las operaciones que acceden a los datos en un almacén de datos específicos de la modalidad usan una ruta de solicitud que consta de dos partes: el nombre del recurso (para identificar el almacén de datos al que se accede) y una ruta de la modalidad (para identificar los datos reales que se recuperarán).

Rutas de acceso de la modalidad de FHIR

Por ejemplo, la ruta de acceso de solicitud completa para leer un recurso específico del paciente de FHIR mediante el ID del paciente podría verse de la siguiente manera:

RESOURCE_NAME/resources/Patient/PATIENT_ID

con /Patient/PATIENT_ID como la ruta de la modalidad (estructurada según el estándar de FHIR) para el recurso Paciente cuyo identificador especifica PATIENT_ID.

Rutas de acceso de modalidad DICOMweb

Las solicitudes de DICOMweb para recuperar todos los estudios de un paciente determinado se vería de la siguiente manera:

RESOURCE_NAME/dicomWeb/studies?PatientName=PATIENT_NAME

Como otro ejemplo, una solicitud para recuperar todas las instancias de un estudio y una serie determinados se vería así:

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

Una solicitud para recuperar una instancia se vería de la siguiente manera:

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

En todos estos ejemplos, la especificación de la ruta de la modalidad es coherente con la estructura de la ruta de acceso estándar de DICOMweb.