Esta página descreve a estrutura dos caminhos e das operações da Cloud Healthcare API e como podem ser usados para aceder e gerir dados.
Vista geral
Os dados de cuidados de saúde em conjuntos de dados e repositórios de dados podem ser acedidos e geridos através de uma API REST que identifica cada repositório de dados através do seguinte:
- Um Google Cloud projeto
- Uma Google Cloud localização
- O ID do conjunto de dados
- O tipo de armazenamento de dados
- O ID do armazenamento de dados
A API também implementa normas específicas da modalidade para acesso que são consistentes com as normas da indústria para essa modalidade.
Operações administrativas
As operações administrativas estão disponíveis para conjuntos de dados e todos os repositórios de dados. Consistem principalmente em criar, ler, atualizar e eliminar (CRUD) conjuntos de dados e armazenamentos de dados. As operações administrativas são consistentes com a maioria das APIs Google Cloud (Google Cloud) e não requerem nenhuma conformidade com normas de modalidade específicas.
Exemplos de operações administrativas:
- Criar, eliminar, obter, listar e aplicar patches a conjuntos de dados e repositórios de dados
- Definir, obter e testar autorizações de IAM
Nomes de recursos
Um nome de recurso consiste, no mínimo, num ID do projeto e numa localização. Pode estender-se para incluir um conjunto de dados, um repositório de dados e qualquer um dos recursos subordinados de um repositório de dados.
O formato de um nome de recurso para um repositório de dados que reside num conjunto de dados da API Cloud Healthcare tem o seguinte aspeto:
/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/DATA_STORE_TYPE/DATA_STORE_ID
Por exemplo, o nome do recurso para um armazenamento HL7v2 denominado clinical-store1 tem o seguinte aspeto:
/projects/my-project/locations/us-central1/datasets/my-dataset/hl7V2Stores/clinical-store1
Este nome de recurso mostra um projeto denominado my-project na região us-central1. O projeto contém um conjunto de dados denominado my-dataset e
o conjunto de dados contém um armazenamento de HL7v2 denominado clinical-store1.
As operações numa localização, num conjunto de dados, num armazenamento de dados ou em qualquer um dos recursos subordinados de um armazenamento de dados requerem que seja fornecido um nome de recurso no caminho REST ou no pedido gRPC.
Caminhos de modalidade para operações específicas da modalidade
As operações que acedem aos dados num arquivo de dados específico da modalidade usam um caminho de pedido que consiste em duas partes: o nome do recurso (para identificar o arquivo de dados ao qual aceder) e um caminho de modalidade (para identificar os dados reais a obter).
Caminhos de modalidade de recursos FHIR
Por exemplo, o caminho do pedido completo para ler um recurso FHIR Patient específico usando o ID do paciente pode ter o seguinte aspeto:
RESOURCE_NAME/resources/Patient/PATIENT_ID
com /Patient/PATIENT_ID a ser o caminho da modalidade (estruturado de acordo com a norma FHIR) para o recurso Patient cujo identificador é especificado por PATIENT_ID.
Caminhos de modalidades DICOMweb
Os pedidos DICOMweb para obter todos os estudos de um determinado paciente seriam semelhantes ao seguinte:
RESOURCE_NAME/dicomWeb/studies?PatientName=PATIENT_NAME
Como outro exemplo, um pedido para obter todas as instâncias num determinado estudo e série teria o seguinte aspeto:
RESOURCE_NAME/dicomWeb/studies/STUDY_UID/series/SERIES_UID/instances
Um pedido para obter uma instância teria o seguinte aspeto:
RESOURCE_NAME/dicomWeb/studies/STUDY_UID/series/SERIES_UID/instances/INSTANCE_UID
Em todos estes exemplos, a especificação do caminho de modalidade é consistente com a estrutura do caminho padrão DICOMweb.