Estructura de la API

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

Información general

Para consultar y gestionar los datos sanitarios de los conjuntos de datos y almacenes de datos, se puede usar una API REST que identifica cada almacén de datos mediante:

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

Para acceder a los datos, la API implementa estándares de acceso de modalidades específicas que cumplen con los estándares del sector para esa modalidad.

Operaciones administrativas

Las operaciones administrativas disponibles para los conjuntos de datos y para todos los almacenes de datos abarcan principalmente la creación, la lectura, la actualización y la eliminación (CRUD) de conjuntos de datos y almacenes de datos. Las operaciones administrativas son compatibles con la mayoría de las APIs deGoogle Cloud (Google Cloud) y no exigen el cumplimiento de estándares de modalidades concretos.

Aquí tienes algunos ejemplos de operaciones administrativas:

  • Crear, eliminar, obtener, mostrar y aplicar parches a conjuntos de datos y almacenes de datos.
  • Configurar, obtener y probar permisos de IAM.

Nombres de recursos

El nombre de recurso está formado, como mínimo, por un ID de proyecto y una ubicación. pero también puede incluir un conjunto de datos, un almacén de datos y recursos secundarios de un almacén de datos.

El nombre de recurso de un almacén de datos que reside en un conjunto de datos de la API Cloud Healthcare tiene un formato como este:

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

Por ejemplo, el nombre de recurso de un almacén HL7v2 llamado clinical-store1 tiene este formato:

/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 denominado my-dataset, el cual contiene un almacén HL7v2 llamado clinical-store1.

Es necesario proporcionar un nombre de recurso para todas las operaciones en una ubicación, un conjunto de datos, un almacén de datos o cualquier recurso secundario de un almacén de datos, ya sea en la ruta de REST o en la solicitud gRPC.

Rutas de modalidad para las operaciones de modalidades específicas

Las operaciones que acceden a los datos en un almacén de datos de una modalidad específica usan una ruta de solicitud compuesta por dos partes: el nombre de recurso (para identificar el almacén de datos al que se va a acceder) y una ruta de modalidad (para identificar los datos reales que se van a mostrar).

Rutas de modalidad de los recursos FHIR

Por ejemplo, la ruta de solicitud completa para leer un recurso Patient determinado de FHIR mediante el ID del paciente puede tener este aspecto:

RESOURCE_NAME/resources/Patient/PATIENT_ID

/Patient/PATIENT_ID es la ruta de modalidad (estructurada según el estándar FHIR) del recurso Patient cuyo identificador se especifica en PATIENT_ID.

Rutas de modalidad de DICOMweb

Las solicitudes de DICOMweb utilizadas para ver todos los estudios de un paciente determinado tienen este aspecto:

RESOURCE_NAME/dicomWeb/studies?PatientName=PATIENT_NAME

Aquí tienes otro ejemplo de una solicitud utilizada para ver todas las instancias de una serie y un estudio determinados:

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

Este sería el aspecto de una solicitud utilizada para ver una instancia:

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

En todos estos ejemplos, la especificación de la ruta de modalidad coincide con la estructura de la ruta del estándar DICOMweb.