Esta página foi traduzida pela API Cloud Translation.
Switch to English

Estrutura da API

Nesta página, descrevemos a estrutura dos caminhos e operações da API Cloud Healthcare e como eles podem ser usados para acessar e gerenciar dados.

Visão geral

Os dados de saúde em conjuntos de dados e armazenamentos de dados podem ser acessados e gerenciados usando uma API REST que identifica cada armazenamento de dados usando:

  • um projeto do Google Cloud;
  • um local do Google Cloud;
  • o ID do conjunto de dados;
  • o tipo de armazenamento de dados;
  • o ID do armazenamento de dados.

A API também implementa padrões específicos da modalidade para acesso consistente com os padrões do setor para essa modalidade.

Operações administrativas

As operações administrativas estão disponíveis para conjuntos de dados e todos os armazenamentos de dados. Elas consistem principalmente em criar, ler, atualizar e excluir (CRUD, na sigla em inglês) conjuntos de dados e armazenamentos de dados. As operações administrativas são consistentes com a maioria das APIs do Google Cloud (Google Cloud) e não exigem a adesão a padrões de modalidades específicos.

Alguns exemplos de operações administrativas são:

  • Criar, excluir, receber, listar e corrigir conjuntos de dados e armazenamentos de dados
  • Definir, receber e testar permissões do IAM

Nomes de recurso

Um nome de recurso consiste em, no mínimo, um ID do projeto e um local. Ele pode ser estendido para incluir um conjunto de dados, um armazenamento de dados e qualquer um dos recursos filho de um armazenamento de dados.

O formato de um nome de recurso de um armazenamento de dados localizado em um conjunto de dados da API Cloud Healthcare tem esta aparência:

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

Por exemplo, o nome do recurso de um armazenamento HL7v2 chamado clinical-store1 parece com este:

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

Esse nome de recurso mostra um projeto chamado my-project na região us-central1. O projeto contém um conjunto de dados chamado my-dataset e o conjunto de dados contém um armazenamento HL7v2 chamado clinical-store1.

Operações em um local, conjunto de dados, armazenamento de dados ou qualquer um dos recursos filho de um armazenamento de dados exigem que um nome de recurso seja fornecido no caminho REST ou na solicitação gRPC.

Caminhos de modalidade para operações específicas da modalidade

As operações que acessam dados em um armazenamento de dados específico de modalidade usam um caminho de solicitação que consiste em duas partes: o nome do recurso (para identificar o armazenamento de dados a ser acessado) e um caminho de modalidade (para identificar os dados reais a serem recuperados).

Caminhos da modalidade do recurso FHIR

Por exemplo, o caminho completo da solicitação para a leitura de um recurso de paciente FHIR específico usando o ID do paciente pode ter a seguinte aparência:

RESOURCE_NAME/resources/Patient/PATIENT_ID

/Patient/PATIENT_ID é o caminho modalidade (estruturado de acordo com o padrão FHIR) para o recurso de paciente com identificador especificado por PATIENT_ID.

Caminhos da modalidade DICOMweb

As solicitações DICOMweb para recuperar todos os estudos de um determinado paciente seriam assim:

RESOURCE_NAME/dicomWeb/studies?PatientName=PATIENT_NAME

Em outro exemplo, uma solicitação para recuperar todas as instâncias em um determinado estudo e série teria esta aparência:

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

Uma solicitação para recuperar uma instância ficaria assim:

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

Em todos esses exemplos, a especificação do caminho da modalidade é consistente com a estrutura de caminho padrão do DICOMweb.